mat2.rst 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871
  1. .. default-domain:: C
  2. mat2
  3. ====
  4. Header: cglm/mat2.h
  5. Table of contents (click to go):
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. Macros:
  8. 1. GLM_MAT2_IDENTITY_INIT
  9. #. GLM_MAT2_ZERO_INIT
  10. #. GLM_MAT2_IDENTITY
  11. #. GLM_MAT2_ZERO
  12. Functions:
  13. 1. :c:func:`glm_mat2_make`
  14. #. :c:func:`glm_mat2_copy`
  15. #. :c:func:`glm_mat2_identity`
  16. #. :c:func:`glm_mat2_identity_array`
  17. #. :c:func:`glm_mat2_zero`
  18. #. :c:func:`glm_mat2_mul`
  19. #. :c:func:`glm_mat2_mulv`
  20. #. :c:func:`glm_mat2_transpose_to`
  21. #. :c:func:`glm_mat2_transpose`
  22. #. :c:func:`glm_mat2_scale`
  23. #. :c:func:`glm_mat2_inv`
  24. #. :c:func:`glm_mat2_swap_col`
  25. #. :c:func:`glm_mat2_swap_row`
  26. #. :c:func:`glm_mat2_det`
  27. #. :c:func:`glm_mat2_trace`
  28. #. :c:func:`glm_mat2_rmc`
  29. Represented
  30. ~~~~~~~~~~~
  31. .. csv-table:: mat2x2
  32. :header: "", "column 1", "column 2"
  33. "row 1", "m00", "m10"
  34. "row 2", "m01", "m11"
  35. Functions documentation
  36. ~~~~~~~~~~~~~~~~~~~~~~~
  37. .. c:function:: void glm_mat2_make(const float * __restrict src, mat2 dest)
  38. Create mat2 (dest) from pointer (src).
  39. .. note:: **@src** must contain at least 4 elements.
  40. Parameters:
  41. | *[in]* **src** pointer to an array of floats (left)
  42. | *[out]* **dest** destination (result, mat2)
  43. .. note:: Mathematical explanation
  44. .. csv-table:: float array (1x4) **(src)**
  45. :header: "", "column 1"
  46. "row 1", "v0"
  47. "row 2", "v1"
  48. "row 3", "v2"
  49. "row 4", "v3"
  50. .. csv-table:: mat2 **(dest)**
  51. :header: "", "column 1", "column 2"
  52. "row 1", "v0", "v2"
  53. "row 2", "v1", "v3"
  54. .. note:: Example
  55. .. code-block:: c
  56. mat2 dest = GLM_MAT2_ZERO_INIT;
  57. float src[4] = { 1.00, 5.00, 8.00, 11.00 };
  58. glm_mat2_make(src, dest);
  59. .. csv-table:: float array (1x4) **(src)**
  60. :header: "", "column 1"
  61. "row 1", "1.00"
  62. "row 2", "5.00"
  63. "row 3", "8.00"
  64. "row 4", "11.00"
  65. .. csv-table:: mat2 **(dest)** Before
  66. :header: "", "column 1", "column 2"
  67. "row 1", "0.00", "0.00"
  68. "row 2", "0.00", "0.00"
  69. .. csv-table:: mat2 **(dest)** After
  70. :header: "", "column 1", "column 2"
  71. "row 1", "1.00", "8.00"
  72. "row 2", "5.00", "11.00"
  73. .. c:function:: void glm_mat2_copy(mat2 mat, mat2 dest)
  74. Copy mat2 (mat) to mat2 (dest).
  75. Parameters:
  76. | *[in]* **mat** mat2 (left,src)
  77. | *[out]* **dest** destination (result, mat2)
  78. .. note:: Mathematical explanation
  79. .. csv-table:: mat2 **(mat)**
  80. :header: "", "column 1", "column 2"
  81. "row 1", "m00", "m10"
  82. "row 2", "m01", "m11"
  83. .. csv-table:: mat2 **(dest)**
  84. :header: "", "column 1", "column 2"
  85. "row 1", "m00", "m10"
  86. "row 2", "m01", "m11"
  87. .. note:: Example
  88. .. code-block:: c
  89. mat2 mat = {{3.00,4.00},{7.00,8.00}};
  90. mat2 dest = GLM_MAT2_ZERO_INIT;
  91. glm_mat2_copy(mat, dest);
  92. .. csv-table:: mat2 **(mat)**
  93. :header: "", "column 1", "column 2"
  94. "row 1", "3.00", "7.00"
  95. "row 2", "4.00", "8.00"
  96. .. csv-table:: mat2 **(dest)** Before
  97. :header: "", "column 1", "column 2"
  98. "row 1", "0.00", "0.00"
  99. "row 2", "0.00", "0.00"
  100. .. csv-table:: mat2 **(dest)** After
  101. :header: "", "column 1", "column 2"
  102. "row 1", "3.00", "7.00"
  103. "row 2", "4.00", "8.00"
  104. .. c:function:: void glm_mat2_identity(mat2 m)
  105. | Copy a mat2 identity to mat2 **(m)**, or makes mat2 **(m)** an identity.
  106. |
  107. | The same thing may be achieved with either of bellow methods,
  108. | but it is more easy to do that with this func especially for members
  109. | e.g. ``glm_mat2_identity(aStruct->aMatrix);``.
  110. .. code-block:: c
  111. glm_mat2_copy(GLM_MAT2_IDENTITY, m);
  112. // or
  113. mat2 mat = GLM_MAT2_IDENTITY_INIT;
  114. Parameters:
  115. | *[in, out]* **m** mat2 (src, dest)
  116. .. note:: Mathematical explanation
  117. .. csv-table:: mat2 **(m)**
  118. :header: "", "column 1", "column 2"
  119. "row 1", "m00", "m10"
  120. "row 2", "m01", "m11"
  121. .. csv-table:: mat2 **(m)**
  122. :header: "", "column 1", "column 2"
  123. "row 1", "1.00", "0.00"
  124. "row 2", "0.00", "1.00"
  125. .. note:: Example
  126. .. code-block:: c
  127. mat2 m = {{3.00,4.00},{7.00,8.00}};
  128. glm_mat2_identity(m);
  129. .. csv-table:: mat2 **(m)**
  130. :header: "", "column 1", "column 2"
  131. "row 1", "3.00", "7.00"
  132. "row 2", "4.00", "8.00"
  133. .. csv-table:: mat2 **(m)**
  134. :header: "", "column 1", "column 2"
  135. "row 1", "1.00", "0.00"
  136. "row 2", "0.00", "1.00"
  137. .. c:function:: void glm_mat2_identity_array(mat2 * __restrict mats, size_t count)
  138. Given an array of mat2's **(mats)** make each matrix an identity matrix.
  139. Parameters:
  140. | *[in, out]* **mats** Array of mat2's (must be aligned (16/32) if alignment is not disabled)
  141. | *[in]* **count** Array size of ``mats`` or number of matrices
  142. .. note:: Mathematical explanation
  143. .. csv-table:: mat2 **(mats[index])**
  144. :header: "", "column 1", "column 2"
  145. "row 1", "m00", "m10"
  146. "row 2", "m01", "m11"
  147. .. csv-table:: mat2 **(mats[index])**
  148. :header: "", "column 1", "column 2"
  149. "row 1", "1.00", "0.00"
  150. "row 2", "0.00", "1.00"
  151. .. note:: Example
  152. .. code-block:: c
  153. size_t count = 3;
  154. mat2 matrices[count] = {
  155. {{1.00,2.00},{5.00,6.00}},
  156. {{3.00,4.00},{7.00,8.00}},
  157. {{5.00,6.00},{9.00,10.00}},
  158. };
  159. glm_mat2_identity_array(matrices, count);
  160. .. csv-table:: mat2 **(mats[0])** Before
  161. :header: "", "column 1", "column 2"
  162. "row 1", "1.00", "5.00"
  163. "row 2", "2.00", "6.00"
  164. .. csv-table:: mat2 **(mats[0])** After
  165. :header: "", "column 1", "column 2"
  166. "row 1", "1.00", "0.00"
  167. "row 2", "0.00", "1.00"
  168. .. csv-table:: mat2 **(mats[1])** Before
  169. :header: "", "column 1", "column 2"
  170. "row 1", "3.00", "7.00"
  171. "row 2", "4.00", "8.00"
  172. .. csv-table:: mat2 **(mats[1])** After
  173. :header: "", "column 1", "column 2"
  174. "row 1", "1.00", "0.00"
  175. "row 2", "0.00", "1.00"
  176. .. csv-table:: mat2 **(mats[2])** Before
  177. :header: "", "column 1", "column 2"
  178. "row 1", "5.00", "9.00"
  179. "row 2", "6.00", "10.00"
  180. .. csv-table:: mat2 **(mats[2])** After
  181. :header: "", "column 1", "column 2"
  182. "row 1", "1.00", "0.00"
  183. "row 2", "0.00", "1.00"
  184. .. c:function:: void glm_mat2_zero(mat2 m)
  185. Zero out the mat2 (m).
  186. Parameters:
  187. | *[in, out]* **m** mat2 (src, dest)
  188. .. note:: Mathematical explanation
  189. .. csv-table:: mat2 **(m)**
  190. :header: "", "column 1", "column 2"
  191. "row 1", "m00", "m10"
  192. "row 2", "m01", "m11"
  193. .. csv-table:: mat2 **(m)**
  194. :header: "", "column 1", "column 2"
  195. "row 1", "0.00", "0.00"
  196. "row 2", "0.00", "0.00"
  197. .. note:: Example
  198. .. code-block:: c
  199. mat2 m = {{19.00,5.00},{2.00,4.00}};
  200. glm_mat2_zero(m);
  201. .. csv-table:: mat2 **(m)** Before
  202. :header: "", "column 1", "column 2"
  203. "row 1", "19.00", "2.00"
  204. "row 2", "5.00", "4.00"
  205. .. csv-table:: mat2 **(m)** After
  206. :header: "", "column 1", "column 2"
  207. "row 1", "0.00", "0.00"
  208. "row 2", "0.00", "0.00"
  209. .. c:function:: void glm_mat2_mul(mat2 m1, mat2 m2, mat2 dest)
  210. | Multiply mat2 (m1) by mat2 (m2) and store in mat2 (dest).
  211. |
  212. | m1, m2 and dest matrices can be same matrix, it is possible to write this:
  213. .. code-block:: c
  214. mat2 m = GLM_MAT2_IDENTITY_INIT;
  215. glm_mat2_mul(m, m, m);
  216. Parameters:
  217. | *[in]* **m1** mat2 (left)
  218. | *[in]* **m2** mat2 (right)
  219. | *[out]* **dest** destination (result, mat2)
  220. .. note:: Mathematical explanation
  221. .. csv-table:: mat2 **(m1)**
  222. :header: "", "column 1", "column 2"
  223. "row 1", "a00", "a10"
  224. "row 2", "a01", "a11"
  225. .. csv-table:: mat2 **(m2)**
  226. :header: "", "column 1", "column 2"
  227. "row 1", "b00", "b10"
  228. "row 2", "b01", "b11"
  229. .. csv-table:: mat2 **(dest)**
  230. :header: "", "column 1", "column 2"
  231. "row 1", "a00 * b00 + a10 * b01", "a00 * b10 + a10 * b11"
  232. "row 2", "a01 * b00 + a11 * b01", "a01 * b10 + a11 * b11"
  233. .. note:: Example
  234. .. code-block:: c
  235. mat2 m = {{19.00,5.00},{2.00,4.00}};
  236. glm_mat2_mul(m, m, m);
  237. .. csv-table:: mat2 **(m1)**
  238. :header: "", "column 1", "column 2"
  239. "row 1", "19.00", "2.00"
  240. "row 2", "5.00", "4.00"
  241. .. csv-table:: mat2 **(m2)**
  242. :header: "", "column 1", "column 2"
  243. "row 1", "19.00", "2.00"
  244. "row 2", "5.00", "4.00"
  245. .. csv-table:: mat2 **(dest)**
  246. :header: "", "column 1", "column 2"
  247. "row 1", "**371.00** = 19.00 * 19.00 + 2.00 * 5.00", "**46.00** = 19.00 * 2.00 + 2.00 * 4.00"
  248. "row 2", "**115.00** = 5.00 * 19.00 + 4.00 * 5.00", "**18.00** = 5.00 * 2.00 + 4.00 * 4.00"
  249. .. c:function:: void glm_mat2_mulv(mat2 m, vec2 v, vec2 dest)
  250. Multiply mat2 (m) by vec2 (v) and store in vec2 (dest).
  251. Parameters:
  252. | *[in]* **m** mat2 (left)
  253. | *[in]* **v** vec2 (right, column vector)
  254. | *[out]* **dest** destination (result, column vector)
  255. .. note:: Mathematical explanation
  256. .. csv-table:: mat2 **(m)**
  257. :header: "", "column 1", "column 2"
  258. "row 1", "m00", "m10"
  259. "row 2", "m01", "m11"
  260. .. csv-table:: column vec2 (1x2) **(v)**
  261. :header: "", "column 1"
  262. "row 1", "v0"
  263. "row 2", "v1"
  264. .. csv-table:: column vec2 (1x2) **(dest)**
  265. :header: "", "column 1"
  266. "row 1", "m00 * v0 + m10 * v1"
  267. "row 2", "m01 * v0 + m11 * v1"
  268. .. note:: Example
  269. .. code-block:: c
  270. vec2 dest;
  271. vec2 v = {33.00,55.00};
  272. mat2 m = {{1.00,2.00},{3.00,4.00}};
  273. glm_mat2_mulv(m, v, dest);
  274. .. csv-table:: mat2 **(m)**
  275. :header: "", "column 1", "column 2"
  276. "row 1", "1.00", "3.00"
  277. "row 2", "2.00", "4.00"
  278. .. csv-table:: column vec2 **(v)**
  279. :header: "", "column 1"
  280. "row 1", "33.00"
  281. "row 2", "55.00"
  282. .. csv-table:: vec2 **(dest)** Result
  283. :header: "", "column 1"
  284. "row 1", "**198.00** = 1.00 * 33.00 + 3.00 * 55.00"
  285. "row 2", "**286.00** = 2.00 * 33.00 + 4.00 * 55.00"
  286. .. c:function:: void glm_mat2_transpose_to(mat2 mat, mat2 dest)
  287. Transpose mat2 (mat) and store in mat2 (dest).
  288. Parameters:
  289. | *[in]* **mat** mat2 (left,src)
  290. | *[out]* **dest** destination (result, mat2)
  291. .. note:: Mathematical explanation
  292. .. csv-table:: mat2 **(mat)**
  293. :header: "", "column 1", "column 2"
  294. "row 1", "m00", "m10"
  295. "row 2", "m01", "m11"
  296. .. csv-table:: mat2 **(dest)**
  297. :header: "", "column 1", "column 2"
  298. "row 1", "m00", "m01"
  299. "row 2", "m10", "m11"
  300. .. note:: Example
  301. .. code-block:: c
  302. mat2 mat = {{1.00,2.00},{3.00,4.00}};
  303. mat2 dest = GLM_MAT2_ZERO_INIT;
  304. glm_mat2_transpose_to(mat, dest);
  305. .. csv-table:: mat2 **(mat)**
  306. :header: "", "column 1", "column 2"
  307. "row 1", "1.00", "3.00"
  308. "row 2", "2.00", "4.00"
  309. .. csv-table:: mat2 **(dest)** Before
  310. :header: "", "column 1", "column 2"
  311. "row 1", "0.00", "0.00"
  312. "row 2", "0.00", "0.00"
  313. .. csv-table:: mat2 **(dest)** After
  314. :header: "", "column 1", "column 2"
  315. "row 1", "1.00", "2.00"
  316. "row 2", "3.00", "4.00"
  317. .. c:function:: void glm_mat2_transpose(mat2 m)
  318. Transpose mat2 (m) and store result in the same matrix.
  319. Parameters:
  320. | *[in, out]* **m** mat2 (src, dest)
  321. .. note:: Mathematical explanation
  322. .. csv-table:: mat2 **(m)** src
  323. :header: "", "column 1", "column 2"
  324. "row 1", "m00", "m10"
  325. "row 2", "m01", "m11"
  326. .. csv-table:: mat2 **(m)** dest
  327. :header: "", "column 1", "column 2"
  328. "row 1", "m00", "m01"
  329. "row 2", "m10", "m11"
  330. .. note:: Example
  331. .. code-block:: c
  332. mat2 m = {{1.00,2.00},{3.00,4.00}};
  333. glm_mat2_transpose(m);
  334. .. csv-table:: mat2 **(m)** Before
  335. :header: "", "column 1", "column 2"
  336. "row 1", "1.00", "3.00"
  337. "row 2", "2.00", "4.00"
  338. .. csv-table:: mat2 **(m)** After
  339. :header: "", "column 1", "column 2"
  340. "row 1", "1.00", "2.00"
  341. "row 2", "3.00", "4.00"
  342. .. c:function:: void glm_mat2_scale(mat2 m, float s)
  343. Multiply mat2 (m) by scalar constant (s).
  344. Parameters:
  345. | *[in, out]* **m** mat2 (src, dest)
  346. | *[in]* **s** float (scalar)
  347. .. note:: Mathematical explanation
  348. .. csv-table:: mat2 **(m)**
  349. :header: "", "column 1", "column 2"
  350. "row 1", "m00 * s", "m10 * s"
  351. "row 2", "m01 * s", "m11 * s"
  352. .. note:: Example
  353. .. code-block:: c
  354. float s = 3.00f;
  355. mat2 m = {{1.00,2.00},{3.00,4.00}};
  356. glm_mat2_scale(m, s);
  357. .. csv-table:: mat2 **(m)** Before
  358. :header: "", "column 1", "column 2"
  359. "row 1", "1.00", "3.00"
  360. "row 2", "2.00", "4.00"
  361. .. csv-table:: mat2 **(m)** After
  362. :header: "", "column 1", "column 2"
  363. "row 1", "**3.00** = 1.00 * 3.00", "**9.00** = 3.00 * 3.00"
  364. "row 2", "**6.00** = 2.00 * 3.00", "**12.00** = 4.00 * 3.00"
  365. .. c:function:: void glm_mat2_inv(mat2 mat, mat2 dest)
  366. Inverse mat2 (mat) and store in mat2 (dest).
  367. Parameters:
  368. | *[in]* **mat** mat2 (left,src)
  369. | *[out]* **dest** destination (result, inverse mat2)
  370. .. note:: Mathematical explanation
  371. .. csv-table:: mat2 **(mat)**
  372. :header: "", "column 1", "column 2"
  373. "row 1", "m00", "m10"
  374. "row 2", "m01", "m11"
  375. .. list-table:: mat2 **(dest)**
  376. :header-rows: 1
  377. * -
  378. - column 1
  379. - column 2
  380. * - row 1
  381. - m11 * (1.0f / (m00 * m11 - m01 * m10))
  382. - -m10 * (1.0f / (m00 * m11 - m01 * m10))
  383. * - row 2
  384. - -m01 * (1.0f / (m00 * m11 - m01 * m10))
  385. - m00 * (1.0f / (m00 * m11 - m01 * m10))
  386. .. note:: Example
  387. .. code-block:: c
  388. mat2 dest = GLM_MAT2_ZERO_INIT;
  389. mat2 mat = {{1.00,2.00},{3.00,4.00}};
  390. glm_mat2_inv(mat, dest);
  391. .. csv-table:: mat2 **(mat)** Before
  392. :header: "", "column 1", "column 2"
  393. "row 1", "1.00", "3.00"
  394. "row 2", "2.00", "4.00"
  395. .. list-table:: mat2 **(dest)** After
  396. :header-rows: 1
  397. * -
  398. - column 1
  399. - column 2
  400. * - row 1
  401. - **-2.00** = 4.00 * (1.00 / (1.00 * 4.00 - 2.00 * 3.00))
  402. - **1.50** = -3.00 * (1.00 / (1.00 * 4.00 - 2.00 * 3.00))
  403. * - row 2
  404. - **1.00** = -2.00 * (1.00 / (1.00 * 4.00 - 2.00 * 3.00))
  405. - **-0.50** = 1.00 * (1.00 / (1.00 * 4.00 - 2.00 * 3.00))
  406. .. c:function:: void glm_mat2_swap_col(mat2 mat, int col1, int col2)
  407. Swap two columns in mat2 (mat) and store in same matrix.
  408. Parameters:
  409. | *[in, out]* **mat** mat2 (src, dest)
  410. | *[in]* **col1** Column 1 array index
  411. | *[in]* **col2** Column 2 array index
  412. .. note:: Mathematical explanation
  413. .. csv-table:: mat2 **(mat)** Before
  414. :header: "", "column 1", "column 2"
  415. "row 1", "m00", "m10"
  416. "row 2", "m01", "m11"
  417. .. code-block:: c
  418. glm_mat2_swap_col(mat, 0, 1);
  419. .. csv-table:: mat2 **(mat)** After
  420. :header: "", "column 1", "column 2"
  421. "row 1", "m10", "m00"
  422. "row 2", "m11", "m01"
  423. .. note:: Example
  424. .. code-block:: c
  425. mat2 mat = {{76.00,5.00},{3.00,6.00}};
  426. glm_mat2_swap_col(mat, 0, 1);
  427. .. csv-table:: mat2 **(mat)** Before
  428. :header: "", "column 1", "column 2"
  429. "row 1", "76.00", "3.00"
  430. "row 2", "5.00", "6.00"
  431. .. csv-table:: mat2 **(mat)** After
  432. :header: "", "column 1", "column 2"
  433. "row 1", "3.00", "76.00"
  434. "row 2", "6.00", "5.00"
  435. .. c:function:: void glm_mat2_swap_row(mat2 mat, int row1, int row2)
  436. Swap two rows in mat2 (mat) and store in same matrix.
  437. Parameters:
  438. | *[in, out]* **mat** mat2 (src, dest)
  439. | *[in]* **row1** Row 1 array index
  440. | *[in]* **row2** Row 2 array index
  441. .. note:: Mathematical explanation
  442. .. csv-table:: mat2 **(mat)** Before
  443. :header: "", "column 1", "column 2"
  444. "row 1", "m00", "m10"
  445. "row 2", "m01", "m11"
  446. .. code-block:: c
  447. glm_mat2_swap_row(mat, 0, 1);
  448. .. csv-table:: mat2 **(mat)** After
  449. :header: "", "column 1", "column 2"
  450. "row 1", "m01", "m11"
  451. "row 2", "m00", "m10"
  452. .. note:: Example
  453. .. code-block:: c
  454. mat2 mat = {{76.00,5.00},{3.00,6.00}};
  455. glm_mat2_swap_row(mat, 0, 1);
  456. .. csv-table:: mat2 **(mat)** Before
  457. :header: "", "column 1", "column 2"
  458. "row 1", "76.00", "3.00"
  459. "row 2", "5.00", "6.00"
  460. .. csv-table:: mat2 **(mat)** After
  461. :header: "", "column 1", "column 2"
  462. "row 1", "5.00", "6.00"
  463. "row 2", "76.00", "3.00"
  464. .. c:function:: float glm_mat2_det(mat2 m)
  465. Returns mat2 determinant.
  466. Parameters:
  467. | *[in]* **m** mat2 (src)
  468. Returns:
  469. | mat2 determinant (float)
  470. .. note:: Mathematical explanation
  471. .. csv-table:: mat2 **(m)**
  472. :header: "", "column 1", "column 2"
  473. "row 1", "m00", "m10"
  474. "row 2", "m01", "m11"
  475. .. code-block:: c
  476. m00 * m11 - m10 * m01;
  477. .. note:: Example
  478. .. code-block:: c
  479. mat2 m = {{76.00,5.00},{3.00,6.00}};
  480. glm_mat2_det(m);
  481. .. csv-table:: mat2 **(m)**
  482. :header: "", "column 1", "column 2"
  483. "row 1", "76.00", "3.00"
  484. "row 2", "5.00", "6.00"
  485. .. code-block:: c
  486. 441.00 = 76.00 * 6.00 - 3.00 * 5.00;
  487. .. c:function:: void glm_mat2_trace(mat2 m)
  488. | Returns trace of matrix. Which is:
  489. |
  490. | The sum of the elements on the main diagonal from
  491. | upper left corner to the bottom right corner.
  492. Parameters:
  493. | *[in]* **m** mat2 (src)
  494. Returns:
  495. | mat2 trace (float)
  496. .. note:: Mathematical explanation
  497. .. csv-table:: mat2 **(m)**
  498. :header: "", "column 1", "column 2"
  499. "row 1", "m00", "m10"
  500. "row 2", "m01", "m11"
  501. .. code-block:: c
  502. m00 + m11;
  503. .. note:: Example
  504. .. code-block:: c
  505. mat2 m = {{76.00,5.00},{3.00,6.00}};
  506. glm_mat2_trace(m);
  507. .. csv-table:: mat2 **(m)**
  508. :header: "", "column 1", "column 2"
  509. "row 1", "76.00", "3.00"
  510. "row 2", "5.00", "6.00"
  511. .. code-block:: c
  512. 82.00 = 76.00 + 6.00;
  513. .. c:function:: float glm_mat2_rmc(vec2 r, mat2 m, vec2 c)
  514. | Helper for R (row vector) * M (matrix) * C (column vector)
  515. | **rmc** stands for **Row** * **Matrix** * **Column**
  516. | the result is scalar because M * C = ResC (1x2, column vector),
  517. | then if you take the dot_product(R (2x1), ResC (1x2)) = scalar value.
  518. Parameters:
  519. | *[in]* **r** vec2 (2x1, row vector)
  520. | *[in]* **m** mat2 (2x2, matrix)
  521. | *[in]* **c** vec2 (1x2, column vector)
  522. Returns:
  523. | Scalar value (float, 1x1)
  524. .. note:: Mathematical explanation
  525. .. csv-table:: row vec2 (2x1) **(r)**
  526. :header: "", "column 1", "column 2"
  527. "row 1", "a00", "a10"
  528. .. csv-table:: mat2 **(m)**
  529. :header: "", "column 1", "column 2"
  530. "row 1", "b00", "b10"
  531. "row 2", "b01", "b11"
  532. .. csv-table:: column vec2 (1x2) **(c)**
  533. :header: "", "column 1"
  534. "row 1", "c00"
  535. "row 2", "c01"
  536. .. code-block:: c
  537. M * C = C (column vector)
  538. dot_product(R, C)
  539. .. csv-table:: column vec2 (1x2) **(C)**
  540. :header: "", "column 1"
  541. "row 1", "b00 * c00 + b10 * c01"
  542. "row 2", "b01 * c00 + b11 * c01"
  543. .. csv-table:: float **(scalar)**
  544. :header: "", "column 1"
  545. "row 1", "a00 * (b00 * c00 + b10 * c01) + a10 * (b01 * c00 + b11 * c01)"
  546. .. note:: Example
  547. .. code-block:: c
  548. vec2 r = {8.00,4.00};
  549. vec2 c = {7.00,2.00};
  550. mat2 m = {{5.00,9.00},{3.00,6.00}};
  551. glm_mat2_rmc(r, m, c);
  552. .. csv-table:: row vec2 (2x1) **(r)**
  553. :header: "", "column 1", "column 2"
  554. "row 1", "8.00", "4.00"
  555. .. csv-table:: mat2 **(m)**
  556. :header: "", "column 1", "column 2"
  557. "row 1", "5.00", "3.00"
  558. "row 2", "9.00", "6.00"
  559. .. csv-table:: column vec2 (1x2) **(c)**
  560. :header: "", "column 1"
  561. "row 1", "7.00"
  562. "row 2", "2.00"
  563. .. csv-table:: column vec2 (1x2) **(C)**
  564. :header: "", "column 1"
  565. "row 1", "**41.00** = 5.00 * 7.00 + 3.00 * 2.00"
  566. "row 2", "**75.00** = 9.00 * 7.00 + 6.00 * 2.00"
  567. .. csv-table:: float (1x1) **(scalar)**
  568. :header: "", "column 1"
  569. "row 1", "**628.00** = 8.00 * 41.00 + 4.00 * 75.00"