Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_math_solvers.h
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 #ifndef __BLI_MATH_SOLVERS_H__
21 #define __BLI_MATH_SOLVERS_H__
22
23 /** \file \ingroup bli
24  */
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 #include "BLI_compiler_attrs.h"
31 #include "BLI_math_inline.h"
32
33 #ifdef BLI_MATH_GCC_WARN_PRAGMA
34 #  pragma GCC diagnostic push
35 #  pragma GCC diagnostic ignored "-Wredundant-decls"
36 #endif
37
38 /********************************** Eigen Solvers *********************************/
39
40 bool BLI_eigen_solve_selfadjoint_m3(const float m3[3][3], float r_eigen_values[3], float r_eigen_vectors[3][3]);
41
42 void BLI_svd_m3(const float m3[3][3], float r_U[3][3], float r_S[], float r_V[3][3]);
43
44 /***************************** Simple Solvers ************************************/
45
46 bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count);
47 bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count);
48
49 /* Generic 3 variable Newton's method solver. */
50 typedef void (*Newton3D_DeltaFunc)(void *userdata, const float x[3], float r_delta[3]);
51 typedef void (*Newton3D_JacobianFunc)(void *userdata, const float x[3], float r_jacobian[3][3]);
52 typedef bool (*Newton3D_CorrectionFunc)(void *userdata, const float x[3], float step[3], float x_next[3]);
53
54 bool BLI_newton3d_solve(
55         Newton3D_DeltaFunc func_delta, Newton3D_JacobianFunc func_jacobian, Newton3D_CorrectionFunc func_correction, void *userdata,
56         float epsilon, int max_iterations, bool trace, const float x_init[3], float result[3]);
57
58 #ifdef BLI_MATH_GCC_WARN_PRAGMA
59 #  pragma GCC diagnostic pop
60 #endif
61
62 #ifdef __cplusplus
63 }
64 #endif
65
66 #endif /* __BLI_MATH_SOLVERS_H__ */