Skip to content
Merged
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
14 changes: 3 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,12 @@ 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 get = accessorGetter( 'complex64' );
var v = get( arr, 1 );
// returns <Complex64>

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

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

The returned accessor function accepts the following arguments:
Expand Down Expand Up @@ -104,14 +96,14 @@ var accessorGetter = require( '@stdlib/array/base/accessor-getter' );

var arr = new Complex128Array( zeroTo( 10 ) );
var v = accessorGetter( dtype( arr ) )( arr, 2 );
// returns <Complex128>
// returns <Complex128>[ 4.0, 5.0 ]

console.log( v.toString() );
// => '4 + 5i'

arr = new Complex64Array( zeroTo( 10 ) );
v = accessorGetter( dtype( arr ) )( arr, 4 );
// returns <Complex64>
// returns <Complex64>[ 8.0, 9.0 ]

console.log( v.toString() );
// => '8 + 9i'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,7 @@
--------
> 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
<Complex64>[ 3.0, 4.0 ]

See Also
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,12 @@ 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 get = getter( 'complex128' );
* var v = get( arr, 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 3.0
*
* var im = imag( v );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/
declare function getter( dtype: 'complex128' ): GetComplex128;

Expand All @@ -83,20 +75,12 @@ 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 get = getter( 'complex64' );
* var v = get( arr, 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*/
declare function getter( dtype: 'complex64' ): GetComplex64;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ var accessorGetter = require( './../lib' );

var arr = new Complex128Array( zeroTo( 10 ) );
var v = accessorGetter( dtype( arr ) )( arr, 2 );
// returns <Complex128>
// returns <Complex128>[ 4.0, 5.0 ]

console.log( '%s', v.toString() );

arr = new Complex64Array( zeroTo( 10 ) );
v = accessorGetter( dtype( arr ) )( arr, 4 );
// returns <Complex64>
// returns <Complex64>[ 8.0, 9.0 ]

console.log( '%s', v.toString() );
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,14 @@
*
* @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 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
* // returns <Complex64>[ 3.0, 4.0 ]
*/

// MODULES //
Expand Down
30 changes: 3 additions & 27 deletions lib/node_modules/@stdlib/array/base/accessor-getter/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,11 @@ var GETTERS = {
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
* var v = getComplex128( arr, 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 3.0
*
* var im = imag( v );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/
function getComplex128( arr, idx ) {
return arr.get( idx );
Expand All @@ -67,19 +59,11 @@ function getComplex128( arr, idx ) {
*
* @example
* 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 v = getComplex64( arr, 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*/
function getComplex64( arr, idx ) {
return arr.get( idx );
Expand Down Expand Up @@ -125,21 +109,13 @@ function getArrayLike( arr, idx ) {
*
* @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 arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
* 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
* // returns <Complex64>[ 3.0, 4.0 ]
*/
function getter( dtype ) {
var f = GETTERS[ dtype ];
Expand Down