Welcome to mirror list, hosted at ThFree Co, Russian Federation.

IK_ConjugateGradientSolver.h « intern « iksolver « intern - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e50799a9fa11a7159c882ce95ee0ba511fe1fa1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/**
 * $Id$
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */

#ifndef NAN_INCLUDED_IK_ConjugateGradientSolver_h

#define NAN_INCLUDED_IK_ConjugateGradientSolver_h

/**
 * @author Laurence Bourn
 * @date 28/6/2001
 */

#include "TNT/cmat.h"
#include "MT_Scalar.h"
#include "IK_LineMinimizer.h"

/** 
 * These classes locally minimize n dimensional potenial functions.
 * See Numerical Recipes in C www.nr.com for more details.
 * If a n dimensionable potenial function is 
 * differentiable, then it is diferentiable along
 * any vector x. This can be found by the dot product
 * of the gradient operator with x. 
 * The conjugate gradient solver boils down to 
 * a collection of line minimizations along various lines
 * defined by position,direction pairs. There are 
 * methods in this class to set the lines along which
 * minimizations via the DiffentiablePotenialFunction1d interface
 * are to be performed.
 *	
 * @warning I don't like data inheritance but it is the most efficient
 * wasy to do this here.
 */


class DifferentiablePotenialFunctionNd 
: public DifferentiablePotenialFunction1d 
{
public :

	/** 
	 * Inherited from DiffentiablePotenialFunction1d
	 *
	 * virtual
	 *	MT_Scalar 
	 * Evaluate1d(
	 * 	MT_Scalar x
	 * ) = 0;
     *
	 * virtual
	 * 	MT_Scalar
	 * Derivative1d(
	 * 	MT_Scalar x
	 * ) = 0;
	 */

	/// Methods to set the current line in N dimensions

		void
	SetLineVector(
		const TNT::Vector<MT_Scalar> &pos,
		const TNT::Vector<MT_Scalar> &dir
	){
		m_line_pos = pos;
		m_line_dir = dir;
	};

	virtual
		MT_Scalar
	Evaluate(
		const TNT::Vector<MT_Scalar> &x
	) = 0;

	virtual
		void
	Derivative(
		const TNT::Vector<MT_Scalar> &x,
		TNT::Vector<MT_Scalar> &dy
	) = 0;

	/// @return The dimension of the domain of the potenial function

	virtual
		int
	Dimension(
	) const =0;
	
	virtual
	~DifferentiablePotenialFunctionNd(
	){
	};

protected :

	DifferentiablePotenialFunctionNd(){};

	TNT::Vector<MT_Scalar> m_line_pos;
	TNT::Vector<MT_Scalar> m_line_dir;

};


class IK_ConjugateGradientSolver 
: public MEM_NonCopyable
{
public :

	/** 
	 * This class necessarily needs some (potenially large) 
	 * temporary vectors to aid computation. We therefore
	 * insist creation of these objects on the heap.
	 */

	static
		IK_ConjugateGradientSolver *
	New(
	);

	/** 
	 * Compute the minimum of the potenial function
	 * starting at point p. On return p contains the 
	 * computed minima, iter the number of iterations performed,
	 * fret the potenial value at the minima
	 */

		void
	Solve(
		TNT::Vector<MT_Scalar> &p,
		MT_Scalar ftol,
		int &iter,
		MT_Scalar &fret,
		DifferentiablePotenialFunctionNd &potenial,
		int max_its = 200
	);

	~IK_ConjugateGradientSolver(
	);

private :
		void
	LineMinimize(
		TNT::Vector<MT_Scalar> & p,
		const TNT::Vector<MT_Scalar> & xi,
		MT_Scalar &fret,
		DifferentiablePotenialFunctionNd &potenial
	);

	IK_ConjugateGradientSolver(
	);

		void
	ArmVectors(
		int dimension
	);


	TNT::Vector<MT_Scalar> m_g;
	TNT::Vector<MT_Scalar> m_h;
	TNT::Vector<MT_Scalar> m_xi;

	TNT::Vector<MT_Scalar> m_xi_temp;

};

#endif