aboutsummaryrefslogtreecommitdiffstats
path: root/models
diff options
context:
space:
mode:
Diffstat (limited to 'models')
-rw-r--r--models/add_model.hpp7
-rw-r--r--models/beta1d.hpp7
-rw-r--r--models/beta2d.hpp7
-rw-r--r--models/beta2d2.hpp7
-rw-r--r--models/bl1d.hpp7
-rw-r--r--models/bpl1d.hpp7
-rw-r--r--models/bremss.hpp7
-rw-r--r--models/constant.hpp7
-rw-r--r--models/dbeta1d.hpp7
-rw-r--r--models/dbeta2d.hpp7
-rw-r--r--models/dbeta2d2.hpp7
-rw-r--r--models/dbeta2d3.hpp7
-rw-r--r--models/func_model.hpp8
-rw-r--r--models/gauss1d.hpp7
-rw-r--r--models/lin1d.hpp7
-rw-r--r--models/models.hpp7
-rw-r--r--models/mul_model.hpp6
-rw-r--r--models/nbeta1d.hpp7
-rw-r--r--models/nfw1d.hpp7
-rw-r--r--models/pl1d.hpp7
-rw-r--r--models/polar_ellipse.hpp12
-rw-r--r--models/poly1d.hpp7
-rw-r--r--models/pow_model.hpp8
-rw-r--r--models/strmodel1d.hpp7
-rw-r--r--models/vecn.hpp7
25 files changed, 179 insertions, 2 deletions
diff --git a/models/add_model.hpp b/models/add_model.hpp
index 1ac7dc1..1cc0f50 100644
--- a/models/add_model.hpp
+++ b/models/add_model.hpp
@@ -1,3 +1,10 @@
+/**
+ \file add_model.hpp
+ \brief proxy class representing the sum of two models
+ \author Junhua Gu
+ */
+
+
#ifndef ADD_MODEL_H_
#define ADD_MODEL_H_
#define OPT_HEADER
diff --git a/models/beta1d.hpp b/models/beta1d.hpp
index 283b539..bd5d292 100644
--- a/models/beta1d.hpp
+++ b/models/beta1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file beta1d.hpp
+ \brief 1d beta model
+ \author Junhua Gu
+ */
+
+
#ifndef BETA_MODEL_H_
#define BETA_MODEL_H_
#define OPT_HEADER
diff --git a/models/beta2d.hpp b/models/beta2d.hpp
index 6166fd3..6cb45a7 100644
--- a/models/beta2d.hpp
+++ b/models/beta2d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file beta2d.hpp
+ \brief 2d beta
+ \author Junhua Gu
+ */
+
+
#ifndef BETA_MODEL2d_H_
#define BETA_MODEL2d_H_
#define OPT_HEADER
diff --git a/models/beta2d2.hpp b/models/beta2d2.hpp
index f42fd5f..ca1d619 100644
--- a/models/beta2d2.hpp
+++ b/models/beta2d2.hpp
@@ -1,3 +1,10 @@
+/**
+ \file beta2d2.hpp
+ \brief 2d beta model
+ \author Junhua Gu
+ */
+
+
#ifndef BETA_MODEL2d2_H_
#define BETA_MODEL2d2_H_
#define OPT_HEADER
diff --git a/models/bl1d.hpp b/models/bl1d.hpp
index e6ae8c7..16e2607 100644
--- a/models/bl1d.hpp
+++ b/models/bl1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file bl1d.hpp
+ \brief 1d broken linear
+ \author Junhua Gu
+ */
+
+
#ifndef BROKEN_LINE_MODEL_H_
#define BROKEN_LINE_MODEL_H_
#define OPT_HEADER
diff --git a/models/bpl1d.hpp b/models/bpl1d.hpp
index e531483..9d36885 100644
--- a/models/bpl1d.hpp
+++ b/models/bpl1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file bpl1d.hpp
+ \brief broken powerlaw
+ \author Junhua Gu
+ */
+
+
#ifndef BROKEN_POWER_LAW_MODEL_H_
#define BROKEN_POWER_LAW_MODEL_H_
#define OPT_HEADER
diff --git a/models/bremss.hpp b/models/bremss.hpp
index b516d5b..25e4cdd 100644
--- a/models/bremss.hpp
+++ b/models/bremss.hpp
@@ -1,3 +1,10 @@
+/**
+ \file bremss.hpp
+ \brief bremss emission
+ \author Junhua Gu
+ */
+
+
#ifndef BREMSS_MODEL_H_
#define BREMSS_MODEL_H_
#define OPT_HEADER
diff --git a/models/constant.hpp b/models/constant.hpp
index 601df61..662a380 100644
--- a/models/constant.hpp
+++ b/models/constant.hpp
@@ -1,3 +1,10 @@
+/**
+ \file constant.hpp
+ \brief constant model
+ \author Junhua Gu
+ */
+
+
#ifndef CONSTANT_MODEL_H_
#define CONSTANT_MODEL_H_
#define OPT_HEADER
diff --git a/models/dbeta1d.hpp b/models/dbeta1d.hpp
index 17e31e2..3a618c1 100644
--- a/models/dbeta1d.hpp
+++ b/models/dbeta1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file dbeta1d.hpp
+ \brief double beta model
+ \author Junhua Gu
+ */
+
+
#ifndef DBETA_MODEL_H_
#define DBETA_MODEL_H_
#define OPT_HEADER
diff --git a/models/dbeta2d.hpp b/models/dbeta2d.hpp
index 9529327..95e5e54 100644
--- a/models/dbeta2d.hpp
+++ b/models/dbeta2d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file dbeta2d.hpp
+ \brief 2d double beta model
+ \author Junhua Gu
+ */
+
+
#ifndef DBETA_MODEL2d_H_
#define DBETA_MODEL2d_H_
#define OPT_HEADER
diff --git a/models/dbeta2d2.hpp b/models/dbeta2d2.hpp
index 13e4143..5106f35 100644
--- a/models/dbeta2d2.hpp
+++ b/models/dbeta2d2.hpp
@@ -1,3 +1,10 @@
+/**
+ \file dbeta2de.hpp
+ \brief 2d double beta model
+ \author Junhua Gu
+ */
+
+
#ifndef DDBETA_OOOMODEL2d2_H_
#define DDBETA_OOOMODEL2d2_H_
#define OPT_HEADER
diff --git a/models/dbeta2d3.hpp b/models/dbeta2d3.hpp
index 560304e..f8bebab 100644
--- a/models/dbeta2d3.hpp
+++ b/models/dbeta2d3.hpp
@@ -1,3 +1,10 @@
+/**
+ \file dbeta2d3.hpp
+ \brief 2d double beta model
+ \author Junhua Gu
+ */
+
+
#ifndef DDBETA3_MODEL2d2_H_
#define DDBETA3_MODEL2d2_H_
#define OPT_HEADER
diff --git a/models/func_model.hpp b/models/func_model.hpp
index bed5cb6..c1fdc67 100644
--- a/models/func_model.hpp
+++ b/models/func_model.hpp
@@ -1,3 +1,11 @@
+/**
+ \file func_model.hpp
+ \brief model wrapper of raw function
+ \author Junhua Gu
+ */
+
+
+
#ifndef FUNC_MODEL_H_
#define FUNC_MODEL_H_
#define OPT_HEADER
diff --git a/models/gauss1d.hpp b/models/gauss1d.hpp
index 8de89a5..80247b7 100644
--- a/models/gauss1d.hpp
+++ b/models/gauss1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file guss1d.hpp
+ \brief gauss model
+ \author Junhua Gu
+ */
+
+
#ifndef GAUSS_MODEL_H_
#define GAUSS_MODEL_H_
#define OPT_HEADER
diff --git a/models/lin1d.hpp b/models/lin1d.hpp
index 8dc3121..a3359ce 100644
--- a/models/lin1d.hpp
+++ b/models/lin1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file lin1d.hpp
+ \brief 1d linear model
+ \author Junhua Gu
+ */
+
+
#ifndef LINEAR_MODEL_H_
#define LINEAR_MODEL_H_
#define OPT_HEADER
diff --git a/models/models.hpp b/models/models.hpp
index 3b78fc2..b3bf762 100644
--- a/models/models.hpp
+++ b/models/models.hpp
@@ -1,3 +1,10 @@
+/**
+ \file models.hpp
+ \brief implement of the prototype pattern to get models from string keywords
+ \author Junhua Gu
+ */
+
+
#ifndef MODELS_HPP
#define MODELS_HPP
#define OPT_HEADER
diff --git a/models/mul_model.hpp b/models/mul_model.hpp
index 9c9da8e..463f39a 100644
--- a/models/mul_model.hpp
+++ b/models/mul_model.hpp
@@ -1,3 +1,9 @@
+/**
+ \file mul_model.hpp
+ \brief the multiply of two models
+ \author Junhua Gu
+ */
+
#ifndef MUL_MODEL_HPP
#define MUL_MODEL_HPP
#define OPT_HEADER
diff --git a/models/nbeta1d.hpp b/models/nbeta1d.hpp
index 613de95..e82f673 100644
--- a/models/nbeta1d.hpp
+++ b/models/nbeta1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file nbeta1d
+ \brief 1d density beta model
+ \author Junhua Gu
+ */
+
+
#ifndef NBETA_MODEL_H_
#define NBETA_MODEL_H_
#define OPT_HEADER
diff --git a/models/nfw1d.hpp b/models/nfw1d.hpp
index 177363f..3c4b181 100644
--- a/models/nfw1d.hpp
+++ b/models/nfw1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file nfw1d.hpp
+ \brief 1d nfw model
+ \author Junhua Gu
+ */
+
+
#ifndef NFW_MODEL_H_
#define NFW_MODEL_H_
#define OPT_HEADER
diff --git a/models/pl1d.hpp b/models/pl1d.hpp
index 598ff1c..e22b7f0 100644
--- a/models/pl1d.hpp
+++ b/models/pl1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file pl1d.hpp
+ \brief 1d power law
+ \author Junhua Gu
+ */
+
+
#ifndef POWER_LAW_MODEL_H_
#define POWER_LAW_MODEL_H_
#define OPT_HEADER
diff --git a/models/polar_ellipse.hpp b/models/polar_ellipse.hpp
index 2285a76..4db2fa8 100644
--- a/models/polar_ellipse.hpp
+++ b/models/polar_ellipse.hpp
@@ -1,3 +1,11 @@
+/**
+ \file polar_ellipse.hpp
+ \brief defing ellipse in polar coordinate
+ \author Junhua Gu
+ */
+
+
+
#ifndef PELLIPSE_MODEL_H_
#define PELLIPSE_MODEL_H_
#define OPT_HEADER
@@ -42,8 +50,8 @@ namespace opt_utilities
private:
std::string do_get_information()const
{
- return "linear model\n"
- "y=k*x+b\n";
+ return "polar elliptical\n"
+ //"y=k*x+b\n";
}
};
}
diff --git a/models/poly1d.hpp b/models/poly1d.hpp
index 20a6ae5..94ab3b8 100644
--- a/models/poly1d.hpp
+++ b/models/poly1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file poly1d.hpp
+ \brief 1d polynomial
+ \author Junhua Gu
+ */
+
+
#ifndef POLY_MODEL_H_
#define POLY_MODEL_H_
#define OPT_HEADER
diff --git a/models/pow_model.hpp b/models/pow_model.hpp
index 2e3b18d..43b93b7 100644
--- a/models/pow_model.hpp
+++ b/models/pow_model.hpp
@@ -1,3 +1,11 @@
+/**
+ \file pow_model.hpp
+ \brief combing two model by power operation
+ \author Junhua Gu
+ */
+
+
+
#ifndef POW_MODEL_H_
#define POW_MODEL_H_
#define OPT_HEADER
diff --git a/models/strmodel1d.hpp b/models/strmodel1d.hpp
index 650f588..5342210 100644
--- a/models/strmodel1d.hpp
+++ b/models/strmodel1d.hpp
@@ -1,3 +1,10 @@
+/**
+ \file strmodel1d.hpp
+ \brief evaluating model from string, by usig muparser
+ \author Junhua Gu
+ */
+
+
#ifndef STRMODEL1D_HPP
#define STRMODEL1D_HPP
#define OPT_HEADER
diff --git a/models/vecn.hpp b/models/vecn.hpp
index b37ff11..4dc96eb 100644
--- a/models/vecn.hpp
+++ b/models/vecn.hpp
@@ -1,3 +1,10 @@
+/**
+ \file vecn.hpp
+ \brief n-dim fixed size vector
+ \author Junhua Gu
+ */
+
+
#ifndef VECN_HPP
#define VECN_HPP
#define OPT_HEADER