Add BLI_math_solver, where non-linear solvers should be.
[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 "eigen3_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 EG3_self_adjoint_eigen_solve(3, (const float *)m3, r_eigen_values, (float *)r_eigen_vectors);
61 }