diff options
Diffstat (limited to 'core/opt_exception.hpp')
| -rw-r--r-- | core/opt_exception.hpp | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/core/opt_exception.hpp b/core/opt_exception.hpp index 65e4470..4413da7 100644 --- a/core/opt_exception.hpp +++ b/core/opt_exception.hpp @@ -1,9 +1,16 @@ +/** + \file opt_exception.hpp +*/ + #ifndef OPT_EXCEPTION #define OPT_EXCEPTION #include <string> #include <exception> namespace opt_utilities { + /** + the root class of exception used in opt_utilities + */ class opt_exception :public std::exception { @@ -26,6 +33,10 @@ namespace opt_utilities } }; + /** + When objection is not defined in optimizer, and optimizion is performing, + this exception will be thrown + */ class target_function_undefined :public opt_exception { @@ -35,6 +46,10 @@ namespace opt_utilities {} }; + /** + When the opt_method is not defined before the optimization is performing, + this exception will be thrown. + */ class opt_method_undefined :public opt_exception { @@ -44,6 +59,10 @@ namespace opt_utilities {} }; + /** + When fitter is not attached in a model, statistic, and other objects, + this exception will be thrown. + */ class fitter_unset :public opt_exception { @@ -53,6 +72,11 @@ namespace opt_utilities {} }; + + /** + When the model is not set before the model fitting, + this exception will be thrown. + */ class model_undefined :public opt_exception { @@ -62,6 +86,11 @@ namespace opt_utilities {} }; + + /** + When the data set is not loaded before the model fitting, + this exception will be thrown. + */ class data_unloaded :public opt_exception { @@ -72,6 +101,10 @@ namespace opt_utilities }; + /** + When the statistic is not set before the model fitting, + this exception will be thrown. + */ class statistic_undefined :public opt_exception { @@ -81,6 +114,11 @@ namespace opt_utilities {} }; + + /** + If a parameter is not found by the name or other information, + this exception will be thrown. + */ class param_not_found :public opt_exception { @@ -90,6 +128,11 @@ namespace opt_utilities {} }; + + /** + If param_modifier is not defined, and the user tries to get the + param_modifer, this exception will be thrown. + */ class param_modifier_undefined :public opt_exception { |