Blender V4.3
BLI_math_base_test.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#include "testing/testing.h"
6
7#include "BLI_math_base.hh"
8#include "BLI_math_base_safe.h"
9#include "BLI_math_vector.hh"
10
11namespace blender::tests {
12
13/* In tests below, when we are using -1.0f as max_diff value, we actually turn the function into a
14 * pure-ULP one. */
15
16/* Put this here, since we cannot use BLI_assert() in inline math files it seems... */
17TEST(math_base, CompareFFRelativeValid)
18{
19 EXPECT_TRUE(sizeof(float) == sizeof(int));
20}
21
22TEST(math_base, CompareFFRelativeNormal)
23{
24 float f1 = 1.99999988f; /* *(float *)&(*(int *)&f2 - 1) */
25 float f2 = 2.00000000f;
26 float f3 = 2.00000048f; /* *(float *)&(*(int *)&f2 + 2) */
27 float f4 = 2.10000000f; /* *(float *)&(*(int *)&f2 + 419430) */
28
29 const float max_diff = FLT_EPSILON * 0.1f;
30
31 EXPECT_TRUE(compare_ff_relative(f1, f2, max_diff, 1));
32 EXPECT_TRUE(compare_ff_relative(f2, f1, max_diff, 1));
33
34 EXPECT_TRUE(compare_ff_relative(f3, f2, max_diff, 2));
35 EXPECT_TRUE(compare_ff_relative(f2, f3, max_diff, 2));
36
37 EXPECT_FALSE(compare_ff_relative(f3, f2, max_diff, 1));
38 EXPECT_FALSE(compare_ff_relative(f2, f3, max_diff, 1));
39
40 EXPECT_FALSE(compare_ff_relative(f3, f2, -1.0f, 1));
41 EXPECT_FALSE(compare_ff_relative(f2, f3, -1.0f, 1));
42
43 EXPECT_TRUE(compare_ff_relative(f3, f2, -1.0f, 2));
44 EXPECT_TRUE(compare_ff_relative(f2, f3, -1.0f, 2));
45
46 EXPECT_FALSE(compare_ff_relative(f4, f2, max_diff, 64));
47 EXPECT_FALSE(compare_ff_relative(f2, f4, max_diff, 64));
48
49 EXPECT_TRUE(compare_ff_relative(f1, f3, max_diff, 64));
50 EXPECT_TRUE(compare_ff_relative(f3, f1, max_diff, 64));
51}
52
53TEST(math_base, CompareFFRelativeZero)
54{
55 float f0 = 0.0f;
56 float f1 = 4.2038954e-045f; /* *(float *)&(*(int *)&f0 + 3) */
57
58 float fn0 = -0.0f;
59 float fn1 = -2.8025969e-045f; /* *(float *)&(*(int *)&fn0 - 2) */
60
61 const float max_diff = FLT_EPSILON * 0.1f;
62
63 EXPECT_TRUE(compare_ff_relative(f0, f1, -1.0f, 3));
64 EXPECT_TRUE(compare_ff_relative(f1, f0, -1.0f, 3));
65 EXPECT_FALSE(compare_ff_relative(f0, f1, -1.0f, 2));
66 EXPECT_FALSE(compare_ff_relative(f1, f0, -1.0f, 2));
67 EXPECT_TRUE(compare_ff_relative(f0, f1, max_diff, 2));
68 EXPECT_TRUE(compare_ff_relative(f1, f0, max_diff, 2));
69
70 EXPECT_TRUE(compare_ff_relative(fn0, f1, -1.0f, 3));
71 EXPECT_TRUE(compare_ff_relative(f1, fn0, -1.0f, 3));
72 EXPECT_FALSE(compare_ff_relative(fn0, f1, -1.0f, 2));
73 EXPECT_FALSE(compare_ff_relative(f1, fn0, -1.0f, 2));
74 EXPECT_TRUE(compare_ff_relative(fn0, f1, max_diff, 2));
75 EXPECT_TRUE(compare_ff_relative(f1, fn0, max_diff, 2));
76
77 EXPECT_TRUE(compare_ff_relative(fn0, fn1, -1.0f, 2));
78 EXPECT_TRUE(compare_ff_relative(fn1, fn0, -1.0f, 2));
79 EXPECT_FALSE(compare_ff_relative(fn0, fn1, -1.0f, 1));
80 EXPECT_FALSE(compare_ff_relative(fn1, fn0, -1.0f, 1));
81 EXPECT_TRUE(compare_ff_relative(fn0, fn1, max_diff, 1));
82 EXPECT_TRUE(compare_ff_relative(fn1, fn0, max_diff, 1));
83
84 EXPECT_TRUE(compare_ff_relative(f0, fn1, -1.0f, 2));
85 EXPECT_TRUE(compare_ff_relative(fn1, f0, -1.0f, 2));
86 EXPECT_FALSE(compare_ff_relative(f0, fn1, -1.0f, 1));
87 EXPECT_FALSE(compare_ff_relative(fn1, f0, -1.0f, 1));
88 EXPECT_TRUE(compare_ff_relative(f0, fn1, max_diff, 1));
89 EXPECT_TRUE(compare_ff_relative(fn1, f0, max_diff, 1));
90
91 EXPECT_TRUE(compare_ff_relative(fn0, f0, -1.0f, 0));
92 EXPECT_TRUE(compare_ff_relative(f0, fn0, -1.0f, 0));
93}
94
95TEST(math_base, UlpDiffFF)
96{
97 EXPECT_EQ(ulp_diff_ff(0.0, 0.0), 0);
98 EXPECT_EQ(ulp_diff_ff(0.0, -0.0), 0);
99 EXPECT_EQ(ulp_diff_ff(-0.0, -0.0), 0);
100 EXPECT_EQ(ulp_diff_ff(1.0, 1.0), 0);
101 EXPECT_EQ(ulp_diff_ff(1.0, 2.0), 1 << 23);
102 EXPECT_EQ(ulp_diff_ff(2.0, 4.0), 1 << 23);
103 EXPECT_EQ(ulp_diff_ff(-1.0, -2.0), 1 << 23);
104 EXPECT_EQ(ulp_diff_ff(-2.0, -4.0), 1 << 23);
105 EXPECT_EQ(ulp_diff_ff(-1.0, 1.0), 0x7f000000);
106 EXPECT_EQ(ulp_diff_ff(0.0, 1.0), 0x3f800000);
107 EXPECT_EQ(ulp_diff_ff(-0.0, 1.0), 0x3f800000);
108 EXPECT_EQ(ulp_diff_ff(0.0, -1.0), 0x3f800000);
109 EXPECT_EQ(ulp_diff_ff(-0.0, -1.0), 0x3f800000);
110 EXPECT_EQ(ulp_diff_ff(INFINITY, -INFINITY), 0xff000000);
111 EXPECT_EQ(ulp_diff_ff(NAN, NAN), 0xffffffff);
112 EXPECT_EQ(ulp_diff_ff(NAN, 1.0), 0xffffffff);
113 EXPECT_EQ(ulp_diff_ff(1.0, NAN), 0xffffffff);
114 EXPECT_EQ(ulp_diff_ff(-NAN, 1.0), 0xffffffff);
115 EXPECT_EQ(ulp_diff_ff(1.0, -NAN), 0xffffffff);
116}
117
118TEST(math_base, Log2FloorU)
119{
120 EXPECT_EQ(log2_floor_u(0), 0);
121 EXPECT_EQ(log2_floor_u(1), 0);
122 EXPECT_EQ(log2_floor_u(2), 1);
123 EXPECT_EQ(log2_floor_u(3), 1);
124 EXPECT_EQ(log2_floor_u(4), 2);
125 EXPECT_EQ(log2_floor_u(5), 2);
126 EXPECT_EQ(log2_floor_u(6), 2);
127 EXPECT_EQ(log2_floor_u(7), 2);
128 EXPECT_EQ(log2_floor_u(8), 3);
129 EXPECT_EQ(log2_floor_u(9), 3);
130 EXPECT_EQ(log2_floor_u(123456), 16);
131}
132
133TEST(math_base, Log2CeilU)
134{
135 EXPECT_EQ(log2_ceil_u(0), 0);
136 EXPECT_EQ(log2_ceil_u(1), 0);
137 EXPECT_EQ(log2_ceil_u(2), 1);
138 EXPECT_EQ(log2_ceil_u(3), 2);
139 EXPECT_EQ(log2_ceil_u(4), 2);
140 EXPECT_EQ(log2_ceil_u(5), 3);
141 EXPECT_EQ(log2_ceil_u(6), 3);
142 EXPECT_EQ(log2_ceil_u(7), 3);
143 EXPECT_EQ(log2_ceil_u(8), 3);
144 EXPECT_EQ(log2_ceil_u(9), 4);
145 EXPECT_EQ(log2_ceil_u(123456), 17);
146}
147
148TEST(math_base, CeilPowerOf10)
149{
150 EXPECT_EQ(ceil_power_of_10(0), 0);
151 EXPECT_EQ(ceil_power_of_10(1), 1);
152 EXPECT_EQ(ceil_power_of_10(1e-6f), 1e-6f);
153 EXPECT_NEAR(ceil_power_of_10(100.1f), 1000.0f, 1e-4f);
154 EXPECT_NEAR(ceil_power_of_10(99.9f), 100.0f, 1e-4f);
155}
156
157TEST(math_base, FloorPowerOf10)
158{
159 EXPECT_EQ(floor_power_of_10(0), 0);
160 EXPECT_EQ(floor_power_of_10(1), 1);
161 EXPECT_EQ(floor_power_of_10(1e-6f), 1e-6f);
162 EXPECT_NEAR(floor_power_of_10(100.1f), 100.0f, 1e-4f);
163 EXPECT_NEAR(floor_power_of_10(99.9f), 10.0f, 1e-4f);
164}
165
166TEST(math_base, MinVectorAndFloat)
167{
168 EXPECT_EQ(math::min(1.0f, 2.0f), 1.0f);
169}
170
171TEST(math_base, ClampInt)
172{
173 EXPECT_EQ(math::clamp(111, -50, 101), 101);
174}
175
176TEST(math_base, StepLessThan)
177{
178 EXPECT_EQ(math::step(0.5f, 0.3f), 0.0f);
179}
180
181TEST(math_base, StepGreaterThan)
182{
183 EXPECT_EQ(math::step(0.5f, 0.6f), 1.0f);
184}
185
186TEST(math_base, StepExact)
187{
188 EXPECT_EQ(math::step(0.5f, 0.5f), 1.0f);
189}
190
191TEST(math_base, Midpoint)
192{
193 EXPECT_NEAR(math::midpoint(100.0f, 200.0f), 150.0f, 1e-4f);
194}
195
196TEST(math_base, InterpolateInt)
197{
198 EXPECT_EQ(math::interpolate(100, 200, 0.4f), 140);
199}
200
201TEST(math_base, FlooredFMod)
202{
203 EXPECT_FLOAT_EQ(floored_fmod(3.27f, 1.57f), 0.12999988f);
204 EXPECT_FLOAT_EQ(floored_fmod(327.f, 47.f), 45.f);
205 EXPECT_FLOAT_EQ(floored_fmod(-0.1f, 1.0f), 0.9f);
206 EXPECT_FLOAT_EQ(floored_fmod(-0.9f, 1.0f), 0.1f);
207 EXPECT_FLOAT_EQ(floored_fmod(-100.1f, 1.0f), 0.90000153f);
208 EXPECT_FLOAT_EQ(floored_fmod(-0.1f, 12345.0f), 12344.9f);
209 EXPECT_FLOAT_EQ(floored_fmod(12345.1f, 12345.0f), 0.099609375f);
210 EXPECT_FLOAT_EQ(floored_fmod(12344.999f, 12345.0f), 12344.999f);
211 EXPECT_FLOAT_EQ(floored_fmod(12345.0f, 12345.0f), 0.0f);
212}
213
214TEST(math_base, ModPeriodic)
215{
216 EXPECT_FLOAT_EQ(math::mod_periodic(3.27f, 1.57f), 0.12999988f);
217 EXPECT_FLOAT_EQ(math::mod_periodic(327.f, 47.f), 45.f);
218 EXPECT_FLOAT_EQ(math::mod_periodic(-0.1f, 1.0f), 0.9f);
219 EXPECT_FLOAT_EQ(math::mod_periodic(-0.9f, 1.0f), 0.1f);
220 EXPECT_FLOAT_EQ(math::mod_periodic(-100.1f, 1.0f), 0.90000153f);
221 EXPECT_FLOAT_EQ(math::mod_periodic(-0.1f, 12345.0f), 12344.9f);
222 EXPECT_FLOAT_EQ(math::mod_periodic(12345.1f, 12345.0f), 0.099609375f);
223 EXPECT_FLOAT_EQ(math::mod_periodic(12344.999f, 12345.0f), 12344.999f);
224 EXPECT_FLOAT_EQ(math::mod_periodic(12345.0f, 12345.0f), 0.0f);
225
226 EXPECT_EQ(math::mod_periodic(1, 10), 1);
227 EXPECT_EQ(math::mod_periodic(11, 10), 1);
228 EXPECT_EQ(math::mod_periodic(-1, 10), 9);
229 EXPECT_EQ(math::mod_periodic(-11, 10), 9);
230 EXPECT_EQ(math::mod_periodic(1, 1), 0);
231 EXPECT_EQ(math::mod_periodic(0, 99999), 0);
232 EXPECT_EQ(math::mod_periodic(99999, 99999), 0);
233
234 EXPECT_EQ(
235 math::mod_periodic(std::numeric_limits<int>::max() / 2, std::numeric_limits<int>::max() / 2),
236 0);
237 EXPECT_EQ(
238 math::mod_periodic(std::numeric_limits<int>::min() / 2, std::numeric_limits<int>::max() / 2),
239 std::numeric_limits<int>::max() / 2 - 1);
240
241 EXPECT_EQ(math::mod_periodic<int64_t>(1, 10), 1);
242 EXPECT_EQ(math::mod_periodic<int64_t>(11, 10), 1);
243 EXPECT_EQ(math::mod_periodic<int64_t>(-1, 10), 9);
244 EXPECT_EQ(math::mod_periodic<int64_t>(-11, 10), 9);
245 EXPECT_EQ(math::mod_periodic<int64_t>(1, 1), 0);
246 EXPECT_EQ(math::mod_periodic<int64_t>(0, 99999), 0);
247 EXPECT_EQ(math::mod_periodic<int64_t>(99999, 99999), 0);
248}
249
250} // namespace blender::tests
EXPECT_EQ
EXPECT_EQ(BLI_expr_pylike_eval(expr, nullptr, 0, &result), EXPR_PYLIKE_INVALID)
log2_ceil_u
MINLINE unsigned int log2_ceil_u(unsigned int x)
Definition math_base_inline.c:174
floor_power_of_10
float floor_power_of_10(float f)
Definition math_base.c:65
floored_fmod
MINLINE float floored_fmod(float f, float n)
Definition math_base_inline.c:313
ulp_diff_ff
MINLINE uint ulp_diff_ff(float a, float b)
Definition math_base_inline.c:565
log2_floor_u
MINLINE unsigned int log2_floor_u(unsigned int x)
Definition math_base_inline.c:169
ceil_power_of_10
float ceil_power_of_10(float f)
Definition math_base.c:74
compare_ff_relative
MINLINE int compare_ff_relative(float a, float b, float max_diff, int max_ulps)
Definition math_base_inline.c:598
BLI_math_base.hh
BLI_math_base_safe.h
BLI_math_vector.hh
blender::math::clamp
T clamp(const T &a, const T &min, const T &max)
Definition BLI_math_base.hh:63
blender::math::min
T min(const T &a, const T &b)
Definition BLI_math_base.hh:43
blender::math::step
T step(const T &edge, const T &value)
Definition BLI_math_base.hh:68
blender::math::midpoint
T midpoint(const T &a, const T &b)
Definition BLI_math_base.hh:248
blender::math::interpolate
T interpolate(const T &a, const T &b, const FactorT &t)
Definition BLI_math_base.hh:239
blender::math::mod_periodic
T mod_periodic(const T &a, const T &b)
Definition BLI_math_base.hh:109
blender::tests::TEST
TEST(any, DefaultConstructor)
Definition BLI_any_test.cc:12
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0