Docs

Author: taehyounpark

docs/examples/iris.md

@@ -23,12 +23,12 @@ using VecI = Vec<int>;
 using VecF = Vec<float>;
 using VecD = Vec<double>;
 
-using dataflow = queryosity::dataflow;
-namespace multithread = queryosity::multithread;
-namespace dataset = queryosity::dataset;
-namespace column = queryosity::column;
-namespace query = queryosity::query;
-namespace systematic = queryosity::systematic;
+using dataflow = qty::dataflow;
+namespace multithread = qty::multithread;
+namespace dataset = qty::dataset;
+namespace column = qty::column;
+namespace query = qty::query;
+namespace systematic = qty::systematic;
 
 class DRMinMaxSel
     : public column::definition<VecI(VecF, VecF, VecF, VecF, VecF)> {

docs/examples/xaod.md

@@ -16,12 +16,12 @@ using VecD = ROOT::RVec<double>;
 
 #include "queryosity.h"
 
-using dataflow = queryosity::dataflow;
-namespace multithread = queryosity::multithread;
-namespace dataset = queryosity::dataset;
-namespace column = queryosity::column;
-namespace query = queryosity::query;
-namespace systematic = queryosity::systematic;
+using dataflow = qty::dataflow;
+namespace multithread = qty::multithread;
+namespace dataset = qty::dataset;
+namespace column = qty::column;
+namespace query = qty::query;
+namespace systematic = qty::systematic;
 
 #include "TCanvas.h"
 #include "TH1F.h"

docs/guide/dataflow.md

@@ -7,6 +7,7 @@ using dataflow = qty::dataflow;
 namespace multithread = qty::multithread;
 namespace dataset = qty::dataset;
 namespace column = qty::column;
+namespace selection = qty::selection;
 namespace query = qty::query;
 namespace systematic = qty::systematic;
 

docs/guide/datasets.md

@@ -13,7 +13,7 @@ auto col = ds.read(dataset::column<DTYPE>(NAME));
 
 ## Loading-in a dataset
 
-Call `queryosity::dataflow::load()` with an input dataset and its constructor arguments.
+Call `dataflow::load()` with an input dataset and its constructor arguments.
 
 ```cpp
 using json = qty::json;

docs/guide/queries.md

@@ -17,7 +17,7 @@ auto q = df.get(query::output<DEF>(ARGS...))
 
 ## Defining a query
 
-Call `queryosity::dataflow::get()` specifying the definition and constructor arguments of the query.
+Call `dataflow::get()` specifying the definition and constructor arguments of the query.
 
 ```{code} cpp
 using h1d = qty::hist::hist<double>;

docs/guide/variations.md

@@ -1,6 +1,6 @@
 # Systematic variations
 
-To specifying systematic variations on a column, provide the nominal argument and a mapping of variation name to alternate arguments to queryosity::dataflow::vary() instead of the usual queryosity::dataflow::define().
+To specifying systematic variations on a column, provide the nominal argument and a mapping of variation name to alternate arguments to `dataflow::vary()` instead of the usual `dataflow::define()`.
 
 ## Varying columns
 

include/queryosity/dataflow.h

@@ -237,22 +237,50 @@ class dataflow {
    */
   template <typename... Sels> auto get(selection::yield<Sels...> const &sels);
 
+  /**
+   * @brief Vary a column constant.
+   * @tparam Val Constant value type.
+   * @param[in] cnst Column constant.
+   * @param[in] vars Map of variation to value.
+   * @return Varied lazy column.
+   */
   template <typename Val>
   auto vary(column::constant<Val> const &cnst, std::map<std::string, Val> vars)
       -> varied<lazy<column::valued<Val>>>;
 
+  /**
+   * @brief Vary a column expression.
+   * @tparam Fn Expression function type.
+   * @param[in] expr Column expression.
+   * @param[in] vars Map of variation to expression.
+   * @return Varied todo column evaluator.
+   */
   template <typename Fn>
   auto
   vary(column::expression<Fn> const &expr,
        std::map<std::string,
                 typename column::expression<Fn>::function_type> const &vars)
       -> varied<todo<column::evaluator<column::equation_t<Fn>>>>;
 
+  /**
+   * @brief Vary a column definition.
+   * @tparam Def Definition type.
+   * @param[in] defn Column definition.
+   * @param[in] vars Map of variation to definition.
+   * @return Varied todo column evaluator.
+   */
   template <typename Def>
   auto vary(column::definition<Def> const &defn,
             std::map<std::string, column::definition<Def>> const &vars)
       -> varied<todo<column::evaluator<Def>>>;
 
+  /**
+   * @brief Vary a column.
+   * @tparam Col Column type.
+   * @param[in] nom Nominal lazy column.
+   * @param[in] vars Map of variation to lazy column.
+   * @return Varied lazy column.
+   */
   template <typename Col>
   auto vary(column::nominal<Col> const &nom,
             std::map<std::string, column::variation<column::value_t<Col>>> const