diff options
-rw-r--r-- | data_sets/default_data_set.hpp | 9 | ||||
-rw-r--r-- | data_sets/sorted_data_set.hpp | 10 | ||||
-rw-r--r-- | methods/aga/aga.hpp | 13 | ||||
-rw-r--r-- | statistics/chisq.hpp | 13 | ||||
-rw-r--r-- | statistics/cstat.hpp | 13 | ||||
-rw-r--r-- | statistics/leastsq.hpp | 13 |
6 files changed, 71 insertions, 0 deletions
diff --git a/data_sets/default_data_set.hpp b/data_sets/default_data_set.hpp index 4d0b89e..7d63fb9 100644 --- a/data_sets/default_data_set.hpp +++ b/data_sets/default_data_set.hpp @@ -1,3 +1,7 @@ +/** + \file default_data_set.hpp + */ + #ifndef DEFAULT_DATA_SET #define DEFAULT_DATA_SET #include "core/fitter.hpp" @@ -7,6 +11,11 @@ namespace opt_utilities { + /** + default implement of the data set + \tparam Ty type of y + \tparam Tx type of x + */ template <typename Ty,typename Tx> class default_data_set :public data_set<Ty,Tx> diff --git a/data_sets/sorted_data_set.hpp b/data_sets/sorted_data_set.hpp index 0512f18..868f293 100644 --- a/data_sets/sorted_data_set.hpp +++ b/data_sets/sorted_data_set.hpp @@ -1,3 +1,7 @@ +/** + \file sorted_data_set.hpp +*/ + #ifndef SORTED_DATA_SET #define SORTED_DATA_SET #include "core/fitter.hpp" @@ -14,6 +18,12 @@ namespace opt_utilities } + + /** + automatically sorting data set + \tparam Ty type of y + \tparam Tx type of x + */ template <typename Ty,typename Tx> class sorted_data_set :public data_set<Ty,Tx> diff --git a/methods/aga/aga.hpp b/methods/aga/aga.hpp index f5edff3..81c53df 100644 --- a/methods/aga/aga.hpp +++ b/methods/aga/aga.hpp @@ -1,3 +1,8 @@ +/** + \file aga.hpp + asexual genetic algorithm method +*/ + #ifndef AGA_METHOD #define AGA_METHOD #include <core/optimizer.hpp> @@ -37,6 +42,14 @@ namespace opt_utilities } }; + + /** + Implement of the asexual genetic algorithm + 2009A&A...501.1259C + http://adsabs.harvard.edu/abs/2009arXiv0905.3712C + \tparam rT return type of the object function + \tparam pT parameter type of the object function + */ template <typename rT,typename pT> class aga_method :public opt_method<rT,pT> diff --git a/statistics/chisq.hpp b/statistics/chisq.hpp index 5f28d86..7c38b4e 100644 --- a/statistics/chisq.hpp +++ b/statistics/chisq.hpp @@ -1,3 +1,7 @@ +/**
+ \file chisq.hpp
+ */
+
#ifndef CHI_SQ_HPP
#define CHI_SQ_HPP
#include <core/fitter.hpp>
@@ -8,6 +12,15 @@ using std::cerr;using std::endl; namespace opt_utilities
{
+
+ /**
+ chi-square statistic
+ \tparam Ty the return type of model
+ \tparam Tx the type of the self-var
+ \tparam Tp the type of model parameter
+ \tparam Ts the type of the statistic
+ \tparam Tstr the type of the string used
+ */
template<typename Ty,typename Tx,typename Tp,typename Ts,typename Tstr>
class chisq
:public statistic<Ty,Tx,Tp,Ts,Tstr>
diff --git a/statistics/cstat.hpp b/statistics/cstat.hpp index 058523d..45e2920 100644 --- a/statistics/cstat.hpp +++ b/statistics/cstat.hpp @@ -1,3 +1,7 @@ +/**
+ \file cstat.hpp
+ */
+
#ifndef CSTAT_HPP
#define CSTAT_HPP
#include <core/fitter.hpp>
@@ -6,6 +10,15 @@ using std::cout;using std::endl;
namespace opt_utilities
{
+
+ /**
+ c-statistic, max-likelihood method
+ \tparam Ty the return type of model
+ \tparam Tx the type of the self-var
+ \tparam Tp the type of model parameter
+ \tparam Ts the type of the statistic
+ \tparam Tstr the type of the string used
+ */
template<typename Ty,typename Tx,typename Tp,typename Ts,typename Tstr>
class cstat
:public statistic<Ty,Tx,Tp,Ts,Tstr>
diff --git a/statistics/leastsq.hpp b/statistics/leastsq.hpp index 48b753a..6ac0adc 100644 --- a/statistics/leastsq.hpp +++ b/statistics/leastsq.hpp @@ -1,3 +1,7 @@ +/**
+ \file leastsq.hpp
+ */
+
#ifndef LEAST_SQ_HPP
#define LeAST_SQ_HPP
#include <core/fitter.hpp>
@@ -8,6 +12,15 @@ using std::cerr;using std::endl; namespace opt_utilities
{
+
+ /**
+ least-square statistic
+ \tparam Ty the return type of model
+ \tparam Tx the type of the self-var
+ \tparam Tp the type of model parameter
+ \tparam Ts the type of the statistic
+ \tparam Tstr the type of the string used
+ */
template<typename Ty,typename Tx,typename Tp,typename Ts,typename Tstr>
class leastsq
:public statistic<Ty,Tx,Tp,Ts,Tstr>
|