Initial revision
[blender.git] / intern / iksolver / intern / IK_ConjugateGradientSolver.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 #ifndef NAN_INCLUDED_IK_ConjugateGradientSolver_h
33
34 #define NAN_INCLUDED_IK_ConjugateGradientSolver_h
35
36 /**
37  * @author Laurence Bourn
38  * @date 28/6/2001
39  */
40
41 #include "TNT/cmat.h"
42 #include "MT_Scalar.h"
43 #include "IK_LineMinimizer.h"
44
45 /** 
46  * These classes locally minimize n dimensional potenial functions.
47  * See Numerical Recipes in C www.nr.com for more details.
48  * If a n dimensionable potenial function is 
49  * differentiable, then it is diferentiable along
50  * any vector x. This can be found by the dot product
51  * of the gradient operator with x. 
52  * The conjugate gradient solver boils down to 
53  * a collection of line minimizations along various lines
54  * defined by position,direction pairs. There are 
55  * methods in this class to set the lines along which
56  * minimizations via the DiffentiablePotenialFunction1d interface
57  * are to be performed.
58  *      
59  * @warning I don't like data inheritance but it is the most efficient
60  * wasy to do this here.
61  */
62
63
64 class DifferentiablePotenialFunctionNd 
65 : public DifferentiablePotenialFunction1d 
66 {
67 public :
68
69         /** 
70          * Inherited from DiffentiablePotenialFunction1d
71          *
72          * virtual
73          *      MT_Scalar 
74          * Evaluate1d(
75          *      MT_Scalar x
76          * ) = 0;
77      *
78          * virtual
79          *      MT_Scalar
80          * Derivative1d(
81          *      MT_Scalar x
82          * ) = 0;
83          */
84
85         /// Methods to set the current line in N dimensions
86
87                 void
88         SetLineVector(
89                 const TNT::Vector<MT_Scalar> &pos,
90                 const TNT::Vector<MT_Scalar> &dir
91         ){
92                 m_line_pos = pos;
93                 m_line_dir = dir;
94         };
95
96         virtual
97                 MT_Scalar
98         Evaluate(
99                 const TNT::Vector<MT_Scalar> &x
100         ) = 0;
101
102         virtual
103                 void
104         Derivative(
105                 const TNT::Vector<MT_Scalar> &x,
106                 TNT::Vector<MT_Scalar> &dy
107         ) = 0;
108
109         /// @return The dimension of the domain of the potenial function
110
111         virtual
112                 int
113         Dimension(
114         ) const =0;
115         
116         virtual
117         ~DifferentiablePotenialFunctionNd(
118         ){
119         };
120
121 protected :
122
123         DifferentiablePotenialFunctionNd(){};
124
125         TNT::Vector<MT_Scalar> m_line_pos;
126         TNT::Vector<MT_Scalar> m_line_dir;
127
128 };
129
130
131 class IK_ConjugateGradientSolver 
132 : public MEM_NonCopyable
133 {
134 public :
135
136         /** 
137          * This class necessarily needs some (potenially large) 
138          * temporary vectors to aid computation. We therefore
139          * insist creation of these objects on the heap.
140          */
141
142         static
143                 IK_ConjugateGradientSolver *
144         New(
145         );
146
147         /** 
148          * Compute the minimum of the potenial function
149          * starting at point p. On return p contains the 
150          * computed minima, iter the number of iterations performed,
151          * fret the potenial value at the minima
152          */
153
154                 void
155         Solve(
156                 TNT::Vector<MT_Scalar> &p,
157                 MT_Scalar ftol,
158                 int &iter,
159                 MT_Scalar &fret,
160                 DifferentiablePotenialFunctionNd &potenial,
161                 int max_its = 200
162         );
163
164         ~IK_ConjugateGradientSolver(
165         );
166
167 private :
168                 void
169         LineMinimize(
170                 TNT::Vector<MT_Scalar> & p,
171                 const TNT::Vector<MT_Scalar> & xi,
172                 MT_Scalar &fret,
173                 DifferentiablePotenialFunctionNd &potenial
174         );
175
176         IK_ConjugateGradientSolver(
177         );
178
179                 void
180         ArmVectors(
181                 int dimension
182         );
183
184
185         TNT::Vector<MT_Scalar> m_g;
186         TNT::Vector<MT_Scalar> m_h;
187         TNT::Vector<MT_Scalar> m_xi;
188
189         TNT::Vector<MT_Scalar> m_xi_temp;
190
191 };
192
193 #endif
194
195