BLI_math_rotation: properly name the quaternion power function.
[blender.git] / source / blender / blenlib / intern / math_solvers.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2015 by Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 /** \file blender/blenlib/intern/math_solvers.c
27  *  \ingroup bli
28  */
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_math.h"
33 #include "BLI_utildefines.h"
34
35 #include "BLI_strict_flags.h"
36
37 #include "eigen_capi.h"
38
39 /********************************** Eigen Solvers *********************************/
40
41 /**
42  * \brief Compute the eigen values and/or vectors of given 3D symmetric (aka adjoint) matrix.
43  *
44  * \param m3: the 3D symmetric matrix.
45  * \return r_eigen_values the computed eigen values (NULL if not needed).
46  * \return r_eigen_vectors the computed eigen vectors (NULL if not needed).
47  */
48 bool BLI_eigen_solve_selfadjoint_m3(const float m3[3][3], float r_eigen_values[3], float r_eigen_vectors[3][3])
49 {
50 #ifndef NDEBUG
51         /* We must assert given matrix is self-adjoint (i.e. symmetric) */
52         if ((m3[0][1] != m3[1][0]) ||
53             (m3[0][2] != m3[2][0]) ||
54             (m3[1][2] != m3[2][1]))
55         {
56                 BLI_assert(0);
57         }
58 #endif
59
60         return EIG_self_adjoint_eigen_solve(3, (const float *)m3, r_eigen_values, (float *)r_eigen_vectors);
61 }
62
63 /**
64  * \brief Compute the SVD (Singular Values Decomposition) of given 3D  matrix (m3 = USV*).
65  *
66  * \param m3: the matrix to decompose.
67  * \return r_U the computed left singular vector of \a m3 (NULL if not needed).
68  * \return r_S the computed singular values of \a m3 (NULL if not needed).
69  * \return r_V the computed right singular vector of \a m3 (NULL if not needed).
70  */
71 void BLI_svd_m3(const float m3[3][3], float r_U[3][3], float r_S[3], float r_V[3][3])
72 {
73         EIG_svd_square_matrix(3, (const float *)m3, (float *)r_U, (float *)r_S, (float *)r_V);
74 }
75
76 /***************************** Simple Solvers ************************************/
77
78 /**
79  * \brief Solve a tridiagonal system of equations:
80  *
81  * a[i] * r_x[i-1] + b[i] * r_x[i] + c[i] * r_x[i+1] = d[i]
82  *
83  * Ignores a[0] and c[count-1]. Uses the Thomas algorithm, e.g. see wiki.
84  *
85  * \param r_x: output vector, may be shared with any of the input ones
86  * \return true if success
87  */
88 bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
89 {
90         if (count < 1)
91                 return false;
92
93         size_t bytes = sizeof(double) * (unsigned)count;
94         double *c1 = (double *)MEM_mallocN(bytes * 2, "tridiagonal_c1d1");
95         double *d1 = c1 + count;
96
97         if (!c1)
98                 return false;
99
100         int i;
101         double c_prev, d_prev, x_prev;
102
103         /* forward pass */
104
105         c1[0] = c_prev = ((double)c[0]) / b[0];
106         d1[0] = d_prev = ((double)d[0]) / b[0];
107
108         for (i = 1; i < count; i++) {
109                 double denum = b[i] - a[i] * c_prev;
110
111                 c1[i] = c_prev = c[i] / denum;
112                 d1[i] = d_prev = (d[i] - a[i] * d_prev) / denum;
113         }
114
115         /* back pass */
116
117         x_prev = d_prev;
118         r_x[--i] = ((float)x_prev);
119
120         while (--i >= 0) {
121                 x_prev = d1[i] - c1[i] * x_prev;
122                 r_x[i] = ((float)x_prev);
123         }
124
125         MEM_freeN(c1);
126
127         return isfinite(x_prev);
128 }
129
130 /**
131  * \brief Solve a possibly cyclic tridiagonal system using the Sherman-Morrison formula.
132  *
133  * \param r_x: output vector, may be shared with any of the input ones
134  * \return true if success
135  */
136 bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
137 {
138         if (count < 1)
139                 return false;
140
141         float a0 = a[0], cN = c[count - 1];
142
143         /* if not really cyclic, fall back to the simple solver */
144         if (a0 == 0.0f && cN == 0.0f) {
145                 return BLI_tridiagonal_solve(a, b, c, d, r_x, count);
146         }
147
148         size_t bytes = sizeof(float) * (unsigned)count;
149         float *tmp = (float *)MEM_mallocN(bytes * 2, "tridiagonal_ex");
150         float *b2 = tmp + count;
151
152         if (!tmp)
153                 return false;
154
155         /* prepare the noncyclic system; relies on tridiagonal_solve ignoring values */
156         memcpy(b2, b, bytes);
157         b2[0] -= a0;
158         b2[count - 1] -= cN;
159
160         memset(tmp, 0, bytes);
161         tmp[0] = a0;
162         tmp[count - 1] = cN;
163
164         /* solve for partial solution and adjustment vector */
165         bool success =
166                 BLI_tridiagonal_solve(a, b2, c, tmp, tmp, count) &&
167                 BLI_tridiagonal_solve(a, b2, c, d, r_x, count);
168
169         /* apply adjustment */
170         if (success) {
171                 float coeff = (r_x[0] + r_x[count - 1]) / (1.0f + tmp[0] + tmp[count - 1]);
172
173                 for (int i = 0; i < count; i++) {
174                         r_x[i] -= coeff * tmp[i];
175                 }
176         }
177
178         MEM_freeN(tmp);
179
180         return success;
181 }
182
183 /**
184  * \brief Solve a generic f(x) = 0 equation using Newton's method.
185  *
186  * \param func_delta: Callback computing the value of f(x).
187  * \param func_jacobian: Callback computing the Jacobian matrix of the function at x.
188  * \param func_correction: Callback for forcing the search into an arbitrary custom domain. May be NULL.
189  * \param userdata: Data for the callbacks.
190  * \param epsilon: Desired precision.
191  * \param max_iterations: Limit on the iterations.
192  * \param trace: Enables logging to console.
193  * \param x_init: Initial solution vector.
194  * \param result: Final result.
195  * \return true if success
196  */
197 bool BLI_newton3d_solve(
198         Newton3D_DeltaFunc func_delta, Newton3D_JacobianFunc func_jacobian, Newton3D_CorrectionFunc func_correction, void *userdata,
199         float epsilon, int max_iterations, bool trace, const float x_init[3], float result[3])
200 {
201         float fdelta[3], fdeltav, next_fdeltav;
202         float jacobian[3][3], step[3], x[3], x_next[3];
203
204         epsilon *= epsilon;
205
206         copy_v3_v3(x, x_init);
207
208         func_delta(userdata, x, fdelta);
209         fdeltav = len_squared_v3(fdelta);
210
211         if (trace) {
212                 printf("START (%g, %g, %g) %g\n", x[0], x[1], x[2], fdeltav);
213         }
214
215         for (int i = 0; i < max_iterations && fdeltav > epsilon; i++) {
216                 /* Newton's method step. */
217                 func_jacobian(userdata, x, jacobian);
218
219                 if (!invert_m3(jacobian)) {
220                         return false;
221                 }
222
223                 mul_v3_m3v3(step, jacobian, fdelta);
224                 sub_v3_v3v3(x_next, x, step);
225
226                 /* Custom out-of-bounds value correction. */
227                 if (func_correction) {
228                         if (trace) {
229                                 printf("%3d * (%g, %g, %g)\n", i, x_next[0], x_next[1], x_next[2]);
230                         }
231
232                         if (!func_correction(userdata, x, step, x_next)) {
233                                 return false;
234                         }
235                 }
236
237                 func_delta(userdata, x_next, fdelta);
238                 next_fdeltav = len_squared_v3(fdelta);
239
240                 if (trace) {
241                         printf("%3d ? (%g, %g, %g) %g\n", i, x_next[0], x_next[1], x_next[2], next_fdeltav);
242                 }
243
244                 /* Line search correction. */
245                 while (next_fdeltav > fdeltav) {
246                         float g0 = sqrtf(fdeltav), g1 = sqrtf(next_fdeltav);
247                         float g01 = -g0 / len_v3(step);
248                         float det = 2.0f * (g1 - g0 - g01);
249                         float l = (det == 0.0f) ? 0.1f : -g01 / det;
250                         CLAMP_MIN(l, 0.1f);
251
252                         mul_v3_fl(step, l);
253                         sub_v3_v3v3(x_next, x, step);
254
255                         func_delta(userdata, x_next, fdelta);
256                         next_fdeltav = len_squared_v3(fdelta);
257
258                         if (trace) {
259                                 printf("%3d . (%g, %g, %g) %g\n", i, x_next[0], x_next[1], x_next[2], next_fdeltav);
260                         }
261                 }
262
263                 copy_v3_v3(x, x_next);
264                 fdeltav = next_fdeltav;
265         }
266
267         bool success = (fdeltav <= epsilon);
268
269         if (trace) {
270                 printf("%s  (%g, %g, %g) %g\n", success ? "OK  " : "FAIL", x[0], x[1], x[2], fdeltav);
271         }
272
273         copy_v3_v3(result, x);
274         return success;
275 }