Fix memleaks in our gtests.
[blender.git] / source / blender / blenlib / intern / math_statistics.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_statistics.c
27  *  \ingroup bli
28  */
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_math.h"
33 #include "BLI_task.h"
34 #include "BLI_utildefines.h"
35
36 #include "BLI_strict_flags.h"
37
38 /********************************** Covariance Matrices *********************************/
39
40 typedef struct CovarianceData {
41         const float *cos_vn;
42         const float *center;
43         float *r_covmat;
44         float covfac;
45         int n;
46         int nbr_cos_vn;
47 } CovarianceData;
48
49 static void covariance_m_vn_ex_task_cb(void *userdata, void *UNUSED(userdata_chunk), int a)
50 {
51         CovarianceData *data = userdata;
52         const float *cos_vn = data->cos_vn;
53         const float *center = data->center;
54         float *r_covmat = data->r_covmat;
55         const int n = data->n;
56         const int nbr_cos_vn = data->nbr_cos_vn;
57
58         int k;
59
60         /* Covariance matrices are always symetrical, so we can compute only one half of it,
61          * and mirror it to the other half (at the end of the func).
62          *
63          * This allows using a flat loop of n*n with same results as imbricated one over half the matrix:
64          *
65          *     for (i = 0; i < n; i++) {
66          *         for (j = i; j < n; j++) {
67          *             ...
68          *         }
69          *      }
70          */
71         const int i = a / n;
72         const int j = a % n;
73         if (j < i)
74                 return;
75
76         if (center) {
77                 for (k = 0; k < nbr_cos_vn; k++) {
78                         r_covmat[a] += (cos_vn[k * n + i] - center[i]) * (cos_vn[k * n + j] - center[j]);
79                 }
80         }
81         else {
82                 for (k = 0; k < nbr_cos_vn; k++) {
83                         r_covmat[a] += cos_vn[k * n + i] * cos_vn[k * n + j];
84                 }
85         }
86         r_covmat[a] *= data->covfac;
87         if (j != i) {
88                 /* Mirror result to other half... */
89                 r_covmat[j * n + i] = r_covmat[a];
90         }
91 }
92
93 /**
94  * \brief Compute the covariance matrix of given set of nD coordinates.
95  *
96  * \param n the dimension of the vectors (and hence, of the covariance matrix to compute).
97  * \param cos_vn the nD points to compute covariance from.
98  * \param nbr_cos_vn the number of nD coordinates in cos_vn.
99  * \param center the center (or mean point) of cos_vn. If NULL, it is assumed cos_vn is already centered.
100  * \param use_sample_correction whether to apply sample correction
101  *                              (i.e. get 'sample varince' instead of 'population variance').
102  * \return r_covmat the computed covariance matrix.
103  */
104 void BLI_covariance_m_vn_ex(
105         const int n, const float *cos_vn, const int nbr_cos_vn, const float *center, const bool use_sample_correction,
106         float *r_covmat)
107 {
108         /* Note about that division: see https://en.wikipedia.org/wiki/Bessel%27s_correction.
109          * In a nutshell, it must be 1 / (n - 1) for 'sample data', and 1 / n for 'population data'...
110          */
111         const float covfac = 1.0f / (float)(use_sample_correction ? nbr_cos_vn - 1 : nbr_cos_vn);
112
113         memset(r_covmat, 0, sizeof(*r_covmat) * (size_t)(n * n));
114
115         CovarianceData data = {
116                 .cos_vn = cos_vn, .center = center, .r_covmat = r_covmat,
117             .covfac = covfac, .n = n, .nbr_cos_vn = nbr_cos_vn,
118         };
119
120         if ((nbr_cos_vn * n * n) >= 10000) {
121                 BLI_task_parallel_range_ex(0, n * n, &data, NULL, 0, covariance_m_vn_ex_task_cb, 0, false);
122         }
123         else {
124                 for (int k = 0; k < n * n; k++) {
125                         covariance_m_vn_ex_task_cb(&data, NULL, k);
126                 }
127         }
128 }
129
130 /**
131  * \brief Compute the covariance matrix of given set of 3D coordinates.
132  *
133  * \param cos_v3 the 3D points to compute covariance from.
134  * \param nbr_cos_v3 the number of 3D coordinates in cos_v3.
135  * \return r_covmat the computed covariance matrix.
136  * \return r_center the computed center (mean) of 3D points (may be NULL).
137  */
138 void BLI_covariance_m3_v3n(
139         const float (*cos_v3)[3], const int nbr_cos_v3, const bool use_sample_correction,
140         float r_covmat[3][3], float r_center[3])
141 {
142         float center[3];
143         const float mean_fac = 1.0f / (float)nbr_cos_v3;
144         int i;
145
146         zero_v3(center);
147         for (i = 0; i < nbr_cos_v3; i++) {
148                 /* Applying mean_fac here rather than once at the end reduce compute errors... */
149                 madd_v3_v3fl(center, cos_v3[i], mean_fac);
150         }
151
152         if (r_center) {
153                 copy_v3_v3(r_center, center);
154         }
155
156         BLI_covariance_m_vn_ex(3, (const float *)cos_v3, nbr_cos_v3, center, use_sample_correction, (float *)r_covmat);
157 }