Skip to content

Commit f8b2ab2

Browse files
docs: improve doctests for complex number instances in array/base/accessor-setter
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent c0b3cef commit f8b2ab2

File tree

6 files changed

+13
-73
lines changed

6 files changed

+13
-73
lines changed

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

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,14 @@ 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

5351
var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
5452

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

5856
var v = arr.get( 1 );
59-
// returns <Complex64>
60-
61-
var re = realf( v );
62-
// returns 10.0
63-
64-
var im = imagf( v );
65-
// returns 11.0
57+
// returns <Complex64>[ 10.0, 11.0 ]
6658
```
6759

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

115107
var v = arr.get( 2 );
116-
// returns <Complex128>
108+
// returns <Complex128>[ 100.0, 101.0 ]
117109

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

124116
v = arr.get( 4 );
125-
// returns <Complex64>
117+
// returns <Complex64>[ 102.0, 103.0 ]
126118

127119
console.log( '%s', v.toString() );
128120
// => '102 + 103i'

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,7 @@
4949
> var x = {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] );
5050
> f( x, 1, new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 11.0 ) );
5151
> 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
52+
<Complex64>[ 10.0, 11.0]
5753

5854
See Also
5955
--------

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

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,14 @@ 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' );
6462
*
6563
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
6664
*
6765
* var set = setter( 'complex128' );
6866
* set( arr, 1, new Complex128( 10.0, 11.0 ) );
6967
*
7068
* var v = arr.get( 1 );
71-
* // returns <Complex128>
72-
*
73-
* var re = real( v );
74-
* // returns 10.0
75-
*
76-
* var im = imag( v );
77-
* // returns 11.0
69+
* // returns <Complex128>[ 10.0, 11.0 ]
7870
*/
7971
declare function setter( dtype: 'complex128' ): SetComplex128;
8072

@@ -87,22 +79,14 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
8779
* @example
8880
* var Complex64Array = require( '@stdlib/array/complex64' );
8981
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
90-
* var realf = require( '@stdlib/array/realf' );
91-
* var imagf = require( '@stdlib/array/imagf' );
9282
*
9383
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
9484
*
9585
* var set = setter( 'complex64' );
9686
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
9787
*
9888
* var v = arr.get( 1 );
99-
* // returns <Complex64>
100-
*
101-
* var re = realf( v );
102-
* // returns 3.0
103-
*
104-
* var im = imagf( v );
105-
* // returns 4.0
89+
* // returns <Complex64>[ 10.0, 11.0 ]
10690
*/
10791
declare function setter( dtype: 'complex64' ): SetComplex64;
10892

@@ -130,7 +114,7 @@ declare function setter( dtype: 'complex64' ): SetComplex64;
130114
* set( arr, 2, 10 );
131115
*
132116
* var v = arr.get( 2 );
133-
* // returns 3
117+
* // returns 10
134118
*/
135119
declare function setter<T = unknown>( dtype: string ): SetArrayLike<T>;
136120

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var arr = new Complex128Array( zeroTo( 10 ) );
3030
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
3131

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

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

4141
v = arr.get( 4 );
42-
// returns <Complex64>
42+
// returns <Complex64>[ 102.0, 103.0 ]
4343

4444
console.log( '%s', v.toString() );
4545
// => '102 + 103i'

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626
* @example
2727
* var Complex64Array = require( '@stdlib/array/complex64' );
2828
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
29-
* var realf = require( '@stdlib/complex/float32/real' );
30-
* var imagf = require( '@stdlib/complex/float32/imag' );
3129
* var dtype = require( '@stdlib/array/dtype' );
3230
* var setter = require( '@stdlib/array/base/accessor-setter' );
3331
*
@@ -37,13 +35,7 @@
3735
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
3836
*
3937
* var v = arr.get( 1 );
40-
* // returns <Complex64>
41-
*
42-
* var re = realf( v );
43-
* // returns 10.0
44-
*
45-
* var im = imagf( v );
46-
* // returns 11.0
38+
* // returns <Complex64>[ 10.0, 11.0 ]
4739
*/
4840

4941
// MODULES //

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

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,12 @@ var SETTERS = {
4040
* @example
4141
* var Complex128Array = require( '@stdlib/array/complex128' );
4242
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
43-
* var real = require( '@stdlib/complex/float64/real' );
44-
* var imag = require( '@stdlib/complex/float64/imag' );
4543
*
4644
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
4745
*
4846
* setComplex128( arr, 1, new Complex128( 10.0, 11.0 ) );
4947
* var v = arr.get( 1 );
50-
* // returns <Complex128>
51-
*
52-
* var re = real( v );
53-
* // returns 10.0
54-
*
55-
* var im = imag( v );
56-
* // returns 11.0
48+
* // returns <Complex128>[ 10.0, 11.0 ]
5749
*/
5850
function setComplex128( arr, idx, value ) {
5951
arr.set( value, idx );
@@ -70,20 +62,12 @@ function setComplex128( arr, idx, value ) {
7062
* @example
7163
* var Complex64Array = require( '@stdlib/array/complex64' );
7264
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
73-
* var realf = require( '@stdlib/complex/float32/real' );
74-
* var imagf = require( '@stdlib/complex/float32/imag' );
7565
*
7666
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
7767
*
7868
* setComplex64( arr, 1, new Complex64( 10.0, 11.0 ) );
7969
* var v = arr.get( 1 );
80-
* // returns <Complex64>
81-
*
82-
* var re = realf( v );
83-
* // returns 10.0
84-
*
85-
* var im = imagf( v );
86-
* // returns 11.0
70+
* // returns <Complex64>[ 10.0, 11.0 ]
8771
*/
8872
function setComplex64( arr, idx, value ) {
8973
arr.set( value, idx );
@@ -132,8 +116,6 @@ function setArrayLike( arr, idx, value ) {
132116
* @example
133117
* var Complex64Array = require( '@stdlib/array/complex64' );
134118
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
135-
* var realf = require( '@stdlib/complex/float32/real' );
136-
* var imagf = require( '@stdlib/complex/float32/imag' );
137119
* var dtype = require( '@stdlib/array/dtype' );
138120
*
139121
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
@@ -142,13 +124,7 @@ function setArrayLike( arr, idx, value ) {
142124
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
143125
*
144126
* var v = arr.get( 1 );
145-
* // returns <Complex64>
146-
*
147-
* var re = realf( v );
148-
* // returns 10.0
149-
*
150-
* var im = imagf( v );
151-
* // returns 11.0
127+
* // returns <Complex64>[ 10.0, 11.0 ]
152128
*/
153129
function setter( dtype ) {
154130
var f = SETTERS[ dtype ];

0 commit comments

Comments
 (0)