diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/README.md b/lib/node_modules/@stdlib/blas/ext/linspace/README.md index 037849b7dc8d..e379e154174c 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/README.md +++ b/lib/node_modules/@stdlib/blas/ext/linspace/README.md @@ -35,13 +35,8 @@ var linspace = require( '@stdlib/blas/ext/linspace' ); Returns a new [ndarray][@stdlib/ndarray/ctor] filled with linearly spaced values over a specified interval along one or more [ndarray][@stdlib/ndarray/ctor] dimensions. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); - var x = linspace( [ 4 ], 1.0, 4.0 ); -// returns - -var arr = ndarray2array( x ); -// returns [ 1.0, 2.0, 3.0, 4.0 ] +// returns [ 1.0, 2.0, 3.0, 4.0 ] ``` The function has the following parameters: @@ -63,13 +58,8 @@ The function accepts the following options: By default, the function always includes the end of the interval in the list of values written to an output [ndarray][@stdlib/ndarray/ctor]. To exclude the end of the interval, provide an `endpoint` argument. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); - var x = linspace( [ 4 ], 1.0, 5.0, false ); -// returns - -var arr = ndarray2array( x ); -// returns [ 1.0, 2.0, 3.0, 4.0 ] +// returns [ 1.0, 2.0, 3.0, 4.0 ] ``` When provided scalar or zero-dimensional [ndarray][@stdlib/ndarray/ctor] `start`, `stop`, and `endpoint` arguments, the values are broadcast across all elements in the shape defined by the complement of those dimensions specified by `options.dims`. To specify separate sub-array configurations, provide non-zero-dimensional [ndarray][@stdlib/ndarray/ctor] arguments. @@ -77,45 +67,31 @@ When provided scalar or zero-dimensional [ndarray][@stdlib/ndarray/ctor] `start` ```javascript var array = require( '@stdlib/ndarray/array' ); var BooleanArray = require( '@stdlib/array/bool' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var start = array( [ 1.0, 5.0 ] ); var end = array( [ 3.0, 8.0 ] ); var endpoint = array( new BooleanArray( [ true, false ] ) ); var x = linspace( [ 2, 3 ], start, end, endpoint ); -// returns - -var arr = ndarray2array( x ); -// returns [ [ 1.0, 2.0, 3.0 ], [ 5.0, 6.0, 7.0 ] ] +// returns [ [ 1.0, 2.0, 3.0 ], [ 5.0, 6.0, 7.0 ] ] ``` By default, the function generates linearly spaced values along the last dimension of an output [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); - var x = linspace( [ 2, 2 ], 1.0, 4.0, { 'dims': [ 0, 1 ] }); -// returns - -var arr = ndarray2array( x ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ``` To specify the output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes], provide a `dtype` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); - var x = linspace( [ 4 ], 1.0, 4.0, { 'dtype': 'float32' }); -// returns - -var arr = ndarray2array( x ); -// returns [ 1.0, 2.0, 3.0, 4.0 ] +// returns [ 1.0, 2.0, 3.0, 4.0 ] ``` #### linspace.assign( out, start, stop\[, endpoint]\[, options] ) @@ -123,17 +99,13 @@ var arr = ndarray2array( x ); Fills an [ndarray][@stdlib/ndarray/ctor] with linearly spaced values over a specified interval along one or more [ndarray][@stdlib/ndarray/ctor] dimensions. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var zeros = require( '@stdlib/ndarray/zeros' ); var x = zeros( [ 4 ] ); // returns var out = linspace.assign( x, 1.0, 4.0 ); -// returns - -var arr = ndarray2array( out ); -// returns [ 1.0, 2.0, 3.0, 4.0 ] +// returns [ 1.0, 2.0, 3.0, 4.0 ] var bool = ( x === out ); // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/linspace/docs/repl.txt index 55bac43b2702..bb60e19453ad 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/linspace/docs/repl.txt @@ -128,9 +128,8 @@ Examples -------- - > var out = {{alias}}( [ 4 ], 1.0, 4.0 ); - > {{alias:@stdlib/ndarray/to-array}}( out ) - [ 1.0, 2.0, 3.0, 4.0 ] + > var out = {{alias}}( [ 4 ], 1.0, 4.0 ) + [ 1.0, 2.0, 3.0, 4.0 ] {{alias}}.assign( out, start, stop[, endpoint][, options] ) @@ -220,9 +219,8 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/zeros}}( [ 4 ] ); - > var out = {{alias}}.assign( x, 1.0, 4.0 ); - > {{alias:@stdlib/ndarray/to-array}}( out ) - [ 1.0, 2.0, 3.0, 4.0 ] + > var out = {{alias}}.assign( x, 1.0, 4.0 ) + [ 1.0, 2.0, 3.0, 4.0 ] > var bool = ( out === x ) true diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/linspace/docs/types/index.d.ts index b811d5c83641..05376b7448a8 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/linspace/docs/types/index.d.ts @@ -128,15 +128,10 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, { * 'dtype': 'float64' * }); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, options: OptionsWithDataType ): OutputArray; // TODO: we lose some type specificity here. We could likely improve specificity here by using type maps @@ -150,13 +145,8 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, {} ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, options: Options ): RealOutputArray; // NOTE: we lose some type specificity here, as the output ndarray data type is determined according to type promotion rules @@ -171,15 +161,10 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, true, { * 'dtype': 'float64' * }); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, endpoint: V, options: OptionsWithDataType ): OutputArray; // TODO: we lose some type specificity here. We could likely improve specificity here by using type maps @@ -194,13 +179,8 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0 ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, endpoint?: V, options?: Options ): RealOutputArray; // NOTE: we lose some type specificity here, as the output ndarray data type is determined according to type promotion rules @@ -214,15 +194,10 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, { * 'dtype': 'float64' * }); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, options: OptionsWithDataType ): ComplexOutputArray; // TODO: we lose some type specificity here. We could likely improve specificity here by using type maps @@ -236,13 +211,8 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, {} ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, options: Options ): ComplexOutputArray; /* eslint-disable-line @typescript-eslint/unified-signatures */ // NOTE: we lose some type specificity here, as the output ndarray data type is determined according to type promotion rules @@ -257,15 +227,10 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, true, { * 'dtype': 'float64' * }); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, endpoint: V, options: OptionsWithDataType ): ComplexOutputArray; // TODO: we lose some type specificity here. We could likely improve specificity here by using type maps @@ -280,13 +245,8 @@ interface Linspace { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); - * * var out = linspace( [ 2, 4 ], 0.0, 3.0, true ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ ( shape: number | ArrayLike, start: T, stop: U, endpoint?: V, options?: Options ): ComplexOutputArray; // NOTE: we lose some type specificity here, as the output ndarray data type is determined according to type promotion rules @@ -301,19 +261,15 @@ interface Linspace { * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var x = zeros( [ 2, 4 ] ); * // returns * * var out = linspace.assign( x, 0.0, 3.0 ); - * // returns + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * var bool = ( out === x ); * // returns true - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ assign( out: T, start: Start, stop: Stop, options: BaseOptions ): T; @@ -329,19 +285,15 @@ interface Linspace { * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var x = zeros( [ 2, 4 ] ); * // returns * * var out = linspace.assign( x, 0.0, 3.0 ); - * // returns + * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * var bool = ( out === x ); * // returns true - * - * var arr = ndarray2array( out ); - * // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ assign( out: T, start: Start, stop: Stop, endpoint?: Endpoint, options?: BaseOptions ): T; } @@ -356,29 +308,20 @@ interface Linspace { * @param options - function options * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); -* * var out = linspace( [ 2, 4 ], 0.0, 3.0 ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var x = zeros( [ 2, 4 ] ); * // returns * * var out = linspace.assign( x, 0.0, 3.0 ); -* // returns +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * var bool = ( out === x ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ declare const linspace: Linspace; diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/lib/assign.js b/lib/node_modules/@stdlib/blas/ext/linspace/lib/assign.js index 614913ce8acd..47cba19ad1c0 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/lib/assign.js +++ b/lib/node_modules/@stdlib/blas/ext/linspace/lib/assign.js @@ -67,19 +67,15 @@ var base = require( './base.js' ); * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var x = zeros( [ 2, 4 ] ); * // returns * * var out = assign( x, 0.0, 3.0 ); -* // returns +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * var bool = ( out === x ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ function assign( x, start, stop ) { var endpoint; diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/lib/base.js b/lib/node_modules/@stdlib/blas/ext/linspace/lib/base.js index 78846467f161..07e3ee96b967 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/lib/base.js +++ b/lib/node_modules/@stdlib/blas/ext/linspace/lib/base.js @@ -73,7 +73,6 @@ var options = { * var Float64Array = require( '@stdlib/array/float64' ); * var BooleanArray = require( '@stdlib/array/bool' ); * var array = require( '@stdlib/ndarray/array' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * // Create a data buffer: @@ -110,10 +109,7 @@ var options = { * var out = linspace( x, start, end, endpoint, { * 'dims': [ -1 ] * }); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ 1.0, 2.0, 3.0 ] ], [ [ 4.0, 5.0, 6.0 ] ] ] +* // returns [ [ [ 1.0, 2.0, 3.0 ] ], [ [ 4.0, 5.0, 6.0 ] ] ] */ var linspace = factory( table, [ DTYPES.idtypes0, DTYPES.idtypes1, DTYPES.idtypes2 ], DTYPES.odtypes, options ); // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/lib/index.js b/lib/node_modules/@stdlib/blas/ext/linspace/lib/index.js index ebe9dd7070cb..3078a189d8fa 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/linspace/lib/index.js @@ -24,31 +24,23 @@ * @module @stdlib/blas/ext/linspace * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var linspace = require( '@stdlib/blas/ext/linspace' ); * * var out = linspace( [ 2, 4 ], 0.0, 3.0 ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var linspace = require( '@stdlib/blas/ext/linspace' ); * * var x = zeros( [ 2, 4 ] ); * // returns * * var out = linspace.assign( x, 0.0, 3.0 ); -* // returns +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] * * var bool = ( out === x ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/linspace/lib/main.js b/lib/node_modules/@stdlib/blas/ext/linspace/lib/main.js index 9c40f698a2d0..b3ec91f34242 100644 --- a/lib/node_modules/@stdlib/blas/ext/linspace/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/linspace/lib/main.js @@ -74,13 +74,8 @@ var base = require( './base.js' ); * @returns {ndarray} output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); -* * var out = linspace( [ 2, 4 ], 0.0, 3.0 ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] +* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ] */ function linspace( shape, start, stop ) { var endpoint;