Skip to content

updated examples for array/base/accessor-getter #6465

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 2 additions & 11 deletions lib/node_modules/@stdlib/array/base/accessor-getter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,11 @@ Returns an accessor function for retrieving an element from an array-like object

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );

var get = accessorGetter( 'complex64' );
var v = get( arr, 1 );
// returns <Complex64>

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

var im = imagf( v );
// returns 4.0
// arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
```

The returned accessor function accepts the following arguments:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,8 @@
Examples
--------
> var f = {{alias}}( 'complex64' );
> var v = f( {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] ), 1 )
<Complex64>
> var r = {{alias:@stdlib/complex/float32/real}}( v )
3.0
> var i = {{alias:@stdlib/complex/float32/imag}}( v )
4.0
> var v = f( {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ), 1 )
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]

See Also
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,11 @@ type GetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/array/real' );
* var imag = require( '@stdlib/array/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
* var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var get = getter( 'complex128' );
* var v = get( arr, 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 3.0
*
* var im = imag( v );
* // returns 4.0
* // arr => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/
declare function getter( dtype: 'complex128' ): GetComplex128;

Expand All @@ -83,20 +74,11 @@ declare function getter( dtype: 'complex128' ): GetComplex128;
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var realf = require( '@stdlib/array/realf' );
* var imagf = require( '@stdlib/array/imagf' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var get = getter( 'complex64' );
* var v = get( arr, 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/
declare function getter( dtype: 'complex64' ): GetComplex64;

Expand Down
13 changes: 2 additions & 11 deletions lib/node_modules/@stdlib/array/base/accessor-getter/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,13 @@
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var dtype = require( '@stdlib/array/dtype' );
* var getter = require( '@stdlib/array/base/accessor-getter' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var get = getter( dtype( arr ) );
* var v = get( arr, 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // arr => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/

// MODULES //
Expand Down