test_math_funcs.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  1. /**************************************************************************/
  2. /* test_math_funcs.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef TEST_MATH_FUNCS_H
  31. #define TEST_MATH_FUNCS_H
  32. #include "tests/test_macros.h"
  33. namespace TestMath {
  34. TEST_CASE("[Math] C++ macros") {
  35. CHECK(MIN(-2, 2) == -2);
  36. CHECK(MIN(600, 2) == 2);
  37. CHECK(MAX(-2, 2) == 2);
  38. CHECK(MAX(600, 2) == 600);
  39. CHECK(CLAMP(600, -2, 2) == 2);
  40. CHECK(CLAMP(620, 600, 650) == 620);
  41. // `max` is lower than `min`.
  42. CHECK(CLAMP(620, 600, 50) == 50);
  43. CHECK(ABS(-5) == 5);
  44. CHECK(ABS(0) == 0);
  45. CHECK(ABS(5) == 5);
  46. CHECK(SIGN(-5) == -1.0);
  47. CHECK(SIGN(0) == 0.0);
  48. CHECK(SIGN(5) == 1.0);
  49. }
  50. TEST_CASE("[Math] Power of two functions") {
  51. CHECK(next_power_of_2(0) == 0);
  52. CHECK(next_power_of_2(1) == 1);
  53. CHECK(next_power_of_2(16) == 16);
  54. CHECK(next_power_of_2(17) == 32);
  55. CHECK(next_power_of_2(65535) == 65536);
  56. CHECK(previous_power_of_2(0) == 0);
  57. CHECK(previous_power_of_2(1) == 1);
  58. CHECK(previous_power_of_2(16) == 16);
  59. CHECK(previous_power_of_2(17) == 16);
  60. CHECK(previous_power_of_2(65535) == 32768);
  61. CHECK(closest_power_of_2(0) == 0);
  62. CHECK(closest_power_of_2(1) == 1);
  63. CHECK(closest_power_of_2(16) == 16);
  64. CHECK(closest_power_of_2(17) == 16);
  65. CHECK(closest_power_of_2(65535) == 65536);
  66. CHECK(get_shift_from_power_of_2(0) == -1);
  67. CHECK(get_shift_from_power_of_2(1) == 0);
  68. CHECK(get_shift_from_power_of_2(16) == 4);
  69. CHECK(get_shift_from_power_of_2(17) == -1);
  70. CHECK(get_shift_from_power_of_2(65535) == -1);
  71. CHECK(nearest_shift(0) == 0);
  72. CHECK(nearest_shift(1) == 1);
  73. CHECK(nearest_shift(16) == 5);
  74. CHECK(nearest_shift(17) == 5);
  75. CHECK(nearest_shift(65535) == 16);
  76. }
  77. TEST_CASE_TEMPLATE("[Math] abs", T, int, float, double) {
  78. CHECK(Math::abs((T)-1) == (T)1);
  79. CHECK(Math::abs((T)0) == (T)0);
  80. CHECK(Math::abs((T)1) == (T)1);
  81. CHECK(Math::abs((T)0.1) == (T)0.1);
  82. }
  83. TEST_CASE_TEMPLATE("[Math] round/floor/ceil", T, float, double) {
  84. CHECK(Math::round((T)1.5) == (T)2.0);
  85. CHECK(Math::round((T)1.6) == (T)2.0);
  86. CHECK(Math::round((T)-1.5) == (T)-2.0);
  87. CHECK(Math::round((T)-1.1) == (T)-1.0);
  88. CHECK(Math::floor((T)1.5) == (T)1.0);
  89. CHECK(Math::floor((T)-1.5) == (T)-2.0);
  90. CHECK(Math::ceil((T)1.5) == (T)2.0);
  91. CHECK(Math::ceil((T)-1.9) == (T)-1.0);
  92. }
  93. TEST_CASE_TEMPLATE("[Math] sin/cos/tan", T, float, double) {
  94. CHECK(Math::sin((T)-0.1) == doctest::Approx((T)-0.0998334166));
  95. CHECK(Math::sin((T)0.1) == doctest::Approx((T)0.0998334166));
  96. CHECK(Math::sin((T)0.5) == doctest::Approx((T)0.4794255386));
  97. CHECK(Math::sin((T)1.0) == doctest::Approx((T)0.8414709848));
  98. CHECK(Math::sin((T)1.5) == doctest::Approx((T)0.9974949866));
  99. CHECK(Math::sin((T)450.0) == doctest::Approx((T)-0.683283725));
  100. CHECK(Math::cos((T)-0.1) == doctest::Approx((T)0.99500416530));
  101. CHECK(Math::cos((T)0.1) == doctest::Approx((T)0.9950041653));
  102. CHECK(Math::cos((T)0.5) == doctest::Approx((T)0.8775825619));
  103. CHECK(Math::cos((T)1.0) == doctest::Approx((T)0.5403023059));
  104. CHECK(Math::cos((T)1.5) == doctest::Approx((T)0.0707372017));
  105. CHECK(Math::cos((T)450.0) == doctest::Approx((T)-0.7301529642));
  106. CHECK(Math::tan((T)-0.1) == doctest::Approx((T)-0.1003346721));
  107. CHECK(Math::tan((T)0.1) == doctest::Approx((T)0.1003346721));
  108. CHECK(Math::tan((T)0.5) == doctest::Approx((T)0.5463024898));
  109. CHECK(Math::tan((T)1.0) == doctest::Approx((T)1.5574077247));
  110. CHECK(Math::tan((T)1.5) == doctest::Approx((T)14.1014199472));
  111. CHECK(Math::tan((T)450.0) == doctest::Approx((T)0.9358090134));
  112. }
  113. TEST_CASE_TEMPLATE("[Math] sinh/cosh/tanh", T, float, double) {
  114. CHECK(Math::sinh((T)-0.1) == doctest::Approx((T)-0.10016675));
  115. CHECK(Math::sinh((T)0.1) == doctest::Approx((T)0.10016675));
  116. CHECK(Math::sinh((T)0.5) == doctest::Approx((T)0.5210953055));
  117. CHECK(Math::sinh((T)1.0) == doctest::Approx((T)1.1752011936));
  118. CHECK(Math::sinh((T)1.5) == doctest::Approx((T)2.1292794551));
  119. CHECK(Math::cosh((T)-0.1) == doctest::Approx((T)1.0050041681));
  120. CHECK(Math::cosh((T)0.1) == doctest::Approx((T)1.0050041681));
  121. CHECK(Math::cosh((T)0.5) == doctest::Approx((T)1.1276259652));
  122. CHECK(Math::cosh((T)1.0) == doctest::Approx((T)1.5430806348));
  123. CHECK(Math::cosh((T)1.5) == doctest::Approx((T)2.3524096152));
  124. CHECK(Math::tanh((T)-0.1) == doctest::Approx((T)-0.0996679946));
  125. CHECK(Math::tanh((T)0.1) == doctest::Approx((T)0.0996679946));
  126. CHECK(Math::tanh((T)0.5) == doctest::Approx((T)0.4621171573));
  127. CHECK(Math::tanh((T)1.0) == doctest::Approx((T)0.761594156));
  128. CHECK(Math::tanh((T)1.5) == doctest::Approx((T)0.9051482536));
  129. CHECK(Math::tanh((T)450.0) == doctest::Approx((T)1.0));
  130. }
  131. TEST_CASE_TEMPLATE("[Math] asin/acos/atan", T, float, double) {
  132. CHECK(Math::asin((T)-0.1) == doctest::Approx((T)-0.1001674212));
  133. CHECK(Math::asin((T)0.1) == doctest::Approx((T)0.1001674212));
  134. CHECK(Math::asin((T)0.5) == doctest::Approx((T)0.5235987756));
  135. CHECK(Math::asin((T)1.0) == doctest::Approx((T)1.5707963268));
  136. CHECK(Math::asin((T)2.0) == doctest::Approx((T)1.5707963268));
  137. CHECK(Math::asin((T)-2.0) == doctest::Approx((T)-1.5707963268));
  138. CHECK(Math::acos((T)-0.1) == doctest::Approx((T)1.670963748));
  139. CHECK(Math::acos((T)0.1) == doctest::Approx((T)1.4706289056));
  140. CHECK(Math::acos((T)0.5) == doctest::Approx((T)1.0471975512));
  141. CHECK(Math::acos((T)1.0) == doctest::Approx((T)0.0));
  142. CHECK(Math::acos((T)2.0) == doctest::Approx((T)0.0));
  143. CHECK(Math::acos((T)-2.0) == doctest::Approx((T)Math_PI));
  144. CHECK(Math::atan((T)-0.1) == doctest::Approx((T)-0.0996686525));
  145. CHECK(Math::atan((T)0.1) == doctest::Approx((T)0.0996686525));
  146. CHECK(Math::atan((T)0.5) == doctest::Approx((T)0.463647609));
  147. CHECK(Math::atan((T)1.0) == doctest::Approx((T)0.7853981634));
  148. CHECK(Math::atan((T)1.5) == doctest::Approx((T)0.9827937232));
  149. CHECK(Math::atan((T)450.0) == doctest::Approx((T)1.5685741082));
  150. }
  151. TEST_CASE_TEMPLATE("[Math] sinc/sincn/atan2", T, float, double) {
  152. CHECK(Math::sinc((T)-0.1) == doctest::Approx((T)0.9983341665));
  153. CHECK(Math::sinc((T)0.1) == doctest::Approx((T)0.9983341665));
  154. CHECK(Math::sinc((T)0.5) == doctest::Approx((T)0.9588510772));
  155. CHECK(Math::sinc((T)1.0) == doctest::Approx((T)0.8414709848));
  156. CHECK(Math::sinc((T)1.5) == doctest::Approx((T)0.6649966577));
  157. CHECK(Math::sinc((T)450.0) == doctest::Approx((T)-0.0015184083));
  158. CHECK(Math::sincn((T)-0.1) == doctest::Approx((T)0.9836316431));
  159. CHECK(Math::sincn((T)0.1) == doctest::Approx((T)0.9836316431));
  160. CHECK(Math::sincn((T)0.5) == doctest::Approx((T)0.6366197724));
  161. CHECK(Math::sincn((T)1.0) == doctest::Approx((T)0.0));
  162. CHECK(Math::sincn((T)1.5) == doctest::Approx((T)-0.2122065908));
  163. CHECK(Math::sincn((T)450.0) == doctest::Approx((T)0.0));
  164. CHECK(Math::atan2((T)-0.1, (T)0.5) == doctest::Approx((T)-0.1973955598));
  165. CHECK(Math::atan2((T)0.1, (T)-0.5) == doctest::Approx((T)2.9441970937));
  166. CHECK(Math::atan2((T)0.5, (T)1.5) == doctest::Approx((T)0.3217505544));
  167. CHECK(Math::atan2((T)1.0, (T)2.5) == doctest::Approx((T)0.3805063771));
  168. CHECK(Math::atan2((T)1.5, (T)1.0) == doctest::Approx((T)0.9827937232));
  169. CHECK(Math::atan2((T)450.0, (T)1.0) == doctest::Approx((T)1.5685741082));
  170. }
  171. TEST_CASE_TEMPLATE("[Math] pow/log/log2/exp/sqrt", T, float, double) {
  172. CHECK(Math::pow((T)-0.1, (T)2.0) == doctest::Approx((T)0.01));
  173. CHECK(Math::pow((T)0.1, (T)2.5) == doctest::Approx((T)0.0031622777));
  174. CHECK(Math::pow((T)0.5, (T)0.5) == doctest::Approx((T)0.7071067812));
  175. CHECK(Math::pow((T)1.0, (T)1.0) == doctest::Approx((T)1.0));
  176. CHECK(Math::pow((T)1.5, (T)-1.0) == doctest::Approx((T)0.6666666667));
  177. CHECK(Math::pow((T)450.0, (T)-2.0) == doctest::Approx((T)0.0000049383));
  178. CHECK(Math::pow((T)450.0, (T)0.0) == doctest::Approx((T)1.0));
  179. CHECK(Math::is_nan(Math::log((T)-0.1)));
  180. CHECK(Math::log((T)0.1) == doctest::Approx((T)-2.302585093));
  181. CHECK(Math::log((T)0.5) == doctest::Approx((T)-0.6931471806));
  182. CHECK(Math::log((T)1.0) == doctest::Approx((T)0.0));
  183. CHECK(Math::log((T)1.5) == doctest::Approx((T)0.4054651081));
  184. CHECK(Math::log((T)450.0) == doctest::Approx((T)6.1092475828));
  185. CHECK(Math::is_nan(Math::log2((T)-0.1)));
  186. CHECK(Math::log2((T)0.1) == doctest::Approx((T)-3.3219280949));
  187. CHECK(Math::log2((T)0.5) == doctest::Approx((T)-1.0));
  188. CHECK(Math::log2((T)1.0) == doctest::Approx((T)0.0));
  189. CHECK(Math::log2((T)1.5) == doctest::Approx((T)0.5849625007));
  190. CHECK(Math::log2((T)450.0) == doctest::Approx((T)8.8137811912));
  191. CHECK(Math::exp((T)-0.1) == doctest::Approx((T)0.904837418));
  192. CHECK(Math::exp((T)0.1) == doctest::Approx((T)1.1051709181));
  193. CHECK(Math::exp((T)0.5) == doctest::Approx((T)1.6487212707));
  194. CHECK(Math::exp((T)1.0) == doctest::Approx((T)2.7182818285));
  195. CHECK(Math::exp((T)1.5) == doctest::Approx((T)4.4816890703));
  196. CHECK(Math::is_nan(Math::sqrt((T)-0.1)));
  197. CHECK(Math::sqrt((T)0.1) == doctest::Approx((T)0.316228));
  198. CHECK(Math::sqrt((T)0.5) == doctest::Approx((T)0.707107));
  199. CHECK(Math::sqrt((T)1.0) == doctest::Approx((T)1.0));
  200. CHECK(Math::sqrt((T)1.5) == doctest::Approx((T)1.224745));
  201. }
  202. TEST_CASE_TEMPLATE("[Math] is_nan/is_inf", T, float, double) {
  203. CHECK(!Math::is_nan((T)0.0));
  204. CHECK(Math::is_nan((T)NAN));
  205. CHECK(!Math::is_inf((T)0.0));
  206. CHECK(Math::is_inf((T)INFINITY));
  207. }
  208. TEST_CASE_TEMPLATE("[Math] linear_to_db", T, float, double) {
  209. CHECK(Math::linear_to_db((T)1.0) == doctest::Approx((T)0.0));
  210. CHECK(Math::linear_to_db((T)20.0) == doctest::Approx((T)26.0206));
  211. CHECK(Math::is_inf(Math::linear_to_db((T)0.0)));
  212. CHECK(Math::is_nan(Math::linear_to_db((T)-20.0)));
  213. }
  214. TEST_CASE_TEMPLATE("[Math] db_to_linear", T, float, double) {
  215. CHECK(Math::db_to_linear((T)0.0) == doctest::Approx((T)1.0));
  216. CHECK(Math::db_to_linear((T)1.0) == doctest::Approx((T)1.122018));
  217. CHECK(Math::db_to_linear((T)20.0) == doctest::Approx((T)10.0));
  218. CHECK(Math::db_to_linear((T)-20.0) == doctest::Approx((T)0.1));
  219. }
  220. TEST_CASE_TEMPLATE("[Math] step_decimals", T, float, double) {
  221. CHECK(Math::step_decimals((T)-0.5) == 1);
  222. CHECK(Math::step_decimals((T)0) == 0);
  223. CHECK(Math::step_decimals((T)1) == 0);
  224. CHECK(Math::step_decimals((T)0.1) == 1);
  225. CHECK(Math::step_decimals((T)0.01) == 2);
  226. CHECK(Math::step_decimals((T)0.001) == 3);
  227. CHECK(Math::step_decimals((T)0.0001) == 4);
  228. CHECK(Math::step_decimals((T)0.00001) == 5);
  229. CHECK(Math::step_decimals((T)0.000001) == 6);
  230. CHECK(Math::step_decimals((T)0.0000001) == 7);
  231. CHECK(Math::step_decimals((T)0.00000001) == 8);
  232. CHECK(Math::step_decimals((T)0.000000001) == 9);
  233. // Too many decimals to handle.
  234. CHECK(Math::step_decimals((T)0.0000000001) == 0);
  235. }
  236. TEST_CASE_TEMPLATE("[Math] range_step_decimals", T, float, double) {
  237. CHECK(Math::range_step_decimals((T)0.000000001) == 9);
  238. // Too many decimals to handle.
  239. CHECK(Math::range_step_decimals((T)0.0000000001) == 0);
  240. // Should be treated as a step of 0 for use by the editor.
  241. CHECK(Math::range_step_decimals((T)0.0) == 16);
  242. CHECK(Math::range_step_decimals((T)-0.5) == 16);
  243. }
  244. TEST_CASE_TEMPLATE("[Math] lerp", T, float, double) {
  245. CHECK(Math::lerp((T)2.0, (T)5.0, (T)-0.1) == doctest::Approx((T)1.7));
  246. CHECK(Math::lerp((T)2.0, (T)5.0, (T)0.0) == doctest::Approx((T)2.0));
  247. CHECK(Math::lerp((T)2.0, (T)5.0, (T)0.1) == doctest::Approx((T)2.3));
  248. CHECK(Math::lerp((T)2.0, (T)5.0, (T)1.0) == doctest::Approx((T)5.0));
  249. CHECK(Math::lerp((T)2.0, (T)5.0, (T)2.0) == doctest::Approx((T)8.0));
  250. CHECK(Math::lerp((T)-2.0, (T)-5.0, (T)-0.1) == doctest::Approx((T)-1.7));
  251. CHECK(Math::lerp((T)-2.0, (T)-5.0, (T)0.0) == doctest::Approx((T)-2.0));
  252. CHECK(Math::lerp((T)-2.0, (T)-5.0, (T)0.1) == doctest::Approx((T)-2.3));
  253. CHECK(Math::lerp((T)-2.0, (T)-5.0, (T)1.0) == doctest::Approx((T)-5.0));
  254. CHECK(Math::lerp((T)-2.0, (T)-5.0, (T)2.0) == doctest::Approx((T)-8.0));
  255. }
  256. TEST_CASE_TEMPLATE("[Math] inverse_lerp", T, float, double) {
  257. CHECK(Math::inverse_lerp((T)2.0, (T)5.0, (T)1.7) == doctest::Approx((T)-0.1));
  258. CHECK(Math::inverse_lerp((T)2.0, (T)5.0, (T)2.0) == doctest::Approx((T)0.0));
  259. CHECK(Math::inverse_lerp((T)2.0, (T)5.0, (T)2.3) == doctest::Approx((T)0.1));
  260. CHECK(Math::inverse_lerp((T)2.0, (T)5.0, (T)5.0) == doctest::Approx((T)1.0));
  261. CHECK(Math::inverse_lerp((T)2.0, (T)5.0, (T)8.0) == doctest::Approx((T)2.0));
  262. CHECK(Math::inverse_lerp((T)-2.0, (T)-5.0, (T)-1.7) == doctest::Approx((T)-0.1));
  263. CHECK(Math::inverse_lerp((T)-2.0, (T)-5.0, (T)-2.0) == doctest::Approx((T)0.0));
  264. CHECK(Math::inverse_lerp((T)-2.0, (T)-5.0, (T)-2.3) == doctest::Approx((T)0.1));
  265. CHECK(Math::inverse_lerp((T)-2.0, (T)-5.0, (T)-5.0) == doctest::Approx((T)1.0));
  266. CHECK(Math::inverse_lerp((T)-2.0, (T)-5.0, (T)-8.0) == doctest::Approx((T)2.0));
  267. }
  268. TEST_CASE_TEMPLATE("[Math] remap", T, float, double) {
  269. CHECK(Math::remap((T)50.0, (T)100.0, (T)200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)-500.0));
  270. CHECK(Math::remap((T)100.0, (T)100.0, (T)200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)0.0));
  271. CHECK(Math::remap((T)200.0, (T)100.0, (T)200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)1000.0));
  272. CHECK(Math::remap((T)250.0, (T)100.0, (T)200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)1500.0));
  273. CHECK(Math::remap((T)-50.0, (T)-100.0, (T)-200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)-500.0));
  274. CHECK(Math::remap((T)-100.0, (T)-100.0, (T)-200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)0.0));
  275. CHECK(Math::remap((T)-200.0, (T)-100.0, (T)-200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)1000.0));
  276. CHECK(Math::remap((T)-250.0, (T)-100.0, (T)-200.0, (T)0.0, (T)1000.0) == doctest::Approx((T)1500.0));
  277. CHECK(Math::remap((T)-50.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)500.0));
  278. CHECK(Math::remap((T)-100.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)0.0));
  279. CHECK(Math::remap((T)-200.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1000.0));
  280. CHECK(Math::remap((T)-250.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1500.0));
  281. }
  282. TEST_CASE_TEMPLATE("[Math] lerp_angle", T, float, double) {
  283. // Counter-clockwise rotation.
  284. CHECK(Math::lerp_angle((T)0.24 * Math_TAU, 0.75 * Math_TAU, 0.5) == doctest::Approx((T)-0.005 * Math_TAU));
  285. // Counter-clockwise rotation.
  286. CHECK(Math::lerp_angle((T)0.25 * Math_TAU, 0.75 * Math_TAU, 0.5) == doctest::Approx((T)0.0));
  287. // Clockwise rotation.
  288. CHECK(Math::lerp_angle((T)0.26 * Math_TAU, 0.75 * Math_TAU, 0.5) == doctest::Approx((T)0.505 * Math_TAU));
  289. CHECK(Math::lerp_angle((T)-0.25 * Math_TAU, 1.25 * Math_TAU, 0.5) == doctest::Approx((T)-0.5 * Math_TAU));
  290. CHECK(Math::lerp_angle((T)0.72 * Math_TAU, 1.44 * Math_TAU, 0.96) == doctest::Approx((T)0.4512 * Math_TAU));
  291. CHECK(Math::lerp_angle((T)0.72 * Math_TAU, 1.44 * Math_TAU, 1.04) == doctest::Approx((T)0.4288 * Math_TAU));
  292. // Initial and final angles are effectively identical, so the value returned
  293. // should always be the same regardless of the `weight` parameter.
  294. CHECK(Math::lerp_angle((T)-4 * Math_TAU, 4 * Math_TAU, -1.0) == doctest::Approx((T)-4.0 * Math_TAU));
  295. CHECK(Math::lerp_angle((T)-4 * Math_TAU, 4 * Math_TAU, 0.0) == doctest::Approx((T)-4.0 * Math_TAU));
  296. CHECK(Math::lerp_angle((T)-4 * Math_TAU, 4 * Math_TAU, 0.5) == doctest::Approx((T)-4.0 * Math_TAU));
  297. CHECK(Math::lerp_angle((T)-4 * Math_TAU, 4 * Math_TAU, 1.0) == doctest::Approx((T)-4.0 * Math_TAU));
  298. CHECK(Math::lerp_angle((T)-4 * Math_TAU, 4 * Math_TAU, 500.0) == doctest::Approx((T)-4.0 * Math_TAU));
  299. }
  300. TEST_CASE_TEMPLATE("[Math] move_toward", T, float, double) {
  301. CHECK(Math::move_toward(2.0, 5.0, -1.0) == doctest::Approx((T)1.0));
  302. CHECK(Math::move_toward(2.0, 5.0, 2.5) == doctest::Approx((T)4.5));
  303. CHECK(Math::move_toward(2.0, 5.0, 4.0) == doctest::Approx((T)5.0));
  304. CHECK(Math::move_toward(-2.0, -5.0, -1.0) == doctest::Approx((T)-1.0));
  305. CHECK(Math::move_toward(-2.0, -5.0, 2.5) == doctest::Approx((T)-4.5));
  306. CHECK(Math::move_toward(-2.0, -5.0, 4.0) == doctest::Approx((T)-5.0));
  307. }
  308. TEST_CASE_TEMPLATE("[Math] smoothstep", T, float, double) {
  309. CHECK(Math::smoothstep((T)0.0, (T)2.0, (T)-5.0) == doctest::Approx((T)0.0));
  310. CHECK(Math::smoothstep((T)0.0, (T)2.0, (T)0.5) == doctest::Approx((T)0.15625));
  311. CHECK(Math::smoothstep((T)0.0, (T)2.0, (T)1.0) == doctest::Approx((T)0.5));
  312. CHECK(Math::smoothstep((T)0.0, (T)2.0, (T)2.0) == doctest::Approx((T)1.0));
  313. }
  314. TEST_CASE("[Math] ease") {
  315. CHECK(Math::ease(0.1, 1.0) == doctest::Approx(0.1));
  316. CHECK(Math::ease(0.1, 2.0) == doctest::Approx(0.01));
  317. CHECK(Math::ease(0.1, 0.5) == doctest::Approx(0.19));
  318. CHECK(Math::ease(0.1, 0.0) == doctest::Approx(0));
  319. CHECK(Math::ease(0.1, -0.5) == doctest::Approx(0.2236067977));
  320. CHECK(Math::ease(0.1, -1.0) == doctest::Approx(0.1));
  321. CHECK(Math::ease(0.1, -2.0) == doctest::Approx(0.02));
  322. CHECK(Math::ease(-1.0, 1.0) == doctest::Approx(0));
  323. CHECK(Math::ease(-1.0, 2.0) == doctest::Approx(0));
  324. CHECK(Math::ease(-1.0, 0.5) == doctest::Approx(0));
  325. CHECK(Math::ease(-1.0, 0.0) == doctest::Approx(0));
  326. CHECK(Math::ease(-1.0, -0.5) == doctest::Approx(0));
  327. CHECK(Math::ease(-1.0, -1.0) == doctest::Approx(0));
  328. CHECK(Math::ease(-1.0, -2.0) == doctest::Approx(0));
  329. }
  330. TEST_CASE("[Math] snapped") {
  331. CHECK(Math::snapped(0.5, 0.04) == doctest::Approx(0.52));
  332. CHECK(Math::snapped(-0.5, 0.04) == doctest::Approx(-0.48));
  333. CHECK(Math::snapped(0.0, 0.04) == doctest::Approx(0));
  334. CHECK(Math::snapped(128'000.025, 0.04) == doctest::Approx(128'000.04));
  335. CHECK(Math::snapped(0.5, 400) == doctest::Approx(0));
  336. CHECK(Math::snapped(-0.5, 400) == doctest::Approx(0));
  337. CHECK(Math::snapped(0.0, 400) == doctest::Approx(0));
  338. CHECK(Math::snapped(128'000.025, 400) == doctest::Approx(128'000.0));
  339. CHECK(Math::snapped(0.5, 0.0) == doctest::Approx(0.5));
  340. CHECK(Math::snapped(-0.5, 0.0) == doctest::Approx(-0.5));
  341. CHECK(Math::snapped(0.0, 0.0) == doctest::Approx(0.0));
  342. CHECK(Math::snapped(128'000.025, 0.0) == doctest::Approx(128'000.0));
  343. CHECK(Math::snapped(0.5, -1.0) == doctest::Approx(0));
  344. CHECK(Math::snapped(-0.5, -1.0) == doctest::Approx(-1.0));
  345. CHECK(Math::snapped(0.0, -1.0) == doctest::Approx(0));
  346. CHECK(Math::snapped(128'000.025, -1.0) == doctest::Approx(128'000.0));
  347. }
  348. TEST_CASE("[Math] larger_prime") {
  349. CHECK(Math::larger_prime(0) == 5);
  350. CHECK(Math::larger_prime(1) == 5);
  351. CHECK(Math::larger_prime(2) == 5);
  352. CHECK(Math::larger_prime(5) == 13);
  353. CHECK(Math::larger_prime(500) == 769);
  354. CHECK(Math::larger_prime(1'000'000) == 1'572'869);
  355. CHECK(Math::larger_prime(1'000'000'000) == 1'610'612'741);
  356. // The next prime is larger than `INT32_MAX` and is not present in the built-in prime table.
  357. ERR_PRINT_OFF;
  358. CHECK(Math::larger_prime(2'000'000'000) == 0);
  359. ERR_PRINT_ON;
  360. }
  361. TEST_CASE_TEMPLATE("[Math] fmod", T, float, double) {
  362. CHECK(Math::fmod((T)-2.0, (T)0.3) == doctest::Approx((T)-0.2));
  363. CHECK(Math::fmod((T)0.0, (T)0.3) == doctest::Approx((T)0.0));
  364. CHECK(Math::fmod((T)2.0, (T)0.3) == doctest::Approx((T)0.2));
  365. CHECK(Math::fmod((T)-2.0, (T)-0.3) == doctest::Approx((T)-0.2));
  366. CHECK(Math::fmod((T)0.0, (T)-0.3) == doctest::Approx((T)0.0));
  367. CHECK(Math::fmod((T)2.0, (T)-0.3) == doctest::Approx((T)0.2));
  368. }
  369. TEST_CASE_TEMPLATE("[Math] fposmod", T, float, double) {
  370. CHECK(Math::fposmod((T)-2.0, (T)0.3) == doctest::Approx((T)0.1));
  371. CHECK(Math::fposmod((T)0.0, (T)0.3) == doctest::Approx((T)0.0));
  372. CHECK(Math::fposmod((T)2.0, (T)0.3) == doctest::Approx((T)0.2));
  373. CHECK(Math::fposmod((T)-2.0, (T)-0.3) == doctest::Approx((T)-0.2));
  374. CHECK(Math::fposmod((T)0.0, (T)-0.3) == doctest::Approx((T)0.0));
  375. CHECK(Math::fposmod((T)2.0, (T)-0.3) == doctest::Approx((T)-0.1));
  376. }
  377. TEST_CASE_TEMPLATE("[Math] fposmodp", T, float, double) {
  378. CHECK(Math::fposmodp((T)-2.0, (T)0.3) == doctest::Approx((T)0.1));
  379. CHECK(Math::fposmodp((T)0.0, (T)0.3) == doctest::Approx((T)0.0));
  380. CHECK(Math::fposmodp((T)2.0, (T)0.3) == doctest::Approx((T)0.2));
  381. CHECK(Math::fposmodp((T)-2.0, (T)-0.3) == doctest::Approx((T)-0.5));
  382. CHECK(Math::fposmodp((T)0.0, (T)-0.3) == doctest::Approx((T)0.0));
  383. CHECK(Math::fposmodp((T)2.0, (T)-0.3) == doctest::Approx((T)0.2));
  384. }
  385. TEST_CASE("[Math] posmod") {
  386. CHECK(Math::posmod(-20, 3) == 1);
  387. CHECK(Math::posmod(0, 3) == 0);
  388. CHECK(Math::posmod(20, 3) == 2);
  389. CHECK(Math::posmod(-20, -3) == -2);
  390. CHECK(Math::posmod(0, -3) == 0);
  391. CHECK(Math::posmod(20, -3) == -1);
  392. }
  393. TEST_CASE("[Math] wrapi") {
  394. CHECK(Math::wrapi(-30, -20, 160) == 150);
  395. CHECK(Math::wrapi(30, -20, 160) == 30);
  396. CHECK(Math::wrapi(300, -20, 160) == 120);
  397. CHECK(Math::wrapi(300'000'000'000, -20, 160) == 120);
  398. }
  399. TEST_CASE_TEMPLATE("[Math] wrapf", T, float, double) {
  400. CHECK(Math::wrapf((T)-30.0, (T)-20.0, (T)160.0) == doctest::Approx((T)150.0));
  401. CHECK(Math::wrapf((T)30.0, (T)-2.0, (T)160.0) == doctest::Approx((T)30.0));
  402. CHECK(Math::wrapf((T)300.0, (T)-20.0, (T)160.0) == doctest::Approx((T)120.0));
  403. CHECK(Math::wrapf(300'000'000'000.0, -20.0, 160.0) == doctest::Approx((T)120.0));
  404. // float's precision is too low for 300'000'000'000.0, so we reduce it by a factor of 1000.
  405. CHECK(Math::wrapf((float)15'000'000.0, (float)-20.0, (float)160.0) == doctest::Approx((T)60.0));
  406. }
  407. TEST_CASE_TEMPLATE("[Math] fract", T, float, double) {
  408. CHECK(Math::fract((T)1.0) == doctest::Approx((T)0.0));
  409. CHECK(Math::fract((T)77.8) == doctest::Approx((T)0.8));
  410. CHECK(Math::fract((T)-10.1) == doctest::Approx((T)0.9));
  411. }
  412. TEST_CASE_TEMPLATE("[Math] pingpong", T, float, double) {
  413. CHECK(Math::pingpong((T)0.0, (T)0.0) == doctest::Approx((T)0.0));
  414. CHECK(Math::pingpong((T)1.0, (T)1.0) == doctest::Approx((T)1.0));
  415. CHECK(Math::pingpong((T)0.5, (T)2.0) == doctest::Approx((T)0.5));
  416. CHECK(Math::pingpong((T)3.5, (T)2.0) == doctest::Approx((T)0.5));
  417. CHECK(Math::pingpong((T)11.5, (T)2.0) == doctest::Approx((T)0.5));
  418. CHECK(Math::pingpong((T)-2.5, (T)2.0) == doctest::Approx((T)1.5));
  419. }
  420. TEST_CASE_TEMPLATE("[Math] deg_to_rad/rad_to_deg", T, float, double) {
  421. CHECK(Math::deg_to_rad((T)180.0) == doctest::Approx((T)Math_PI));
  422. CHECK(Math::deg_to_rad((T)-27.0) == doctest::Approx((T)-0.471239));
  423. CHECK(Math::rad_to_deg((T)Math_PI) == doctest::Approx((T)180.0));
  424. CHECK(Math::rad_to_deg((T)-1.5) == doctest::Approx((T)-85.94366927));
  425. }
  426. TEST_CASE_TEMPLATE("[Math] cubic_interpolate", T, float, double) {
  427. CHECK(Math::cubic_interpolate((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.0) == doctest::Approx((T)0.2));
  428. CHECK(Math::cubic_interpolate((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.25) == doctest::Approx((T)0.33125));
  429. CHECK(Math::cubic_interpolate((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.5) == doctest::Approx((T)0.5));
  430. CHECK(Math::cubic_interpolate((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.75) == doctest::Approx((T)0.66875));
  431. CHECK(Math::cubic_interpolate((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)1.0) == doctest::Approx((T)0.8));
  432. CHECK(Math::cubic_interpolate((T)20.2, (T)30.1, (T)-100.0, (T)32.0, (T)-50.0) == doctest::Approx((T)-6662732.3));
  433. CHECK(Math::cubic_interpolate((T)20.2, (T)30.1, (T)-100.0, (T)32.0, (T)-5.0) == doctest::Approx((T)-9356.3));
  434. CHECK(Math::cubic_interpolate((T)20.2, (T)30.1, (T)-100.0, (T)32.0, (T)0.0) == doctest::Approx((T)20.2));
  435. CHECK(Math::cubic_interpolate((T)20.2, (T)30.1, (T)-100.0, (T)32.0, (T)1.0) == doctest::Approx((T)30.1));
  436. CHECK(Math::cubic_interpolate((T)20.2, (T)30.1, (T)-100.0, (T)32.0, (T)4.0) == doctest::Approx((T)1853.2));
  437. }
  438. TEST_CASE_TEMPLATE("[Math] cubic_interpolate_angle", T, float, double) {
  439. CHECK(Math::cubic_interpolate_angle((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.0) == doctest::Approx((T)Math_PI * (1.0 / 6.0)));
  440. CHECK(Math::cubic_interpolate_angle((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.25) == doctest::Approx((T)0.973566));
  441. CHECK(Math::cubic_interpolate_angle((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.5) == doctest::Approx((T)Math_PI / 2.0));
  442. CHECK(Math::cubic_interpolate_angle((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.75) == doctest::Approx((T)2.16803));
  443. CHECK(Math::cubic_interpolate_angle((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)1.0) == doctest::Approx((T)Math_PI * (5.0 / 6.0)));
  444. }
  445. TEST_CASE_TEMPLATE("[Math] cubic_interpolate_in_time", T, float, double) {
  446. CHECK(Math::cubic_interpolate_in_time((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.0, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.0));
  447. CHECK(Math::cubic_interpolate_in_time((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.25, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.1625));
  448. CHECK(Math::cubic_interpolate_in_time((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.5, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.4));
  449. CHECK(Math::cubic_interpolate_in_time((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)0.75, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.6375));
  450. CHECK(Math::cubic_interpolate_in_time((T)0.2, (T)0.8, (T)0.0, (T)1.0, (T)1.0, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.8));
  451. }
  452. TEST_CASE_TEMPLATE("[Math] cubic_interpolate_angle_in_time", T, float, double) {
  453. CHECK(Math::cubic_interpolate_angle_in_time((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.0, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.0));
  454. CHECK(Math::cubic_interpolate_angle_in_time((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.25, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)0.494964));
  455. CHECK(Math::cubic_interpolate_angle_in_time((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.5, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)1.27627));
  456. CHECK(Math::cubic_interpolate_angle_in_time((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)0.75, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)2.07394));
  457. CHECK(Math::cubic_interpolate_angle_in_time((T)(Math_PI * (1.0 / 6.0)), (T)(Math_PI * (5.0 / 6.0)), (T)0.0, (T)Math_PI, (T)1.0, (T)0.5, (T)0.0, (T)1.0) == doctest::Approx((T)Math_PI * (5.0 / 6.0)));
  458. }
  459. TEST_CASE_TEMPLATE("[Math] bezier_interpolate", T, float, double) {
  460. CHECK(Math::bezier_interpolate((T)0.0, (T)0.2, (T)0.8, (T)1.0, (T)0.0) == doctest::Approx((T)0.0));
  461. CHECK(Math::bezier_interpolate((T)0.0, (T)0.2, (T)0.8, (T)1.0, (T)0.25) == doctest::Approx((T)0.2125));
  462. CHECK(Math::bezier_interpolate((T)0.0, (T)0.2, (T)0.8, (T)1.0, (T)0.5) == doctest::Approx((T)0.5));
  463. CHECK(Math::bezier_interpolate((T)0.0, (T)0.2, (T)0.8, (T)1.0, (T)0.75) == doctest::Approx((T)0.7875));
  464. CHECK(Math::bezier_interpolate((T)0.0, (T)0.2, (T)0.8, (T)1.0, (T)1.0) == doctest::Approx((T)1.0));
  465. }
  466. } // namespace TestMath
  467. #endif // TEST_MATH_FUNCS_H