Skip to content

docs: improve doctests for complex number typed arrays in strided #12032

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 10, 2026
Merged

docs: improve doctests for complex number typed arrays in strided #12032

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
20 changes: 5 additions & 15 deletions lib/node_modules/@stdlib/strided/base/cmap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ var x = new Complex64Array( [ -2.3, 1.5, 3.1, -5.2, 4.8, 0.0, -1.6, 3.4 ] );
var y = new Complex64Array( x.length );

cmap( x.length, x, 1, y, 1, cceilf );

var v = y.get( 0 );
// returns <Complex64>[ -2.0, 2.0 ]
// y => <Complex64Array>[ -2.0, 2.0, 4.0, -5.0, 5.0, 0.0, -1.0, 4.0 ]
```

The function accepts the following arguments:
Expand All @@ -72,9 +70,7 @@ var x = new Complex64Array( [ -2.3, 1.5, 3.1, -5.2, 4.8, 0.0, -1.6, 3.4 ] );
var y = new Complex64Array( x.length );

cmap( 2, x, 2, y, -1, cceilf );

var v = y.get( 0 );
// returns <Complex64>[ 5.0, 0.0 ]
// y => <Complex64Array>[ 5.0, 0.0, -2.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][@stdlib/array/complex64] views.
Expand All @@ -92,9 +88,7 @@ var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2n
var y1 = new Complex64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3rd element

cmap( 2, x1, -2, y1, 1, cceilf );

var v = y0.get( 2 );
// returns <Complex64>[ -1.0, 4.0 ]
// y0 => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, -1.0, 4.0, 4.0, -5.0 ]
```

#### cmap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, fcn )
Expand All @@ -109,9 +103,7 @@ var x = new Complex64Array( [ -2.3, 1.5, 3.1, -5.2, 4.8, 0.0, -1.6, 3.4 ] );
var y = new Complex64Array( x.length );

cmap.ndarray( x.length, x, 1, 0, y, 1, 0, cceilf );

var v = y.get( 0 );
// returns <Complex64>[ -2.0, 2.0 ]
// y => <Complex64Array>[ -2.0, 2.0, 4.0, -5.0, 5.0, 0.0, -1.0, 4.0 ]
```

The function accepts the following additional arguments:
Expand All @@ -129,9 +121,7 @@ var x = new Complex64Array( [ -2.3, 1.5, 3.1, -5.2, 4.8, 0.0, -1.6, 3.4 ] );
var y = new Complex64Array( x.length );

cmap.ndarray( 2, x, 2, 1, y, -1, y.length-1, cceilf );

var v = y.get( y.length-1 );
// returns <Complex64>[ 4.0, -5.0 ]
// y => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, -1.0, 4.0, 4.0, -5.0 ]
```

</section>
Expand Down
25 changes: 10 additions & 15 deletions lib/node_modules/@stdlib/strided/base/cmap/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,21 @@
> var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ];
> var x = new {{alias:@stdlib/array/complex64}}( xbuf );
> var y = new {{alias:@stdlib/array/complex64}}( x.length );
> {{alias}}( x.length, x, 1, y, 1, {{alias:@stdlib/complex/float32/base/identity}} );
> var v = y.get( 0 )
<Complex64>[ 1.0, 2.0 ]
> {{alias}}( x.length, x, 1, y, 1, {{alias:@stdlib/complex/float32/base/identity}} )
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]

// Using `N` and stride parameters:
> y = new {{alias:@stdlib/array/complex64}}( x.length );
> {{alias}}( 2, x, 2, y, -1, {{alias:@stdlib/complex/float32/base/identity}} );
> v = y.get( 0 )
<Complex64>[ 5.0, 6.0 ]
> {{alias}}( 2, x, 2, y, -1, {{alias:@stdlib/complex/float32/base/identity}} )
<Complex64Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/complex64}}( xbuf );
> var y0 = new {{alias:@stdlib/array/complex64}}( x0.length );
> var x1 = new {{alias:@stdlib/array/complex64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> var y1 = new {{alias:@stdlib/array/complex64}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
> {{alias}}( 2, x1, -2, y1, 1, {{alias:@stdlib/complex/float32/base/identity}} );
> v = y1.get( 0 )
<Complex64>[ 7.0, 8.0 ]
> {{alias}}( 2, x1, -2, y1, 1, {{alias:@stdlib/complex/float32/base/identity}} )
<Complex64Array>[ 7.0, 8.0, 3.0, 4.0 ]


{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, fcn )
Expand Down Expand Up @@ -107,16 +104,14 @@
> var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ];
> var x = new {{alias:@stdlib/array/complex64}}( xbuf );
> var y = new {{alias:@stdlib/array/complex64}}( x.length );
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0, {{alias:@stdlib/complex/float32/base/identity}} );
> var v = y.get( 0 )
<Complex64>[ 1.0, 2.0 ]
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0, {{alias:@stdlib/complex/float32/base/identity}} )
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]

// Advanced indexing:
> x = new {{alias:@stdlib/array/complex64}}( xbuf );
> y = new {{alias:@stdlib/array/complex64}}( x.length );
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1, {{alias:@stdlib/complex/float32/base/identity}} );
> v = y.get( y.length-1 )
<Complex64>[ 3.0, 4.0 ]
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1, {{alias:@stdlib/complex/float32/base/identity}} )
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]

See Also
--------
Expand Down
40 changes: 4 additions & 36 deletions lib/node_modules/@stdlib/strided/base/cmap/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,7 @@ interface Routine {
* var y = new Complex64Array( x.length );
*
* cmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number, fcn: Unary ): Complex64Array;

Expand Down Expand Up @@ -103,15 +95,7 @@ interface Routine {
* var y = new Complex64Array( x.length );
*
* cmap.ndarray( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number, fcn: Unary ): Complex64Array;
}
Expand Down Expand Up @@ -143,15 +127,7 @@ interface Routine {
* var y = new Complex64Array( x.length );
*
* cmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
Expand All @@ -169,15 +145,7 @@ interface Routine {
* var y = new Complex64Array( x.length );
*
* cmap.ndarray( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
declare var cmap: Routine;

Expand Down
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/strided/base/cmap/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@
* var y = new Complex64Array( x.length );
*
* cmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>[ 10.0, 10.0 ]
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
Expand All @@ -61,9 +59,7 @@
* var y = new Complex64Array( x.length );
*
* cmap.ndarray( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>[ 10.0, 10.0 ]
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/

// MODULES //
Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/strided/base/cmap/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ var ndarray = require( './ndarray.js' );
* var y = new Complex64Array( x.length );
*
* cmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>[ 10.0, 10.0 ]
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
function cmap( N, x, strideX, y, strideY, fcn ) {
return ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ), fcn ); // eslint-disable-line max-len
Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/strided/base/cmap/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@
* var y = new Complex64Array( x.length );
*
* cmap( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>[ 10.0, 10.0 ]
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
function cmap( N, x, strideX, offsetX, y, strideY, offsetY, fcn ) {
var ix;
Expand Down
36 changes: 9 additions & 27 deletions lib/node_modules/@stdlib/strided/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,7 @@ interface Namespace {
* var y = new Complex64Array( x.length );
*
* ns.cmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
Expand All @@ -291,15 +283,7 @@ interface Namespace {
* var y = new Complex64Array( x.length );
*
* ns.cmap.ndarray( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 10.0
* // y => <Complex64Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
cmap: typeof cmap;

Expand Down Expand Up @@ -449,7 +433,7 @@ interface Namespace {
* var z = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
*
* ns.dmskmap2( x.length, x, 1, m, 1, y, 1, add );
* ns.dmskmap2( x.length, x, 1, y, 1, m, 1, z, 1, add );
* // z => <Float64Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
*
* @example
Expand Down Expand Up @@ -592,6 +576,7 @@ interface Namespace {
* function accessor( values ) {
* values[ 0 ] *= 2.0;
* values[ 1 ] *= 2.0;
* return values;
* }
*
* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];
Expand All @@ -607,6 +592,7 @@ interface Namespace {
* function accessor( values ) {
* values[ 0 ] *= 2.0;
* values[ 1 ] *= 2.0;
* return values;
* }
*
* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];
Expand Down Expand Up @@ -1317,7 +1303,7 @@ interface Namespace {
* var z = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
*
* ns.smskmap2( x.length, x, 1, m, 1, y, 1, addf );
* ns.smskmap2( x.length, x, 1, y, 1, m, 1, z, 1, addf );
* // z => <Float32Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
*
* @example
Expand Down Expand Up @@ -1388,7 +1374,7 @@ interface Namespace {
* var fcns = obj.accessors;
* // returns [ <Function>, <Function> ]
*
* var v = fcns[ 0 ]( x.data, 2 );
* var v = fcns[ 0 ]( obj.data, 2 );
* // returns 3
*/
strided2object: typeof strided2object;
Expand Down Expand Up @@ -1723,9 +1709,7 @@ interface Namespace {
* var y = new Complex128Array( x.length );
*
* ns.zmap( x.length, x, 1, y, 1, scale );
*
* var v = y.get( 0 );
* // returns <Complex128>[ 10.0, 10.0 ]
* // y => <Complex128Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
Expand All @@ -1743,9 +1727,7 @@ interface Namespace {
* var y = new Complex128Array( x.length );
*
* ns.zmap.ndarray( x.length, x, 1, 0, y, 1, 0, scale );
*
* var v = y.get( 0 );
* // returns <Complex128>[ 10.0, 10.0 ]
* // y => <Complex128Array>[ 10.0, 10.0, 20.0, 20.0, 30.0, 30.0, 40.0, 40.0, 50.0, 50.0 ]
*/
zmap: typeof zmap;
}
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/strided/base/reinterpret-complex/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ var im = view[ 1 ];

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var real = require( '@stdlib/complex/float64/real' );
var imag = require( '@stdlib/complex/float64/imag' );
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex' );

// Define a complex number array:
Expand All @@ -116,16 +114,7 @@ var view = reinterpret( x, 0 );
// Set view elements:
view[ 0 ] = 9.0;
view[ 1 ] = 10.0;

// Get the first element of the complex number array:
var z = x.get( 0 );
// returns <Complex128>

var re = real( z );
// returns 9.0

var im = imag( z );
// returns 10.0
// x => <Complex128Array>[ 9.0, 10.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
```

</section>
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/strided/base/reinterpret-complex128/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ var im = view[ 1 ];

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var real = require( '@stdlib/complex/float64/real' );
var imag = require( '@stdlib/complex/float64/imag' );
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );

// Define a complex number array:
Expand All @@ -116,16 +114,7 @@ var view = reinterpret( x, 0 );
// Set view elements:
view[ 0 ] = 9.0;
view[ 1 ] = 10.0;

// Get the first element of the complex number array:
var z = x.get( 0 );
// returns <Complex128>

var re = real( z );
// returns 9.0

var im = imag( z );
// returns 10.0
// x => <Complex128Array>[ 9.0, 10.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
```

</section>
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ var im = view[ 1 ];

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var real = require( '@stdlib/complex/float64/real' );
var imag = require( '@stdlib/complex/float64/imag' );
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' );

// Define a complex number array:
Expand All @@ -116,16 +114,7 @@ var view = reinterpret( x, 0 );
// Set view elements:
view[ 0 ] = 9.0;
view[ 1 ] = 10.0;

// Get the first element of the complex number array:
var z = x.get( 0 );
// returns <Complex64>

var re = real( z );
// returns 9.0

var im = imag( z );
// returns 10.0
// x => <Complex64Array>[ 9.0, 10.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
```

</section>
Expand Down
Loading