diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/fitter.hpp | 14 | ||||
| -rw-r--r-- | core/num_diff.hpp | 2 | ||||
| -rw-r--r-- | core/opt_exception.hpp | 2 | ||||
| -rw-r--r-- | core/opt_traits.hpp | 4 | ||||
| -rw-r--r-- | core/optimizer.hpp | 6 |
5 files changed, 14 insertions, 14 deletions
diff --git a/core/fitter.hpp b/core/fitter.hpp index 2dff97b..119c930 100644 --- a/core/fitter.hpp +++ b/core/fitter.hpp @@ -26,7 +26,7 @@ namespace opt_utilities /**
- representing a single data point
+ \brief representing a single data point
\tparam Ty the type of y
\tparam Tx the type of x
*/
@@ -217,7 +217,7 @@ namespace opt_utilities };
/**
- virtual class representing a set of data
+ \brief virtual class representing a set of data
\tparam Ty type of y
\tparam Tx type of x
*/
@@ -302,7 +302,7 @@ namespace opt_utilities /**
- the information of a model parameter
+ \brief the information of a model parameter
\tparam Tp type of model param type
\tparam Tstr the type of string type used
*/
@@ -441,7 +441,7 @@ namespace opt_utilities /**
- virtual class representing a model
+ \brief virtual class representing a model
\tparam Ty the type of the returned value of the model
\tparam Tx the type of the self-var
\tparam Tp the type of the model param
@@ -910,7 +910,7 @@ namespace opt_utilities /**
- class to perform the model fitting
+ \brief class to perform the model fitting
\tparam Ty the type of the model return type
\tparam Tx the type of the model self-var
\tparam Tp the type of the model param
@@ -1477,7 +1477,7 @@ namespace opt_utilities /**
- virtual class representing a statistic
+ \brief virtual class representing a statistic
\tparam Ty the type of the model return type
\tparam Tx the type of the model self-var
\tparam Tp the type of the model param
@@ -1606,7 +1606,7 @@ namespace opt_utilities /**
- Used to modify the parameter, e.g., freezing, bind
+ \brief Used to modify the parameter, e.g., freezing, bind
\tparam Ty the type of the model return type
\tparam Tx the type of the model self-var
\tparam Tp the type of the model param
diff --git a/core/num_diff.hpp b/core/num_diff.hpp index a6d9659..d6db632 100644 --- a/core/num_diff.hpp +++ b/core/num_diff.hpp @@ -16,7 +16,7 @@ namespace opt_utilities { /** - differentiable function + \brief differentiable function \tparam rT the return type \tparam the parameter type */ diff --git a/core/opt_exception.hpp b/core/opt_exception.hpp index 4413da7..458ff87 100644 --- a/core/opt_exception.hpp +++ b/core/opt_exception.hpp @@ -9,7 +9,7 @@ namespace opt_utilities { /** - the root class of exception used in opt_utilities + \brief the root class of exception used in opt_utilities */ class opt_exception :public std::exception diff --git a/core/opt_traits.hpp b/core/opt_traits.hpp index 7c2638a..c660208 100644 --- a/core/opt_traits.hpp +++ b/core/opt_traits.hpp @@ -19,7 +19,7 @@ namespace opt_utilities } /** - Trait class, in which the types of elements in an array are defined + \brief Trait class, in which the types of elements in an array are defined \tparam the type of the array object */ template <typename T> @@ -34,7 +34,7 @@ namespace opt_utilities /** - The return type trait of some certain data types. + \brief The return type trait of some certain data types. */ template <typename T> class return_type_trait diff --git a/core/optimizer.hpp b/core/optimizer.hpp index 2381da0..6b146cf 100644 --- a/core/optimizer.hpp +++ b/core/optimizer.hpp @@ -33,7 +33,7 @@ namespace opt_utilities class opt_method; /** - Virtual class representing an object function. + \brief Virtual class representing an object function. \tparam rT the return type \tparam pT the self-varible type */ @@ -104,7 +104,7 @@ namespace opt_utilities /** - virtual class representing optimization methods + \brief virtual class representing optimization methods \tparam rT the return type \tparam pT the self-varible type */ @@ -234,7 +234,7 @@ namespace opt_utilities /** - The manager for performing the manager + \brief The manager for performing the manager \tparam rT the return type \tparam pT the self-varible type */ |