Commit 21404ddb authored by Jean-Baptiste Mouret's avatar Jean-Baptiste Mouret
Browse files

[docs] misc improvements

parent 8410d8d9
......@@ -13,10 +13,14 @@ namespace limbo {
};
}
namespace init {
///@ingroup init
///Grid sampling.
///
/// Parameter : ``int bins`` (number of bins)
/** @ingroup init
\rst
Grid sampling.
Parameter :
- ``int bins`` (number of bins)
\endrst
*/
template <typename Params>
struct GridSampling {
template <typename StateFunction, typename AggregatorFunction, typename Opt>
......
......@@ -16,8 +16,15 @@ namespace limbo {
};
}
namespace init {
///@ingroup init
///Grid-based random sampling
/** @ingroup init
Grid-based random sampling: for each bin, take k random samples until k = samples.
For instance, if bins = 5 and samples = 10, then put 2 random samples in each bin.
Parameters:
- `int samples`
- `int bins`
*/
template <typename Params>
struct RandomSamplingGrid {
template <typename StateFunction, typename AggregatorFunction, typename Opt>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment