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