Skip to content

Commit a8f9534

Browse files
committed
updated examples for array/base/accessor-getter
1 parent 74d2527 commit a8f9534

File tree

4 files changed

+11
-51
lines changed

4 files changed

+11
-51
lines changed

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

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,11 @@ Returns an accessor function for retrieving an element from an array-like object
4646

4747
```javascript
4848
var Complex64Array = require( '@stdlib/array/complex64' );
49-
var realf = require( '@stdlib/complex/float32/real' );
50-
var imagf = require( '@stdlib/complex/float32/imag' );
5149

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

5452
var get = accessorGetter( 'complex64' );
55-
var v = get( arr, 1 );
56-
// returns <Complex64>
57-
58-
var re = realf( v );
59-
// returns 3.0
60-
61-
var im = imagf( v );
62-
// returns 4.0
53+
// arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
6354
```
6455

6556
The returned accessor function accepts the following arguments:

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,8 @@
4343
Examples
4444
--------
4545
> var f = {{alias}}( 'complex64' );
46-
> var v = f( {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] ), 1 )
47-
<Complex64>
48-
> var r = {{alias:@stdlib/complex/float32/real}}( v )
49-
3.0
50-
> var i = {{alias:@stdlib/complex/float32/imag}}( v )
51-
4.0
46+
> var v = f( {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ), 1 )
47+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
5248

5349
See Also
5450
--------

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

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -58,20 +58,11 @@ type GetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
5858
*
5959
* @example
6060
* var Complex128Array = require( '@stdlib/array/complex128' );
61-
* var real = require( '@stdlib/array/real' );
62-
* var imag = require( '@stdlib/array/imag' );
6361
*
64-
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
62+
* var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
6563
*
6664
* var get = getter( 'complex128' );
67-
* var v = get( arr, 1 );
68-
* // returns <Complex128>
69-
*
70-
* var re = real( v );
71-
* // returns 3.0
72-
*
73-
* var im = imag( v );
74-
* // returns 4.0
65+
* // arr => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
7566
*/
7667
declare function getter( dtype: 'complex128' ): GetComplex128;
7768

@@ -83,20 +74,11 @@ declare function getter( dtype: 'complex128' ): GetComplex128;
8374
*
8475
* @example
8576
* var Complex64Array = require( '@stdlib/array/complex64' );
86-
* var realf = require( '@stdlib/array/realf' );
87-
* var imagf = require( '@stdlib/array/imagf' );
88-
*
89-
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
77+
*
78+
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
9079
*
9180
* var get = getter( 'complex64' );
92-
* var v = get( arr, 1 );
93-
* // returns <Complex64>
94-
*
95-
* var re = realf( v );
96-
* // returns 3.0
97-
*
98-
* var im = imagf( v );
99-
* // returns 4.0
81+
* // arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
10082
*/
10183
declare function getter( dtype: 'complex64' ): GetComplex64;
10284

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

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,13 @@
2525
*
2626
* @example
2727
* var Complex64Array = require( '@stdlib/array/complex64' );
28-
* var realf = require( '@stdlib/complex/float32/real' );
29-
* var imagf = require( '@stdlib/complex/float32/imag' );
3028
* var dtype = require( '@stdlib/array/dtype' );
3129
* var getter = require( '@stdlib/array/base/accessor-getter' );
3230
*
33-
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
31+
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
3432
*
3533
* var get = getter( dtype( arr ) );
36-
* var v = get( arr, 1 );
37-
* // returns <Complex64>
38-
*
39-
* var re = realf( v );
40-
* // returns 3.0
41-
*
42-
* var im = imagf( v );
43-
* // returns 4.0
34+
* // arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
4435
*/
4536

4637
// MODULES //

0 commit comments

Comments
 (0)