src/minimizers/CGFamilyMinimizer.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef MINIMIZERS_CGFAMILYMINMIZER_HPP
#define MINIMIZERS_CGFAMILYMINMIZER_HPP

#include "minimizers/OOPSEMinimizer.hpp"
namespace oopse {

/**
 * @class CGFamilyMinimizer 
 * Base class of conjugate gradient famlily minimzier
 */
class CGFamilyMinimizer : public OOPSEMinimizer{
    public:
                
        //check the convergence
        virtual int checkConvg();

    protected:
        CGFamilyMinimizer(SimInfo* info);
        
        std::vector<double> direction;
        std::vector<double> prevX;
        std::vector<double> prevG;
        double prevF;
        double stepSize;
};

}

#endif  

Revision:	1900
Committed:	Tue Jan 4 22:18:06 2005 UTC (21 years, 4 months ago) by tim
File size:	1763 byte(s)
Log Message:	minimizers in progress
#	Content
1	/*
2	* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project
3	*
4	* Contact: oopse@oopse.org
5	*
6	* This program is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU Lesser General Public License
8	* as published by the Free Software Foundation; either version 2.1
9	* of the License, or (at your option) any later version.
10	* All we ask is that proper credit is given for our work, which includes
11	* - but is not limited to - adding the above copyright notice to the beginning
12	* of your source code files, and to any copyright notice that you may distribute
13	* with programs based on this work.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU Lesser General Public License for more details.
19	*
20	* You should have received a copy of the GNU Lesser General Public License
21	* along with this program; if not, write to the Free Software
22	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23	*
24	*/
25
26	#ifndef MINIMIZERS_CGFAMILYMINMIZER_HPP
27	#define MINIMIZERS_CGFAMILYMINMIZER_HPP
28
29	#include "minimizers/OOPSEMinimizer.hpp"
30	namespace oopse {
31
32	/**
33	* @class CGFamilyMinimizer
34	* Base class of conjugate gradient famlily minimzier
35	*/
36	class CGFamilyMinimizer : public OOPSEMinimizer{
37	public:
38
39	//check the convergence
40	virtual int checkConvg();
41
42	protected:
43	CGFamilyMinimizer(SimInfo* info);
44
45	std::vector<double> direction;
46	std::vector<double> prevX;
47	std::vector<double> prevG;
48	double prevF;
49	double stepSize;
50	};
51
52	}
53
54	#endif
55