diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/README.md b/lib/node_modules/@stdlib/array/base/accessor-getter/README.md index 0bb570b4608c..9e05a5f7fde9 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/README.md +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/README.md @@ -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 - -var re = realf( v ); -// returns 3.0 - -var im = imagf( v ); -// returns 4.0 +// returns [ 3.0, 4.0 ] ``` The returned accessor function accepts the following arguments: @@ -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 +// returns [ 4.0, 5.0 ] console.log( v.toString() ); // => '4 + 5i' arr = new Complex64Array( zeroTo( 10 ) ); v = accessorGetter( dtype( arr ) )( arr, 4 ); -// returns +// returns [ 8.0, 9.0 ] console.log( v.toString() ); // => '8 + 9i' diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/repl.txt b/lib/node_modules/@stdlib/array/base/accessor-getter/docs/repl.txt index 68ead221c90b..b97217735bf7 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/repl.txt +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/docs/repl.txt @@ -44,11 +44,7 @@ -------- > var f = {{alias}}( 'complex64' ); > var v = f( {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] ), 1 ) - - > var r = {{alias:@stdlib/complex/float32/real}}( v ) - 3.0 - > var i = {{alias:@stdlib/complex/float32/imag}}( v ) - 4.0 + [ 3.0, 4.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts index 3e014798ebb0..22cae0051509 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts @@ -58,20 +58,12 @@ type GetArrayLike = ( arr: AccessorArrayLike, 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 -* -* var re = real( v ); -* // returns 3.0 -* -* var im = imag( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ declare function getter( dtype: 'complex128' ): GetComplex128; @@ -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 -* -* var re = realf( v ); -* // returns 3.0 -* -* var im = imagf( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ declare function getter( dtype: 'complex64' ): GetComplex64; diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/examples/index.js b/lib/node_modules/@stdlib/array/base/accessor-getter/examples/index.js index ac592e1caba5..e4b408c5b3ca 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/examples/index.js +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/examples/index.js @@ -26,12 +26,12 @@ var accessorGetter = require( './../lib' ); var arr = new Complex128Array( zeroTo( 10 ) ); var v = accessorGetter( dtype( arr ) )( arr, 2 ); -// returns +// returns [ 4.0, 5.0 ] console.log( '%s', v.toString() ); arr = new Complex64Array( zeroTo( 10 ) ); v = accessorGetter( dtype( arr ) )( arr, 4 ); -// returns +// returns [ 8.0, 9.0 ] console.log( '%s', v.toString() ); diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/lib/index.js b/lib/node_modules/@stdlib/array/base/accessor-getter/lib/index.js index 7590cf316a7b..c5683cf4b0b2 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/lib/index.js +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/lib/index.js @@ -25,8 +25,6 @@ * * @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' ); * @@ -34,13 +32,7 @@ * * var get = getter( dtype( arr ) ); * var v = get( arr, 1 ); -* // returns -* -* var re = realf( v ); -* // returns 3.0 -* -* var im = imagf( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/lib/main.js b/lib/node_modules/@stdlib/array/base/accessor-getter/lib/main.js index c192e6cf19ad..aedbc4c6248b 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/lib/main.js +++ b/lib/node_modules/@stdlib/array/base/accessor-getter/lib/main.js @@ -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 -* -* var re = real( v ); -* // returns 3.0 -* -* var im = imag( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ function getComplex128( arr, idx ) { return arr.get( idx ); @@ -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 -* -* var re = realf( v ); -* // returns 3.0 -* -* var im = imagf( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ function getComplex64( arr, idx ) { return arr.get( idx ); @@ -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 -* -* var re = realf( v ); -* // returns 3.0 -* -* var im = imagf( v ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ function getter( dtype ) { var f = GETTERS[ dtype ];