aboutsummaryrefslogtreecommitdiffstats
path: root/statistics
diff options
context:
space:
mode:
Diffstat (limited to 'statistics')
-rw-r--r--statistics/chisq.hpp13
-rw-r--r--statistics/cstat.hpp13
-rw-r--r--statistics/leastsq.hpp13
3 files changed, 39 insertions, 0 deletions
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>