Skip to content

Commit f47a4f0

Browse files
docs: improve doctests for complex number typed arrays in utils/map-reduce-right
PR-URL: #12073 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: stdlib-js/metr-issue-tracker#562 Ref: #4833
1 parent 97a16c0 commit f47a4f0

3 files changed

Lines changed: 10 additions & 23 deletions

File tree

lib/node_modules/@stdlib/utils/map-reduce-right/README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ var mean = out / ctx.count;
136136
```javascript
137137
var Complex64Array = require( '@stdlib/array/complex64' );
138138
var Complex64 = require( '@stdlib/complex/float32/ctor' );
139-
var cceil = require( '@stdlib/math/base/special/cceil' );
139+
var cceilf = require( '@stdlib/math/base/special/cceilf' );
140140
var realf = require( '@stdlib/complex/float32/real' );
141141
var imagf = require( '@stdlib/complex/float32/imag' );
142142

@@ -150,14 +150,8 @@ var mean = out / ctx.count;
150150

151151
var x = new Complex64Array( [ 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5 ] );
152152

153-
var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), cceil, sum );
154-
// returns <Complex64>
155-
156-
var re = realf( v );
157-
// returns 20.0
158-
159-
var im = imagf( v );
160-
// returns 24.0
153+
var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), cceilf, sum );
154+
// returns <Complex64>[ 20.0, 24.0 ]
161155
```
162156

163157
- For [`ndarray`][@stdlib/ndarray/ctor]-like objects, the function performs a single-pass map-reduce operation over the entire input [`ndarray`][@stdlib/ndarray/ctor] (i.e., higher-order [`ndarray`][@stdlib/ndarray/ctor] dimensions are flattened to a single-dimension).

lib/node_modules/@stdlib/utils/map-reduce-right/lib/ndarray.js

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,8 @@ var MODE = 'throw';
5353
* @example
5454
* var Complex64Array = require( '@stdlib/array/complex64' );
5555
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
56-
* var realf = require( '@stdlib/complex/float32/real' );
57-
* var imagf = require( '@stdlib/complex/float32/imag' );
58-
* var cceil = require( '@stdlib/math/base/special/cceil' );
59-
* var cadd = require( '@stdlib/complex/float64/base/add' );
56+
* var cceilf = require( '@stdlib/math/base/special/cceilf' );
57+
* var cadd = require( '@stdlib/complex/float32/base/add' );
6058
* var naryFunction = require( '@stdlib/utils/nary-function' );
6159
*
6260
* // Create a data buffer:
@@ -91,13 +89,8 @@ var MODE = 'throw';
9189
* x.ref = x;
9290
*
9391
* // Compute the sum:
94-
* var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), naryFunction( cceil, 1 ), naryFunction( cadd, 2 ) );
95-
*
96-
* var re = realf( v );
97-
* // returns 20.0
98-
*
99-
* var im = imagf( v );
100-
* // returns 24.0
92+
* var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), naryFunction( cceilf, 1 ), naryFunction( cadd, 2 ) );
93+
* // returns <Complex64>[ 20.0, 24.0 ]
10194
*/
10295
function mapReduceRight( x, initial, mapper, reducer, thisArg ) {
10396
var xbuf;

lib/node_modules/@stdlib/utils/map-reduce-right/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ var tape = require( 'tape' );
2424
var noop = require( '@stdlib/utils/noop' );
2525
var naryFunction = require( '@stdlib/utils/nary-function' );
2626
var add = require( '@stdlib/number/float64/base/add' );
27-
var cadd = require( '@stdlib/complex/float64/base/add' );
27+
var cadd = require( '@stdlib/complex/float32/base/add' );
2828
var abs = require( '@stdlib/math/base/special/abs' );
29-
var cceil = require( '@stdlib/math/base/special/cceil' );
29+
var cceilf = require( '@stdlib/math/base/special/cceilf' );
3030
var Float64Array = require( '@stdlib/array/float64' );
3131
var Complex64Array = require( '@stdlib/array/complex64' );
3232
var array = require( '@stdlib/ndarray/array' );
@@ -239,7 +239,7 @@ tape( 'the function performs a map-reduce operation for each element in an array
239239
var f1;
240240
var f2;
241241

242-
f1 = naryFunction( cceil, 1 );
242+
f1 = naryFunction( cceilf, 1 );
243243
f2 = naryFunction( cadd, 2 );
244244

245245
arr = new Complex64Array( [ 1.5, 2.5, 3.5, 4.5, 5.5, 6.5 ] );

0 commit comments

Comments
 (0)