diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/README.md b/lib/node_modules/@stdlib/ndarray/flatten-by/README.md index 54ddcbf2336c..d89e6e6d6bc6 100644 --- a/lib/node_modules/@stdlib/ndarray/flatten-by/README.md +++ b/lib/node_modules/@stdlib/ndarray/flatten-by/README.md @@ -42,7 +42,6 @@ Flattens an [ndarray][@stdlib/ndarray/ctor] according to a callback function. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function scale( value ) { return value * 2.0; @@ -52,10 +51,7 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); // returns var y = flattenBy( x, scale ); -// returns - -var arr = ndarray2array( y ); -// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] ``` The function accepts the following arguments: @@ -84,7 +80,6 @@ By default, the function flattens all dimensions of the input [ndarray][@stdlib/ ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function scale( value ) { return value * 2.0; @@ -98,17 +93,13 @@ var opts = { }; var y = flattenBy( x, opts, scale ); -// returns - -var arr = ndarray2array( y ); -// returns [ [ 2.0, 4.0 ], [ 6.0, 8.0 ], [ 10.0, 12.0 ] ] +// returns [ [ 2.0, 4.0 ], [ 6.0, 8.0 ], [ 10.0, 12.0 ] ] ``` By default, the input [ndarray][@stdlib/ndarray/ctor] is flattened in lexicographic order. To flatten elements in a different order, specify the `order` option. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function scale( value ) { return value * 2.0; @@ -122,10 +113,7 @@ var opts = { }; var y = flattenBy( x, opts, scale ); -// returns - -var arr = ndarray2array( y ); -// returns [ 2.0, 6.0, 10.0, 4.0, 8.0, 12.0 ] +// returns [ 2.0, 6.0, 10.0, 4.0, 8.0, 12.0 ] ``` By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option. @@ -133,7 +121,6 @@ By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred f ```javascript var array = require( '@stdlib/ndarray/array' ); var dtype = require( '@stdlib/ndarray/dtype' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function scale( value ) { return value * 2.0; @@ -146,13 +133,10 @@ var opts = { 'dtype': 'float32' }; var y = flattenBy( x, opts, scale ); -// returns +// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] var dt = String( dtype( y ) ); // returns 'float32' - -var arr = ndarray2array( y ); -// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] ``` To set the callback function execution context, provide a `thisArg`. @@ -161,7 +145,6 @@ To set the callback function execution context, provide a `thisArg`. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function scale( value ) { this.count += 1; @@ -176,10 +159,7 @@ var ctx = { }; var y = flattenBy( x, scale, ctx ); -// returns - -var arr = ndarray2array( y ); -// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] var count = ctx.count; // returns 6 diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/flatten-by/docs/repl.txt index 00c968f90a31..fe7810adda23 100644 --- a/lib/node_modules/@stdlib/ndarray/flatten-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/flatten-by/docs/repl.txt @@ -45,9 +45,8 @@ -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); > function f ( v ) { return v * 2.0 }; - > var y = {{alias}}( x, f ); - > var arr = {{alias:@stdlib/ndarray/to-array}}( y ) - [ 2.0, 4.0, 6.0, 8.0 ] + > var y = {{alias}}( x, f ) + [ 2.0, 4.0, 6.0, 8.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts index 980058910e6f..06cc99634c9c 100644 --- a/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts @@ -118,7 +118,6 @@ type Options = BaseOptions & { * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function scale( value ) { * return value * 2.0; @@ -133,10 +132,7 @@ type Options = BaseOptions & { * // returns * * var y = flattenBy( x, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ declare function flattenBy = typedndarray, ThisArg = unknown>( x: T, fcn: Callback, thisArg?: ThisParameterType> ): T; @@ -151,7 +147,6 @@ declare function flattenBy = typedndarray * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function identity( value ) { * return value; @@ -181,7 +176,6 @@ declare function flattenBy * * var y = flattenBy( x, invert ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ false, true, false, true, false, true ] +* // returns [ false, true, false, true, false, true ] */ declare function flattenBy = typedndarray, ThisArg = unknown>( x: T, fcn: Callback, thisArg?: ThisParameterType> ): T; @@ -213,7 +204,6 @@ declare function flattenBy = typedndarray = typedndarray * * var y = flattenBy( x, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ declare function flattenBy = genericndarray, V = unknown, W extends genericndarray = genericndarray, ThisArg = unknown>( x: U, fcn: Callback, thisArg?: ThisParameterType> ): W; @@ -250,7 +237,6 @@ declare function flattenBy = genericnda * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function scale( value ) { * return value * 2.0; @@ -269,10 +255,7 @@ declare function flattenBy = genericnda * }; * * var y = flattenBy( x, opts, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ declare function flattenBy = typedndarray, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback, thisArg?: ThisParameterType> ): T; @@ -291,7 +274,6 @@ declare function flattenBy = typedndarray * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function identity( value ) { * return value; @@ -329,7 +311,6 @@ declare function flattenBy -* -* var arr = ndarray2array( y ); -* // returns [ false, true, false, true, false, true ] +* // returns [ false, true, false, true, false, true ] */ declare function flattenBy = typedndarray, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback, thisArg?: ThisParameterType> ): T; @@ -369,7 +347,6 @@ declare function flattenBy = typedndarray = typedndarray -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ declare function flattenBy = genericndarray, V = unknown, W extends genericndarray = genericndarray, ThisArg = unknown>( x: U, options: BaseOptions, fcn: Callback, thisArg?: ThisParameterType> ): W; @@ -410,7 +384,6 @@ declare function flattenBy = genericnda * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function scale( value ) { * return value * 2.0; @@ -429,10 +402,7 @@ declare function flattenBy = genericnda * }; * * var y = flattenBy( x, opts, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ declare function flattenBy | genericndarray = typedndarray, V = unknown, W extends keyof DataTypeMap = 'generic', ThisArg = unknown>( x: U, options: Options, fcn: Callback, thisArg?: ThisParameterType> ): DataTypeMap[W]; diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js index 89325df3156c..4e2b2f1c468d 100644 --- a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js @@ -25,7 +25,6 @@ * * @example * var array = require( '@stdlib/ndarray/array' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var flattenBy = require( '@stdlib/ndarray/flatten-by' ); * * function scale( value ) { @@ -36,10 +35,7 @@ * // returns * * var y = flattenBy( x, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js index 6efa0142188a..445c4b90e74e 100644 --- a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js @@ -66,7 +66,6 @@ var COL_MAJOR = 'column-major'; * * @example * var array = require( '@stdlib/ndarray/array' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * function scale( value ) { * return value * 2.0; @@ -76,10 +75,7 @@ var COL_MAJOR = 'column-major'; * // returns * * var y = flattenBy( x, scale ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] +* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ] */ function flattenBy( x, options, fcn, thisArg ) { var hasOpts;