Skip to content

docs: improve doctests for complex number typed arrays in utils #12028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
May 9, 2026
Merged

docs: improve doctests for complex number typed arrays in utils #12028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions lib/node_modules/@stdlib/utils/map-right/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,7 @@ The applied function is provided the same arguments as with [`mapRight`](#fcn-ma
var y = new Complex64Array( 4 );

mapRight.assign( x, y, scale );

var v = y.get( 0 );

var re = realf( v );
// returns 10.0

var im = imagf( v );
// returns 20.0
// y => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
```

- When applying a function to [`ndarray`][@stdlib/ndarray/ctor]-like objects, performance will be best for [`ndarray`][@stdlib/ndarray/ctor]-like objects which are single-segment contiguous. For non-contiguous arrays, see [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary].
Expand Down
9 changes: 1 addition & 8 deletions lib/node_modules/@stdlib/utils/map-right/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,7 @@ var MODE = 'throw';
*
* // Apply the unary function:
* mapRight( x, y, naryFunction( scale, 1 ) );
*
* var v = y.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns 20.0
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
*/
function mapRight( x, y, fcn, thisArg ) {
var xbuf;
Expand Down
9 changes: 1 addition & 8 deletions lib/node_modules/@stdlib/utils/map/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,7 @@ The applied function is provided the same arguments as with [`map`](#fcn-map).
var y = new Complex64Array( 4 );

map.assign( x, y, scale );

var v = y.get( 0 );

var re = realf( v );
// returns 10.0

var im = imagf( v );
// returns 20.0
// y => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
```

- When applying a function to [`ndarray`][@stdlib/ndarray/ctor]-like objects, performance will be best for [`ndarray`][@stdlib/ndarray/ctor]-like objects which are single-segment contiguous. For non-contiguous arrays, see [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary].
Expand Down
9 changes: 1 addition & 8 deletions lib/node_modules/@stdlib/utils/map/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,7 @@ var MODE = 'throw';
*
* // Apply the unary function:
* map( x, y, naryFunction( scale, 1 ) );
*
* var v = y.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns 20.0
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
*/
function map( x, y, fcn, thisArg ) {
var xbuf;
Expand Down
12 changes: 1 addition & 11 deletions lib/node_modules/@stdlib/utils/map2-right/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,24 +205,14 @@ The applied function is provided the same arguments as with [`map2Right`](#fcn-m
```javascript
var naryFunction = require( '@stdlib/utils/nary-function' );
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );
var add = require( '@stdlib/complex/float32/base/add' );

var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
var z = new Complex64Array( 4 );

map2Right.assign( x, y, z, naryFunction( add, 2 ) );

var v = z.get( 0 );

var re = realf( v );
// returns 2.0

var im = imagf( v );
// returns 3.0
// z => <Complex64Array>[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]
```

- When applying a function to [`ndarray`][@stdlib/ndarray/ctor]-like objects, performance will be best for [`ndarray`][@stdlib/ndarray/ctor]-like objects which are single-segment contiguous. For non-contiguous arrays, see [`@stdlib/ndarray/base/binary`][@stdlib/ndarray/base/binary].
Expand Down
12 changes: 1 addition & 11 deletions lib/node_modules/@stdlib/utils/map2-right/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var naryFunction = require( '@stdlib/utils/nary-function' );
* var add = require( '@stdlib/complex/float32/base/add' );
*
Expand Down Expand Up @@ -132,7 +129,7 @@
* var z = {
* 'ref': null,
* 'dtype': 'complex64',
* 'data': zbuf,

Check warning on line 132 in lib/node_modules/@stdlib/utils/map2-right/lib/ndarray.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "zbuf"
* 'length': 4,
* 'shape': shape,
* 'strides': sz,
Expand All @@ -143,14 +140,7 @@
*
* // Apply the function:
* map2Right( x, y, z, naryFunction( add, 2 ) );
*
* var v = z.data.get( 0 );
*
* var re = realf( v );
* // returns 2.0
*
* var im = imagf( v );
* // returns 3.0
* // zbuf => <Complex64Array>[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]

Check warning on line 143 in lib/node_modules/@stdlib/utils/map2-right/lib/ndarray.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "zbuf"
*/
function map2Right( x, y, z, fcn, thisArg ) {
var xbuf;
Expand Down
12 changes: 1 addition & 11 deletions lib/node_modules/@stdlib/utils/map2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,24 +205,14 @@ The applied function is provided the same arguments as with [`map2`](#fcn-map2).
```javascript
var naryFunction = require( '@stdlib/utils/nary-function' );
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );
var add = require( '@stdlib/complex/float32/base/add' );

var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
var z = new Complex64Array( 4 );

map2.assign( x, y, z, naryFunction( add, 2 ) );

var v = z.get( 0 );

var re = realf( v );
// returns 2.0

var im = imagf( v );
// returns 3.0
// z => <Complex64Array>[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]
```

- When applying a function to [`ndarray`][@stdlib/ndarray/ctor]-like objects, performance will be best for [`ndarray`][@stdlib/ndarray/ctor]-like objects which are single-segment contiguous. For non-contiguous arrays, see [`@stdlib/ndarray/base/binary`][@stdlib/ndarray/base/binary].
Expand Down
12 changes: 1 addition & 11 deletions lib/node_modules/@stdlib/utils/map2/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var naryFunction = require( '@stdlib/utils/nary-function' );
* var add = require( '@stdlib/complex/float32/base/add' );
*
Expand Down Expand Up @@ -132,7 +129,7 @@
* var z = {
* 'ref': null,
* 'dtype': 'complex64',
* 'data': zbuf,

Check warning on line 132 in lib/node_modules/@stdlib/utils/map2/lib/ndarray.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "zbuf"
* 'length': 4,
* 'shape': shape,
* 'strides': sz,
Expand All @@ -143,14 +140,7 @@
*
* // Apply the function:
* map2( x, y, z, naryFunction( add, 2 ) );
*
* var v = z.data.get( 0 );
*
* var re = realf( v );
* // returns 2.0
*
* var im = imagf( v );
* // returns 3.0
* // zbuf => <Complex64Array>[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]

Check warning on line 143 in lib/node_modules/@stdlib/utils/map2/lib/ndarray.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "zbuf"
*/
function map2( x, y, z, fcn, thisArg ) {
var xbuf;
Expand Down