FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

slight tweaks to documentation wording · arrayfire/arrayfire@33935ab · GitHub

Commit 33935ab

Browse files
authored andcommitted
slight tweaks to documentation wording
1 parent 461b694 commit 33935ab

4 files changed

Lines changed: 97 additions & 147 deletions

File tree

‎docs/details/arith.dox‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,28 @@
1919
\defgroup arith_func_add add
2020
\ingroup arith_mat
2121

22-
Add two arrays.
22+
Elementwise addition
2323

2424

2525

2626
\defgroup arith_func_sub sub
2727
\ingroup arith_mat
2828

29-
Subtract one array from another array.
29+
Elementwise subtraction
3030

3131

3232

3333
\defgroup arith_func_mul mul
3434
\ingroup arith_mat
3535

36-
Multiply two arrays.
36+
Elementwise multiply
3737

3838

3939

4040
\defgroup arith_func_div div
4141
\ingroup arith_mat
4242

43-
Divide one array by another array.
43+
Elementwise division
4444

4545

4646

@@ -189,14 +189,14 @@ Cast an array from one type to another.
189189
\defgroup arith_func_min min
190190
\ingroup numeric_mat
191191

192-
Find the elementwise minimum between two arrays.
192+
Returns the elementwise minimum between two arrays.
193193

194194

195195

196196
\defgroup arith_func_max max
197197
\ingroup numeric_mat
198198

199-
Find the elementwise maximum between two arrays.
199+
Returns the elementwise maximum between two arrays.
200200

201201

202202

@@ -210,7 +210,7 @@ Clamp an array between an upper and a lower limit.
210210
\defgroup arith_func_rem rem
211211
\ingroup numeric_mat
212212

213-
Find the remainder of a division.
213+
Calculate the remainder of a division.
214214

215215
\copydoc arith_real_only
216216

@@ -219,7 +219,7 @@ Find the remainder of a division.
219219
\defgroup arith_func_mod mod
220220
\ingroup numeric_mat
221221

222-
Find the modulus.
222+
Calculate the modulus.
223223

224224
\copydoc arith_real_only
225225

@@ -228,20 +228,20 @@ Find the modulus.
228228
\defgroup arith_func_abs abs
229229
\ingroup numeric_mat
230230

231-
Find the absolute value.
231+
Calculate the absolute value.
232232

233233

234234
\defgroup arith_func_arg arg
235235
\ingroup numeric_mat
236236

237-
Find the phase angle (in radians) of a complex array.
237+
Calculate the phase angle (in radians) of a complex array.
238238

239239

240240

241241
\defgroup arith_func_sign sign
242242
\ingroup numeric_mat
243243

244-
Find the sign of elements in an array.
244+
Return the sign of elements in an array.
245245

246246
\copydoc arith_real_only
247247

@@ -268,7 +268,7 @@ Truncate numbers to nearest integer.
268268
\defgroup arith_func_floor floor
269269
\ingroup numeric_mat
270270

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.
272272

273273
\copydoc arith_real_only
274274

@@ -277,7 +277,7 @@ Round to the integer less than or equal to the magnitude of the input value.
277277
\defgroup arith_func_ceil ceil
278278
\ingroup numeric_mat
279279

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.
281281

282282
\copydoc arith_real_only
283283

@@ -286,7 +286,7 @@ Round to the integer greater than or equal to the magnitude of the input value.
286286
\defgroup arith_func_hypot hypot
287287
\ingroup numeric_mat
288288

289-
Find the length of the hypotenuse of two inputs.
289+
Evaluate the length of the hypotenuse of two inputs.
290290

291291
\copydoc arith_real_only
292292

@@ -398,28 +398,28 @@ __Examples:__
398398
\defgroup arith_func_real real
399399
\ingroup complex_mat
400400

401-
Find the real part of a complex array.
401+
Returns the real part of a complex array.
402402

403403

404404

405405
\defgroup arith_func_imag imag
406406
\ingroup complex_mat
407407

408-
Find the imaginary part of a complex array.
408+
Returns the imaginary part of a complex array.
409409

410410

411411

412412
\defgroup arith_func_conjg conjg
413413
\ingroup complex_mat
414414

415-
Find the complex conjugate of an input array.
415+
Evaluate the complex conjugate of an input array.
416416

417417

418418

419419
\defgroup arith_func_root root
420420
\ingroup explog_mat
421421

422-
Find the nth root.
422+
Evaluate the nth root.
423423

424424

425425

@@ -513,14 +513,14 @@ Evaluate the base 2 logarithm.
513513
\defgroup arith_func_sqrt sqrt
514514
\ingroup explog_mat
515515

516-
Find the square root.
516+
Evaluate the square root.
517517

518518

519519

520520
\defgroup arith_func_rsqrt rsqrt
521521
\ingroup explog_mat
522522

523-
Find the reciprocal square root.
523+
Evaluate the reciprocal square root.
524524

525525
\f[ \frac{1}{\sqrt{x}} \f]
526526

@@ -531,7 +531,7 @@ Find the reciprocal square root.
531531
\defgroup arith_func_cbrt cbrt
532532
\ingroup explog_mat
533533

534-
Find the cube root.
534+
Evaluate the cube root.
535535

536536
\copydoc arith_real_only
537537

@@ -540,7 +540,7 @@ Find the cube root.
540540
\defgroup arith_func_factorial factorial
541541
\ingroup explog_mat
542542

543-
Find the factorial.
543+
Evaluate the factorial.
544544

545545
\copydoc arith_real_only
546546

‎docs/details/blas.dox‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,19 @@ and restrictions.
5252

5353
\brief Transpose a matrix.
5454

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.
6068

6169
__Examples:__
6270

‎docs/details/examples.dox‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

0 commit comments

Comments
 (0)

Back | FazBrowse Home | New Git URL