Skip to content

Commit 26f84c2

Browse files
fix(array/base/accessor-setter): update doctests for complex number typed arrays (Ref: stdlib-js#4833)
1 parent 5fd8af8 commit 26f84c2

File tree

4 files changed

+33
-52
lines changed

4 files changed

+33
-52
lines changed

lib/node_modules/@stdlib/array/base/accessor-setter/README.md

+5-18
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,15 @@ Returns an accessor function for setting an element in an array-like object supp
4747
```javascript
4848
var Complex64Array = require( '@stdlib/array/complex64' );
4949
var Complex64 = require( '@stdlib/complex/float32/ctor' );
50-
var realf = require( '@stdlib/complex/float32/real' );
51-
var imagf = require( '@stdlib/complex/float32/imag' );
5250

53-
var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
51+
52+
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
5453

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

58-
var v = arr.get( 1 );
59-
// returns <Complex64>
60-
61-
var re = realf( v );
62-
// returns 10.0
57+
// arr => <Complex64Array>[ 1.0, 2.0, 10.0, 11.0 ]
6358

64-
var im = imagf( v );
65-
// returns 11.0
6659
```
6760

6861
The returned accessor function accepts the following arguments:
@@ -112,20 +105,14 @@ var accessorSetter = require( '@stdlib/array/base/accessor-setter' );
112105
var arr = new Complex128Array( zeroTo( 10 ) );
113106
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
114107

115-
var v = arr.get( 2 );
116-
// returns <Complex128>
108+
//arr=> <Complex128Array>[ 0.0, 1.0, 100.0, 101.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]
117109

118-
console.log( '%s', v.toString() );
119-
// => '100 + 101i'
120110

121111
arr = new Complex64Array( zeroTo( 10 ) );
122112
accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );
123113

124-
v = arr.get( 4 );
125-
// returns <Complex64>
114+
// arr => <Complex64Array>[ 0.0, 1.0, 2.0, 3.0, 102.0, 103.0, 6.0, 7.0, 8.0, 9.0 ]
126115

127-
console.log( '%s', v.toString() );
128-
// => '102 + 103i'
129116
```
130117

131118
</section>

lib/node_modules/@stdlib/array/base/accessor-setter/docs/repl.txt

+4-7
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,11 @@
4646
Examples
4747
--------
4848
> var f = {{alias}}( 'complex64' );
49-
> var x = {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] );
49+
> var x = {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
5050
> f( x, 1, new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 11.0 ) );
51-
> var v = x.get( 1 )
52-
<Complex64>
53-
> var r = {{alias:@stdlib/complex/float32/real}}( v )
54-
10.0
55-
> var i = {{alias:@stdlib/complex/float32/imag}}( v )
56-
11.0
51+
> x
52+
<Complex64Array>[ 1.0, 2.0, 10.0, 11.0 ]
53+
5754

5855
See Also
5956
--------

lib/node_modules/@stdlib/array/base/accessor-setter/docs/types/index.d.ts

+22-18
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,24 @@ type SetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => v
5959
* @example
6060
* var Complex128Array = require( '@stdlib/array/complex128' );
6161
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
62-
* var real = require( '@stdlib/array/real' );
63-
* var imag = require( '@stdlib/array/imag' );
62+
*
63+
*
6464
*
65-
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
65+
* var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
6666
*
6767
* var set = setter( 'complex128' );
6868
* set( arr, 1, new Complex128( 10.0, 11.0 ) );
6969
*
70-
* var v = arr.get( 1 );
71-
* // returns <Complex128>
70+
*
71+
* arr => <Complex128Array>[ 1.0, 2.0, 10.0, 11.0 ]
72+
*
73+
*
7274
*
73-
* var re = real( v );
74-
* // returns 10.0
75+
*
76+
*
7577
*
76-
* var im = imag( v );
77-
* // returns 11.0
78+
*
79+
*
7880
*/
7981
declare function setter( dtype: 'complex128' ): SetComplex128;
8082

@@ -87,22 +89,24 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
8789
* @example
8890
* var Complex64Array = require( '@stdlib/array/complex64' );
8991
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
90-
* var realf = require( '@stdlib/array/realf' );
91-
* var imagf = require( '@stdlib/array/imagf' );
92+
*
93+
*
9294
*
93-
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
95+
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
9496
*
9597
* var set = setter( 'complex64' );
9698
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
99+
*
100+
* arr => <Complex64Array>[ 1.0, 2.0, 10.0, 11.0 ]
97101
*
98-
* var v = arr.get( 1 );
99-
* // returns <Complex64>
102+
*
103+
*
100104
*
101-
* var re = realf( v );
102-
* // returns 3.0
105+
*
106+
*
103107
*
104-
* var im = imagf( v );
105-
* // returns 4.0
108+
*
109+
*
106110
*/
107111
declare function setter( dtype: 'complex64' ): SetComplex64;
108112

lib/node_modules/@stdlib/array/base/accessor-setter/examples/index.js

+2-9
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,10 @@ var accessorSetter = require( './../lib' );
2929
var arr = new Complex128Array( zeroTo( 10 ) );
3030
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
3131

32-
var v = arr.get( 2 );
33-
// returns <Complex128>
34-
35-
console.log( '%s', v.toString() );
36-
// => '100 + 101i'
32+
//arr=> <Complex128Array>[ 0.0, 1.0, 100.0, 101.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ]
3733

3834
arr = new Complex64Array( zeroTo( 10 ) );
3935
accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );
4036

41-
v = arr.get( 4 );
42-
// returns <Complex64>
37+
// arr => <Complex64Array>[ 0.0, 1.0, 2.0, 3.0, 102.0, 103.0, 6.0, 7.0, 8.0, 9.0 ]
4338

44-
console.log( '%s', v.toString() );
45-
// => '102 + 103i'

0 commit comments

Comments
 (0)