[doc][doxygen] add sampling group

doc/doxygen/modules.txt

@@ -49,6 +49,11 @@
      * \brief Functionality related to magnitude (length/area/volume) computations of geometrical objects.
      */
 
+    /*!
+     * \defgroup Sampling Sampling
+     * \brief Functionality related to random generation (sampling) of geometries.
+     */
+
 /*!
  * \defgroup OpenCascade OpenCascade
  * \brief Utility functions for communication with the OpenCascade library.

frackit/sampling/boxpointsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class to randomly generate points on boxes.
  */
 #ifndef FRACKIT_BOX_POINT_SAMPLER_HH
@@ -30,6 +31,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Class to randomly generate points within boxes
  *        following the provided distributions. The type of
  *        distribution to be used can be specified via traits,

frackit/sampling/cylinderpointsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class to randomly generate points on cylinders.
  */
 #ifndef FRACKIT_CYLINDER_POINT_SAMPLER_HH
@@ -34,6 +35,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Class to randomly generate points within cylinders
  *        following the provided distributions. The type of
  *        distribution to be used can be specified via traits,

frackit/sampling/disksampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class to randomly generate disks in three-dimensional space.
  */
 #ifndef FRACKIT_DISK_SAMPLER_HH
@@ -39,6 +40,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Default traits class for the disk sampler.
  *        Uses uniform distributions for all parameters.
  */
@@ -65,6 +67,7 @@ struct DefaultDiskSamplerTraits
 };
 
 /*!
+ * \ingroup Sampling
  * \brief Sampler for disk geometries.
  *        The disks are generated by sampling from provided
  *        distributions for:

frackit/sampling/geometrysampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class that defines the interface for
  *        sampler classes of geometries.
  */
@@ -27,6 +28,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Interface for geometry sampler classes.
  *        Sampler class implemetations must implement
  *        the () operator, with which a random geometry

frackit/sampling/makepointsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Free functions to create point samplers from geometries.
  */
 #ifndef FRACKIT_MAKE_POINT_SAMPLER_HH
@@ -29,6 +30,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Overload of the free function to create point
  *        samplers for cylinders.
  * \note Sampling along the radius coordinate occurs in the interval [0, r^2]
@@ -47,6 +49,7 @@ makePointSampler(const Cylinder<ctype>& cylinder)
 }
 
 /*!
+ * \ingroup Sampling
  * \brief Overload of the free function to create point
  *        samplers for boxes.
  */

frackit/sampling/makeuniformpointsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Free functions to create point samplers from geometries with
  *        uniform distributions used for all coordinate directions.
  */
@@ -33,6 +34,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Overload of the free function to create point
  *        samplers, for the provided geometry, with uniform
  *        distributions for all coordinate directions.

frackit/sampling/multigeometrysampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Sampler which can sample multiple geometry types.
  *        For each geometry type, various sampler classes can be defined,
  *        each of which is associated with a unique id. The sampling strategy
@@ -43,6 +44,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Sampler which can sample multiple geometry types.
  * \note Per default, we use a sequential sampling strategy here.
  */

frackit/sampling/pointsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Interface for classes that randomly generate points.
  */
 #ifndef FRACKIT_POINT_SAMPLER_HH
@@ -26,6 +27,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Defines the interface for point samplers.
  * \tparam P The type used for points
  */

frackit/sampling/quadrilateralsampler.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class to randomly generate quadrilaterals in n-dimensional space.
  */
 #ifndef FRACKIT_QUADRILATERAL_SAMPLER_HH
@@ -45,6 +46,7 @@ template<class ctype, int worldDim>
 struct DefaultQuadrilateralSamplerTraits;
 
 /*!
+ * \ingroup Sampling
  * \brief Default traits class for sampling quadrilaterals in 3d space.
  *        Uses uniform distributions for all parameters.
  */
@@ -68,6 +70,7 @@ template< int worldDim,
 class QuadrilateralSampler;
 
 /*!
+ * \ingroup Sampling
  * \brief Sampler for quadrilaterals in 3d space.
  *        The quadrilaterals are generated by sampling from provided
  *        distributions for:

frackit/sampling/samplingstrategy.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Interface for sampling strategies, which can be used in conjunction
  *        with, for instance, instances of 'MultiGeometrySampler'. A strategy
  *        allows for defining a number of ids, and it provides the function
@@ -36,6 +37,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Interface for sampling strategies.
  */
 class SamplingStrategy

frackit/sampling/sequentialsamplingstrategy.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Sampling strategy implementation which goes
  *        over the defined ids successively.
  */
@@ -31,6 +32,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Sampling strategy implementation which goes
  *        over the defined ids successively.
  */

frackit/sampling/status.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Class that can be used to define target counters in
  *        sampling procedures and which outputs the current status.
  */
@@ -32,6 +33,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Class that can be used to define target counters in
  *        sampling procedures and which outputs the current status.
  */
@@ -41,7 +43,7 @@ class SamplingStatus
 public:
 
     /*!
-     * \brief TODO: Doc
+     * \brief Set the target sample count for a specific id.
      */
     void setTargetCount(const Id& id, std::size_t targetCount)
     {
@@ -53,7 +55,8 @@ public:
     }
 
     /*!
-     * \brief TODO: Doc
+     * \brief Returns true when the target
+     *        sample count is reached.
      */
     bool finished()
     {
@@ -64,7 +67,8 @@ public:
     }
 
     /*!
-     * \brief TODO: Doc
+     * \brief Returns true when the target count
+     *        for a specific id is reached.
      */
     bool finished(const Id& id)
     {
@@ -75,7 +79,7 @@ public:
     }
 
     /*!
-     * \brief TODO: Doc
+     * \brief Increase counter for a specific id.
      */
     void increaseCounter(const Id& id)
     {
@@ -83,7 +87,7 @@ public:
     }
 
     /*!
-     * \brief TODO: Doc
+     * \brief Increase counter of rejected samples.
      */
     void increaseRejectedCounter()
     {
@@ -91,7 +95,7 @@ public:
     }
 
     /*!
-     * \brief TODO: Doc
+     * \brief Print current status to terminal.
      */
     void print(bool forceHeaderPrint = false)
     {

frackit/sampling/uniformpointsamplertraits.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Sampling
  * \brief Traits classes to be used for uniform point samplers.
  */
 #ifndef FRACKIT_UNIFORM_POINT_SAMPLER_TRAITS_HH
@@ -28,6 +29,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup Sampling
  * \brief Traits class to be used for sampling on
  *        uniform distributions in all coordinate directions.
  * \tparam ctype The type used for coordinates
@@ -37,6 +39,7 @@ template<class ctype, int worldDim>
 struct UniformPointSamplerTraits;
 
 /*!
+ * \ingroup Sampling
  * \brief Traits class to be used for uniform sampling
  *         of points on 1-dimensional geometries.
  * \tparam ctype The type used for coordinates
@@ -48,6 +51,7 @@ struct UniformPointSamplerTraits<ctype, 1>
 };
 
 /*!
+ * \ingroup Sampling
  * \brief Traits class to be used for uniform sampling
  *         of points on 2-dimensional geometries.
  * \tparam ctype The type used for coordinates
@@ -60,6 +64,7 @@ struct UniformPointSamplerTraits<ctype, 2>
 };
 
 /*!
+ * \ingroup Sampling
  * \brief Traits class to be used for uniform sampling
  *         of points on 3-dimensional geometries.
  * \tparam ctype The type used for coordinates