Skip to content

docs: improve doctests for complex number instances in array/base/accessor-setter #8645

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
Nov 30, 2025
Merged

docs: improve doctests for complex number instances in array/base/accessor-setter #8645

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
14 changes: 3 additions & 11 deletions lib/node_modules/@stdlib/array/base/accessor-setter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,14 @@ Returns an accessor function for setting an element in an array-like object supp
```javascript
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 arr = new Complex64Array( [ 1, 2, 3, 4 ] );

var set = accessorSetter( 'complex64' );
set( arr, 1, new Complex64( 10.0, 11.0 ) );

var v = arr.get( 1 );
// returns <Complex64>

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

var im = imagf( v );
// returns 11.0
// returns <Complex64>[ 10.0, 11.0 ]
```

The returned accessor function accepts the following arguments:
Expand Down Expand Up @@ -113,7 +105,7 @@ var arr = new Complex128Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );

var v = arr.get( 2 );
// returns <Complex128>
// returns <Complex128>[ 100.0, 101.0 ]

console.log( '%s', v.toString() );
// => '100 + 101i'
Expand All @@ -122,7 +114,7 @@ arr = new Complex64Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );

v = arr.get( 4 );
// returns <Complex64>
// returns <Complex64>[ 102.0, 103.0 ]

console.log( '%s', v.toString() );
// => '102 + 103i'
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/array/base/accessor-setter/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,7 @@
> var x = {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] );
> f( x, 1, new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 11.0 ) );
> var v = x.get( 1 )
<Complex64>
> var r = {{alias:@stdlib/complex/float32/real}}( v )
10.0
> var i = {{alias:@stdlib/complex/float32/imag}}( v )
11.0
<Complex64>[ 10.0, 11.0]

See Also
--------
Expand Down
22 changes: 3 additions & 19 deletions lib/node_modules/@stdlib/array/base/accessor-setter/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,22 +59,14 @@ type SetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => v
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/array/real' );
* var imag = require( '@stdlib/array/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
* var set = setter( 'complex128' );
* set( arr, 1, new Complex128( 10.0, 11.0 ) );
*
* var v = arr.get( 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 11.0
* // returns <Complex128>[ 10.0, 11.0 ]
*/
declare function setter( dtype: 'complex128' ): SetComplex128;

Expand All @@ -87,22 +79,14 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/array/realf' );
* var imagf = require( '@stdlib/array/imagf' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
* var set = setter( 'complex64' );
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
*
* var v = arr.get( 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // returns <Complex64>[ 10.0, 11.0 ]
*/
declare function setter( dtype: 'complex64' ): SetComplex64;

Expand Down Expand Up @@ -130,7 +114,7 @@ declare function setter( dtype: 'complex64' ): SetComplex64;
* set( arr, 2, 10 );
*
* var v = arr.get( 2 );
* // returns 3
* // returns 10
*/
declare function setter<T = unknown>( dtype: string ): SetArrayLike<T>;

Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/array/base/accessor-setter/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ var arr = new Complex128Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );

var v = arr.get( 2 );
// returns <Complex128>
// returns <Complex128>[ 100.0, 101.0 ]

console.log( '%s', v.toString() );
// => '100 + 101i'
Expand All @@ -39,7 +39,7 @@ arr = new Complex64Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );

v = arr.get( 4 );
// returns <Complex64>
// returns <Complex64>[ 102.0, 103.0 ]

console.log( '%s', v.toString() );
// => '102 + 103i'
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/array/base/accessor-setter/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,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 dtype = require( '@stdlib/array/dtype' );
* var setter = require( '@stdlib/array/base/accessor-setter' );
*
Expand All @@ -37,13 +35,7 @@
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
*
* var v = arr.get( 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns 11.0
* // returns <Complex64>[ 10.0, 11.0 ]
*/

// MODULES //
Expand Down
30 changes: 3 additions & 27 deletions lib/node_modules/@stdlib/array/base/accessor-setter/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,12 @@ var SETTERS = {
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
* setComplex128( arr, 1, new Complex128( 10.0, 11.0 ) );
* var v = arr.get( 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 10.0
*
* var im = imag( v );
* // returns 11.0
* // returns <Complex128>[ 10.0, 11.0 ]
*/
function setComplex128( arr, idx, value ) {
arr.set( value, idx );
Expand All @@ -70,20 +62,12 @@ function setComplex128( arr, idx, value ) {
* @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 arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
* setComplex64( arr, 1, new Complex64( 10.0, 11.0 ) );
* var v = arr.get( 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns 11.0
* // returns <Complex64>[ 10.0, 11.0 ]
*/
function setComplex64( arr, idx, value ) {
arr.set( value, idx );
Expand Down Expand Up @@ -132,8 +116,6 @@ function setArrayLike( arr, idx, value ) {
* @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 dtype = require( '@stdlib/array/dtype' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
Expand All @@ -142,13 +124,7 @@ function setArrayLike( arr, idx, value ) {
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
*
* var v = arr.get( 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns 11.0
* // returns <Complex64>[ 10.0, 11.0 ]
*/
function setter( dtype ) {
var f = SETTERS[ dtype ];
Expand Down