| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 461b694 commit 33935ab
4 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -19,28 +19,28 @@ | |||
| 19 | 19 | \defgroup arith_func_add add | |
| 20 | 20 | \ingroup arith_mat | |
| 21 | 21 | ||
| 22 | - Add two arrays. | ||
| 22 | + Elementwise addition | ||
| 23 | 23 | ||
| 24 | 24 | ||
| 25 | 25 | ||
| 26 | 26 | \defgroup arith_func_sub sub | |
| 27 | 27 | \ingroup arith_mat | |
| 28 | 28 | ||
| 29 | - Subtract one array from another array. | ||
| 29 | + Elementwise subtraction | ||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | 33 | \defgroup arith_func_mul mul | |
| 34 | 34 | \ingroup arith_mat | |
| 35 | 35 | ||
| 36 | - Multiply two arrays. | ||
| 36 | + Elementwise multiply | ||
| 37 | 37 | ||
| 38 | 38 | ||
| 39 | 39 | ||
| 40 | 40 | \defgroup arith_func_div div | |
| 41 | 41 | \ingroup arith_mat | |
| 42 | 42 | ||
| 43 | - Divide one array by another array. | ||
| 43 | + Elementwise division | ||
| 44 | 44 | ||
| 45 | 45 | ||
| 46 | 46 | ||
@@ -189,14 +189,14 @@ Cast an array from one type to another. | |||
| 189 | 189 | \defgroup arith_func_min min | |
| 190 | 190 | \ingroup numeric_mat | |
| 191 | 191 | ||
| 192 | - Find the elementwise minimum between two arrays. | ||
| 192 | + Returns the elementwise minimum between two arrays. | ||
| 193 | 193 | ||
| 194 | 194 | ||
| 195 | 195 | ||
| 196 | 196 | \defgroup arith_func_max max | |
| 197 | 197 | \ingroup numeric_mat | |
| 198 | 198 | ||
| 199 | - Find the elementwise maximum between two arrays. | ||
| 199 | + Returns the elementwise maximum between two arrays. | ||
| 200 | 200 | ||
| 201 | 201 | ||
| 202 | 202 | ||
@@ -210,7 +210,7 @@ Clamp an array between an upper and a lower limit. | |||
| 210 | 210 | \defgroup arith_func_rem rem | |
| 211 | 211 | \ingroup numeric_mat | |
| 212 | 212 | ||
| 213 | - Find the remainder of a division. | ||
| 213 | + Calculate the remainder of a division. | ||
| 214 | 214 | ||
| 215 | 215 | \copydoc arith_real_only | |
| 216 | 216 | ||
@@ -219,7 +219,7 @@ Find the remainder of a division. | |||
| 219 | 219 | \defgroup arith_func_mod mod | |
| 220 | 220 | \ingroup numeric_mat | |
| 221 | 221 | ||
| 222 | - Find the modulus. | ||
| 222 | + Calculate the modulus. | ||
| 223 | 223 | ||
| 224 | 224 | \copydoc arith_real_only | |
| 225 | 225 | ||
@@ -228,20 +228,20 @@ Find the modulus. | |||
| 228 | 228 | \defgroup arith_func_abs abs | |
| 229 | 229 | \ingroup numeric_mat | |
| 230 | 230 | ||
| 231 | - Find the absolute value. | ||
| 231 | + Calculate the absolute value. | ||
| 232 | 232 | ||
| 233 | 233 | ||
| 234 | 234 | \defgroup arith_func_arg arg | |
| 235 | 235 | \ingroup numeric_mat | |
| 236 | 236 | ||
| 237 | - Find the phase angle (in radians) of a complex array. | ||
| 237 | + Calculate the phase angle (in radians) of a complex array. | ||
| 238 | 238 | ||
| 239 | 239 | ||
| 240 | 240 | ||
| 241 | 241 | \defgroup arith_func_sign sign | |
| 242 | 242 | \ingroup numeric_mat | |
| 243 | 243 | ||
| 244 | - Find the sign of elements in an array. | ||
| 244 | + Return the sign of elements in an array. | ||
| 245 | 245 | ||
| 246 | 246 | \copydoc arith_real_only | |
| 247 | 247 | ||
@@ -268,7 +268,7 @@ Truncate numbers to nearest integer. | |||
| 268 | 268 | \defgroup arith_func_floor floor | |
| 269 | 269 | \ingroup numeric_mat | |
| 270 | 270 | ||
| 271 | - Round to the integer less than or equal to the magnitude of the input value. | ||
| 271 | + Rounds down to the greatest integer less than or equal to x. | ||
| 272 | 272 | ||
| 273 | 273 | \copydoc arith_real_only | |
| 274 | 274 | ||
@@ -277,7 +277,7 @@ Round to the integer less than or equal to the magnitude of the input value. | |||
| 277 | 277 | \defgroup arith_func_ceil ceil | |
| 278 | 278 | \ingroup numeric_mat | |
| 279 | 279 | ||
| 280 | - Round to the integer greater than or equal to the magnitude of the input value. | ||
| 280 | + Rounds up to the least integer greater than or equal to x. | ||
| 281 | 281 | ||
| 282 | 282 | \copydoc arith_real_only | |
| 283 | 283 | ||
@@ -286,7 +286,7 @@ Round to the integer greater than or equal to the magnitude of the input value. | |||
| 286 | 286 | \defgroup arith_func_hypot hypot | |
| 287 | 287 | \ingroup numeric_mat | |
| 288 | 288 | ||
| 289 | - Find the length of the hypotenuse of two inputs. | ||
| 289 | + Evaluate the length of the hypotenuse of two inputs. | ||
| 290 | 290 | ||
| 291 | 291 | \copydoc arith_real_only | |
| 292 | 292 | ||
@@ -398,28 +398,28 @@ __Examples:__ | |||
| 398 | 398 | \defgroup arith_func_real real | |
| 399 | 399 | \ingroup complex_mat | |
| 400 | 400 | ||
| 401 | - Find the real part of a complex array. | ||
| 401 | + Returns the real part of a complex array. | ||
| 402 | 402 | ||
| 403 | 403 | ||
| 404 | 404 | ||
| 405 | 405 | \defgroup arith_func_imag imag | |
| 406 | 406 | \ingroup complex_mat | |
| 407 | 407 | ||
| 408 | - Find the imaginary part of a complex array. | ||
| 408 | + Returns the imaginary part of a complex array. | ||
| 409 | 409 | ||
| 410 | 410 | ||
| 411 | 411 | ||
| 412 | 412 | \defgroup arith_func_conjg conjg | |
| 413 | 413 | \ingroup complex_mat | |
| 414 | 414 | ||
| 415 | - Find the complex conjugate of an input array. | ||
| 415 | + Evaluate the complex conjugate of an input array. | ||
| 416 | 416 | ||
| 417 | 417 | ||
| 418 | 418 | ||
| 419 | 419 | \defgroup arith_func_root root | |
| 420 | 420 | \ingroup explog_mat | |
| 421 | 421 | ||
| 422 | - Find the nth root. | ||
| 422 | + Evaluate the nth root. | ||
| 423 | 423 | ||
| 424 | 424 | ||
| 425 | 425 | ||
@@ -513,14 +513,14 @@ Evaluate the base 2 logarithm. | |||
| 513 | 513 | \defgroup arith_func_sqrt sqrt | |
| 514 | 514 | \ingroup explog_mat | |
| 515 | 515 | ||
| 516 | - Find the square root. | ||
| 516 | + Evaluate the square root. | ||
| 517 | 517 | ||
| 518 | 518 | ||
| 519 | 519 | ||
| 520 | 520 | \defgroup arith_func_rsqrt rsqrt | |
| 521 | 521 | \ingroup explog_mat | |
| 522 | 522 | ||
| 523 | - Find the reciprocal square root. | ||
| 523 | + Evaluate the reciprocal square root. | ||
| 524 | 524 | ||
| 525 | 525 | \f[ \frac{1}{\sqrt{x}} \f] | |
| 526 | 526 | ||
@@ -531,7 +531,7 @@ Find the reciprocal square root. | |||
| 531 | 531 | \defgroup arith_func_cbrt cbrt | |
| 532 | 532 | \ingroup explog_mat | |
| 533 | 533 | ||
| 534 | - Find the cube root. | ||
| 534 | + Evaluate the cube root. | ||
| 535 | 535 | ||
| 536 | 536 | \copydoc arith_real_only | |
| 537 | 537 | ||
@@ -540,7 +540,7 @@ Find the cube root. | |||
| 540 | 540 | \defgroup arith_func_factorial factorial | |
| 541 | 541 | \ingroup explog_mat | |
| 542 | 542 | ||
| 543 | - Find the factorial. | ||
| 543 | + Evaluate the factorial. | ||
| 544 | 544 | ||
| 545 | 545 | \copydoc arith_real_only | |
| 546 | 546 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -52,11 +52,19 @@ and restrictions. | |||
| 52 | 52 | ||
| 53 | 53 | \brief Transpose a matrix. | |
| 54 | 54 | ||
| 55 | - Reverse or permute the dimensions of an array; returns the modified array. For an array a with two dimensions, `transpose(a)` gives the matrix transpose. For an array with more than two dimensions, the first two dimensions are transposed across higher dimensions. | ||
| 56 | - | ||
| 57 | - Set `conjugate=true` to perform the complex conjugate transpose of a matrix which interchanges the row and column index for each element, reflecting the elements across the main diagonal and negating the imaginary part of any complex numbers. For example, if `b = transpose(a, true)` and element `a(2, 1)` is `(1, 2)`, then element `b(1, 2)` is `(1, -2)`. | ||
| 58 | - | ||
| 59 | - In-place versions perform matrix transposition by reordering the input, reducing memory footprint. | ||
| 55 | + Reverse or permute the dimensions of an array; returns the modified array. | ||
| 56 | + For an array a with two dimensions, `transpose(a)` gives the matrix transpose. | ||
| 57 | + For an array with more than two dimensions, the first two dimensions are | ||
| 58 | + transposed across higher dimensions. | ||
| 59 | + | ||
| 60 | + Set `conjugate=true` to perform the complex conjugate transpose of a matrix | ||
| 61 | + which interchanges the row and column index for each element, reflecting the | ||
| 62 | + elements across the main diagonal and negating the imaginary part of any | ||
| 63 | + complex numbers. For example, if `b = transpose(a, true)` and element | ||
| 64 | + `a(2, 1)` is `(1, 2)`, then element `b(1, 2)` is `(1, -2)`. | ||
| 65 | + | ||
| 66 | + In-place versions perform matrix transposition by reordering the input, | ||
| 67 | + reducing memory footprint. | ||
| 60 | 68 | ||
| 61 | 69 | __Examples:__ | |
| 62 | 70 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments