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