OOPSE/libmdtools/MinimizerParameterSet.hpp

#ifndef _MININIZERPARAMETERSET_H_
#define _MININIZERPARAMETERSET_H_

// base class of minimizer's parameter set
class MinimizerParameterSet{
  public:
    MinimizerParameterSet(int dim);

    virtual void setDefaultParameter();
    
    void setStepSize(double step) { stepSize = step;}
    double getStepSize() { return stepSize;}

    void setMaxStep(double step) { maxStep = step;}
    double getMaxStep() {return maxStep;}

    const string getMethodName() {return methodName;}
    void setMethodName(const string& name) { methodName = name;}

    void setAbsGradTol(double tol) {absGradTol = tol;}
    double getAbsGradTol() {return absGradTol;}

    void setAchGradTol(double tol) { absAchGradTol = tol;}
    double getAchGradTol() { return achGradTol;}

    void setAbsTol(vector<double>& tol) { absTol = tol;}
    vector<double> getAbsTol() { return absTol;}
    
    void setRelTol(vector<double> tol) { relTol = tol;}
    vector<double> getRelTol() { return relTol;}

    void setTotTol(vector<double>& tol) { totTol = tol;}
    vector<double> getTotTol() { return totTol;}

  protected:    

    double stepSize;
    double maxStep;

    // Name of minimizer
    string methodName;

    // Absolute gradient tolerance 
    double absGradTol;

   // Achieved gradient tolerance.
    double  achGradTol;

    // Absolute tolerance
    vector<double> absTol;

    // Relative tolerance
    vector<double> relTol;

    // Total specified tolerance at convergence 
    vector<double> totTol;

    // Tolerance achieved at convergence.
    vector<double> achTol;

};


#endif
Revision:	997
Committed:	Thu Jan 29 21:44:13 2004 UTC (20 years, 5 months ago) by tim
File size:	1645 byte(s)
Log Message:	Adding MinimizerParameterSet class.
#	User	Rev	Content
1	tim	997	#ifndef _MININIZERPARAMETERSET_H_
2			#define _MININIZERPARAMETERSET_H_
3
4			// base class of minimizer's parameter set
5			class MinimizerParameterSet{
6			public:
7			MinimizerParameterSet(int dim);
8
9			virtual void setDefaultParameter();
10
11			void setStepSize(double step) { stepSize = step;}
12			double getStepSize() { return stepSize;}
13
14			void setMaxStep(double step) { maxStep = step;}
15			double getMaxStep() {return maxStep;}
16
17			const string getMethodName() {return methodName;}
18			void setMethodName(const string& name) { methodName = name;}
19
20			void setAbsGradTol(double tol) {absGradTol = tol;}
21			double getAbsGradTol() {return absGradTol;}
22
23			void setAchGradTol(double tol) { absAchGradTol = tol;}
24			double getAchGradTol() { return achGradTol;}
25
26			void setAbsTol(vector<double>& tol) { absTol = tol;}
27			vector<double> getAbsTol() { return absTol;}
28
29			void setRelTol(vector<double> tol) { relTol = tol;}
30			vector<double> getRelTol() { return relTol;}
31
32			void setTotTol(vector<double>& tol) { totTol = tol;}
33			vector<double> getTotTol() { return totTol;}
34
35			protected:
36
37			double stepSize;
38			double maxStep;
39
40			// Name of minimizer
41			string methodName;
42
43			// Absolute gradient tolerance
44			double absGradTol;
45
46			// Achieved gradient tolerance.
47			double achGradTol;
48
49			// Absolute tolerance
50			vector<double> absTol;
51
52			// Relative tolerance
53			vector<double> relTol;
54
55			// Total specified tolerance at convergence
56			vector<double> totTol;
57
58			// Tolerance achieved at convergence.
59			vector<double> achTol;
60
61			};
62
63
64			#endif