diff options
55 files changed, 355 insertions, 8 deletions
diff --git a/data_sets/default_data_set.hpp b/data_sets/default_data_set.hpp index d56f810..51e6b70 100644 --- a/data_sets/default_data_set.hpp +++ b/data_sets/default_data_set.hpp @@ -1,5 +1,6 @@ /** \file default_data_set.hpp + \brief default implement of data set \author Junhua Gu */ diff --git a/data_sets/shared_table_data_set.hpp b/data_sets/shared_table_data_set.hpp index cf71692..7a80a74 100644 --- a/data_sets/shared_table_data_set.hpp +++ b/data_sets/shared_table_data_set.hpp @@ -1,5 +1,6 @@ /** \file shared_table_data_set.hpp + \brief A data set with high copy efficiency \author Junhua Gu */ diff --git a/data_sets/sorted_data_set.hpp b/data_sets/sorted_data_set.hpp index fec4e20..abd90d5 100644 --- a/data_sets/sorted_data_set.hpp +++ b/data_sets/sorted_data_set.hpp @@ -1,5 +1,6 @@ /** \file sorted_data_set.hpp + \brief a data set with data sorted by x \author Junhua Gu */ diff --git a/distributions/component.hpp b/distributions/component.hpp index ae7981c..d761bf8 100644 --- a/distributions/component.hpp +++ b/distributions/component.hpp @@ -1,3 +1,10 @@ +/** + \file component.hpp + \brief rpresents a distribution composed of more than one components + \author Junhua Gu + */ + + #ifndef COMPONENT_MODEL_H_ #define COMPONENT_MODEL_H_ #define OPT_HEADER @@ -6,9 +13,7 @@ #include <misc/optvec.hpp> #include <sstream> #include <iostream> -/* - *Represents a distribution composed of more than one components - */ + namespace opt_utilities diff --git a/distributions/normed_dgauss1d.hpp b/distributions/normed_dgauss1d.hpp index 4060fa6..5405de8 100644 --- a/distributions/normed_dgauss1d.hpp +++ b/distributions/normed_dgauss1d.hpp @@ -1,3 +1,10 @@ +/** + \file normed_dgauss1d.hpp + \brief normalized double gaussian distribution + \author Junhua Gu + */ + + #ifndef NDGAUSS_MODEL_H_ #define NDGAUSS_MODEL_H_ #define OPT_HEADER diff --git a/distributions/normed_gauss1d.hpp b/distributions/normed_gauss1d.hpp index f8f3cb4..03a69cb 100644 --- a/distributions/normed_gauss1d.hpp +++ b/distributions/normed_gauss1d.hpp @@ -1,3 +1,10 @@ +/** + \file normed_gauss1d.hpp + \brief normalized guassian distribution + \author Junhua Gu + */ + + #ifndef NGAUSS_MODEL_H_ #define NGAUSS_MODEL_H_ #define OPT_HEADER diff --git a/distributions/uniformed.hpp b/distributions/uniformed.hpp index ccafd01..b40d079 100644 --- a/distributions/uniformed.hpp +++ b/distributions/uniformed.hpp @@ -1,3 +1,10 @@ +/** + \file uniformed.hpp + \brief uniformed distribution + \author Junhua Gu + */ + + #ifndef UNIFORMED_MODEL_H_ #define UNIFORMED_MODEL_H_ #define OPT_HEADER diff --git a/interface/optdl.hpp b/interface/optdl.hpp index 35b2f9b..1516770 100644 --- a/interface/optdl.hpp +++ b/interface/optdl.hpp @@ -1,3 +1,10 @@ +/** + \file optdl.hpp + \brief dynamically loadable modules + \author Junhua Gu + */ + + #ifndef OPTDL_HPP #define OPTDL_HPP #define OPT_HEADER diff --git a/interface/pyfunc_obj.hpp b/interface/pyfunc_obj.hpp index db2775a..3e75d34 100644 --- a/interface/pyfunc_obj.hpp +++ b/interface/pyfunc_obj.hpp @@ -1,3 +1,10 @@ +/** + \file pyfunc_obj.hpp + \brief function object wrappers for python functions + \author Junhua Gu + */ + + #ifndef PYFUNC_OBJ_HPP #define PYFUNC_OBJ_HPP #include <boost/python.hpp> diff --git a/interface/pymodel.hpp b/interface/pymodel.hpp index 8041a6b..729840c 100644 --- a/interface/pymodel.hpp +++ b/interface/pymodel.hpp @@ -1,3 +1,11 @@ +/** + \file pymodel.hpp + \brief model wrapper of python functions + \author Junhua Gu + */ + + + #ifndef PYMODEL #define PYMODEL #include <boost/python.hpp> diff --git a/interface/type_depository.hpp b/interface/type_depository.hpp index 7405bb5..6a53edc 100644 --- a/interface/type_depository.hpp +++ b/interface/type_depository.hpp @@ -1,9 +1,17 @@ +/** + \file type_depository.hpp + \brief depository and draw objects + \author Junhua Gu + */ + + + #ifndef TYPE_DEPOSITORY_HPP #define TYPE_DEPOSITORY_HPP #include <string> #include <utility> -#include "../core/optimizer.hpp" -#include "../core/fitter.hpp" +#include <core/optimizer.hpp> +#include <core/fitter.hpp> #include <map> #include <iostream> namespace opt_utilities diff --git a/math/num_diff.hpp b/math/num_diff.hpp index 6f07c27..bef9a1e 100644 --- a/math/num_diff.hpp +++ b/math/num_diff.hpp @@ -1,5 +1,7 @@ /** \file num_diff.hpp + \brief performing n-dim differential operation on func objects + \author Junhua Gu */ diff --git a/math/vector_operation.hpp b/math/vector_operation.hpp index a856847..1f7c025 100644 --- a/math/vector_operation.hpp +++ b/math/vector_operation.hpp @@ -1,3 +1,10 @@ +/** + \file vector_operation.hpp + \brief defing vector operators + \author Junhua Gu + */ + + #ifndef VECTOR_OPERATION_HPP #define VECTOR_OPERATION_HPP #include <core/opt_traits.hpp> diff --git a/methods/linmin/linmin.hpp b/methods/linmin/linmin.hpp index 9ec1dd8..ecfd0d6 100644 --- a/methods/linmin/linmin.hpp +++ b/methods/linmin/linmin.hpp @@ -1,3 +1,10 @@ +/** + \file linmin.hpp + \brief linear search + \author Junhua Gu + */ + + #ifndef LINMIN_HPP #define LINMIN_HPP #define OPT_HEADER diff --git a/methods/powell/powell_method.hpp b/methods/powell/powell_method.hpp index 294e101..837a0b0 100644 --- a/methods/powell/powell_method.hpp +++ b/methods/powell/powell_method.hpp @@ -1,5 +1,6 @@ /** \file powell_method.hpp + \brief powerll optimization method \author Junhua Gu */ diff --git a/misc/bootstrap.hpp b/misc/bootstrap.hpp index 88332ed..3c9feb4 100644 --- a/misc/bootstrap.hpp +++ b/misc/bootstrap.hpp @@ -1,5 +1,7 @@ /** \file bootstrap.hpp + \brief A simple implement of bootstrap method for error estimation + \autho Junhua Gu */ diff --git a/misc/data_loaders.hpp b/misc/data_loaders.hpp index ad23db6..7bbb757 100644 --- a/misc/data_loaders.hpp +++ b/misc/data_loaders.hpp @@ -1,6 +1,7 @@ /** \file data_loaders.hpp - a set of classes used to load data_set from std::istream + \brief a set of classes used to load data_set from std::istream + \author Junhua Gu */ #ifndef DATA_LOADERS_H diff --git a/misc/optvec.hpp b/misc/optvec.hpp index b259029..790a721 100644 --- a/misc/optvec.hpp +++ b/misc/optvec.hpp @@ -1,3 +1,11 @@ +/** + \file optvec + \brief A ready to use, but ad-hoc mathematical vector class + \author Junhua Gu + + */ + + #ifndef OPTVEC_HPP #define OPTVEC_HPP 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 diff --git a/utilities/opt_types.hpp b/utilities/opt_types.hpp index 604b62a..815afc9 100644 --- a/utilities/opt_types.hpp +++ b/utilities/opt_types.hpp @@ -1,3 +1,10 @@ +/** + \file opt_types + \brief define some usually used template + \author Junhua Gu + */ + + #ifndef OPT_TYPES_HPP #define OPT_TYPES_HPP #define OPT_HEADER diff --git a/vmodels/beta1d.hpp b/vmodels/beta1d.hpp index 42be3fd..8d4d714 100644 --- a/vmodels/beta1d.hpp +++ b/vmodels/beta1d.hpp @@ -1,3 +1,10 @@ +/** + \file beta1d.hpp + \brief 1d beta model + \author Junhua Gu + */ + + #ifndef VBETA_MODEL_H_ #define VBETA_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/bl.hpp b/vmodels/bl.hpp index 84d6ca5..dc2a0da 100644 --- a/vmodels/bl.hpp +++ b/vmodels/bl.hpp @@ -1,3 +1,10 @@ +/** + \file bl.hpp + \brief broken linear + \author Junhua Gu + */ + + #ifndef BROKEN_LINE_MODEL_H_ #define BROKEN_LINE_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/bpl.hpp b/vmodels/bpl.hpp index e99efe3..5f60ae4 100644 --- a/vmodels/bpl.hpp +++ b/vmodels/bpl.hpp @@ -1,3 +1,10 @@ +/** + \file bpl.hpp + \brief broken power law + \author Junhua Gu + */ + + #ifndef BROKEN_POWER_LAW_MODEL_H_ #define BROKEN_POWER_LAW_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/bremss.hpp b/vmodels/bremss.hpp index 12e1f71..6d9f317 100644 --- a/vmodels/bremss.hpp +++ b/vmodels/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/vmodels/constant.hpp b/vmodels/constant.hpp index c4044b0..888ef8e 100644 --- a/vmodels/constant.hpp +++ b/vmodels/constant.hpp @@ -1,3 +1,10 @@ +/** + \file constant.hpp + \brief constant model + \author Junhua Gu + */ + + #ifndef VCONSTANT_MODEL_H_ #define VCONSTANT_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/gauss1d.hpp b/vmodels/gauss1d.hpp index 670247d..ecfa81c 100644 --- a/vmodels/gauss1d.hpp +++ b/vmodels/gauss1d.hpp @@ -1,3 +1,9 @@ +/** + \file gauss1d.hpp + \brief Gauss model + \author Junhua Gu + */ + #ifndef GAUSS_MODEL_H_ #define GAUSS_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/lin1d.hpp b/vmodels/lin1d.hpp index 8ca8074..d58c589 100644 --- a/vmodels/lin1d.hpp +++ b/vmodels/lin1d.hpp @@ -1,3 +1,10 @@ +/** + \file lin1d.hpp + \brief linear + \author Junhua Gu + */ + + #ifndef VLINEAR_MODEL_H_ #define VLINEAR_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/nbeta1d.hpp b/vmodels/nbeta1d.hpp index b98d179..cbf0bc2 100644 --- a/vmodels/nbeta1d.hpp +++ b/vmodels/nbeta1d.hpp @@ -1,3 +1,10 @@ +/** + \file nbeta1d.hpp + \brief 1d density beta model + \author Junhua Gu + */ + + #ifndef VNBETA_MODEL_H_ #define VNBETA_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/nfw.hpp b/vmodels/nfw.hpp index 3e4264f..a46ed87 100644 --- a/vmodels/nfw.hpp +++ b/vmodels/nfw.hpp @@ -1,3 +1,10 @@ +/** + \file nfw.hpp + \brief NFW model + \author Junhua Gu + */ + + #ifndef NFW_MODEL_H_ #define NFW_MODEL_H_ #define OPT_HEADER diff --git a/vmodels/poly1d.hpp b/vmodels/poly1d.hpp index adaf03b..113ef83 100644 --- a/vmodels/poly1d.hpp +++ b/vmodels/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/vmodels/powerlaw.hpp b/vmodels/powerlaw.hpp index 1f05301..c30dbb6 100644 --- a/vmodels/powerlaw.hpp +++ b/vmodels/powerlaw.hpp @@ -1,3 +1,10 @@ +/** + \file powerlaw.hpp + \brief power law model + \author Junhua Gu + */ + + #ifndef POWER_LAW_MODEL_H_ #define POWER_LAW_MODEL_H_ #define OPT_HEADER |