diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/zfill/README.md index 1ad73ced8746..edba259b4911 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/README.md @@ -35,19 +35,15 @@ var zfill = require( '@stdlib/blas/ext/base/zfill' ); Fills a double-precision complex floating-point strided array `x` with a specified scalar constant `alpha`. ```javascript -var Float64Array = require( '@stdlib/array/float64' ); var Complex128Array = require( '@stdlib/array/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -var x = new Complex128Array( arr ); +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var alpha = new Complex128( 10.0, 10.0 ); zfill( x.length, alpha, x, 1 ); - -var y = x.get( 0 ); -// returns [ 10.0, 10.0 ] +// x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] ``` The function has the following parameters: @@ -60,36 +56,25 @@ The function has the following parameters: The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element ```javascript -var Float64Array = require( '@stdlib/array/float64' ); var Complex128Array = require( '@stdlib/array/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -var x = new Complex128Array( arr ); +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var alpha = new Complex128( 10.0, 10.0 ); zfill( 2, alpha, x, 2 ); - -var y = x.get( 0 ); -// returns [ 10.0, 10.0 ] - -y = x.get( 1 ); -// returns [ 3.0, 4.0 ] +// x => [ 10.0, 10.0, 3.0, 4.0, 10.0, 10.0, 7.0, 8.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript -var Float64Array = require( '@stdlib/array/float64' ); var Complex128Array = require( '@stdlib/array/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -// Create the underlying floating-point array: -var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - // Initial array: -var x0 = new Complex128Array( arr ); +var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // Create an offset view: var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element @@ -99,12 +84,7 @@ var alpha = new Complex128( 10.0, 10.0 ); // Fill every other element: zfill( 2, alpha, x1, 2 ); - -var y = x0.get( 0 ); -// returns [ 1.0, 2.0 ] - -y = x0.get( 1 ); -// returns [ 10.0, 10.0 ] +// x0 => [ 1.0, 2.0, 10.0, 10.0, 5.0, 6.0, 10.0, 10.0 ] ``` #### zfill.ndarray( N, alpha, x, strideX, offsetX ) @@ -112,19 +92,15 @@ y = x0.get( 1 ); Fills a double-precision complex floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics. ```javascript -var Float64Array = require( '@stdlib/array/float64' ); var Complex128Array = require( '@stdlib/array/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -var x = new Complex128Array( arr ); +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var alpha = new Complex128( 10.0, 10.0 ); zfill.ndarray( x.length, alpha, x, 1, 0 ); - -var y = x.get( 0 ); -// returns [ 10.0, 10.0 ] +// x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] ``` The function has the following additional parameters: @@ -134,25 +110,15 @@ The function has the following additional parameters: While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last two elements of the strided array ```javascript -var Float64Array = require( '@stdlib/array/float64' ); var Complex128Array = require( '@stdlib/array/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); -var x = new Complex128Array( arr ); +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var alpha = new Complex128( 10.0, 10.0 ); zfill.ndarray( 2, alpha, x, 1, x.length-2 ); - -var y = x.get( 0 ); -// returns [ 1.0, 2.0 ] - -y = x.get( 1 ); -// returns [ 10.0, 10.0 ] - -y = x.get( 2 ); -// returns [ 10.0, 10.0 ] +// x => [ 1.0, 2.0, 10.0, 10.0, 10.0, 10.0 ] ``` diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/repl.txt index 7f027aca7cc4..6660c9e25c39 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/repl.txt @@ -35,28 +35,23 @@ // Standard Usage: > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 ); - > {{alias}}( x.length, alpha, x, 1 ); - > var z = x.get( 0 ) - [ 5.0, -5.0 ] + > {{alias}}( x.length, alpha, x, 1 ) + [ 5.0, -5.0, 5.0, -5.0 ] // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 ); - > {{alias}}( 2, alpha, x, 2 ); - > z = x.get( 0 ) - [ 5.0, -5.0 ] - > z = x.get( 2 ) - [ 5.0, -5.0 ] + > {{alias}}( 2, alpha, x, 2 ) + [ 5.0, -5.0, 3.0, 4.0, 5.0, -5.0 ] // Using view offsets: > var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 ); - > {{alias}}( 2, alpha, x1, 1 ); - > z = x0.get( 0 ) - [ 1.0, 2.0 ] - > z = x0.get( 1 ) - [ 5.0, -5.0 ] + > {{alias}}( 2, alpha, x1, 1 ) + [ 5.0, -5.0, 5.0, -5.0 ] + > x0 + [ 1.0, 2.0, 5.0, -5.0, 5.0, -5.0 ] {{alias}}.ndarray( N, alpha, x, strideX, offsetX ) @@ -94,18 +89,14 @@ // Standard Usage: > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 ); - > {{alias}}.ndarray( x.length, alpha, x, 1, 0 ); - > var z = x.get( 0 ) - [ 2.0, 2.0 ] + > {{alias}}.ndarray( x.length, alpha, x, 1, 0 ) + [ 2.0, 2.0, 2.0, 2.0 ] // Using an index offset: > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); > alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 ); - > {{alias}}.ndarray( 2, alpha, x, 2, 1 ); - > z = x.get( 0 ) - [ 1.0, 2.0 ] - > z = x.get( 1 ) - [ 5.0, -5.0 ] + > {{alias}}.ndarray( 2, alpha, x, 2, 1 ) + [ 1.0, 2.0, 5.0, -5.0, 5.0, 6.0, 5.0, -5.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/types/index.d.ts index 8637b632f6bf..26c48617fbb7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/docs/types/index.d.ts @@ -37,19 +37,15 @@ interface Routine { * @returns input array * * @example - * var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * - * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var x = new Complex128Array( arr ); + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1 ); - * - * var y = x.get( 0 ); - * // returns [ 10.0, 10.0 ] + * // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ ( N: number, alpha: Complex128, x: Complex128Array, strideX: number ): Complex128Array; @@ -64,19 +60,15 @@ interface Routine { * @returns input array * * @example - * var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * - * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var x = new Complex128Array( arr ); + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * - * zfill( x.length, alpha, x, 1, 0 ); - * - * var y = x.get( 0 ); - * // returns [ 10.0, 10.0 ] + * zfill.ndarray( x.length, alpha, x, 1, 0 ); + * // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ ndarray( N: number, alpha: Complex128, x: Complex128Array, strideX: number, offsetX: number ): Complex128Array; } @@ -91,19 +83,15 @@ interface Routine { * @returns input array * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1 ); -* -* var y = x.get( 0 ); -* // returns [ 10.0, 10.0 ] +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ declare var zfill: Routine; diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/index.js index 4e8d1a9480d6..aa236615046d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/index.js @@ -24,20 +24,16 @@ * @module @stdlib/blas/ext/base/zfill * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * var zfill = require( '@stdlib/blas/ext/base/zfill' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1 ); -* -* var y = x.get( 0 ); -* // returns [ 10.0, 10.0 ] +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.js index d33da443b861..010ffe9c0e93 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.js @@ -43,27 +43,15 @@ var M = 8; * @returns {Complex128Array} input array * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1, 0 ); -* -* var y = x.get( 0 ); -* // returns -* -* var re = real( y ); -* // returns 10.0 -* -* var im = imag( y ); -* // returns 10.0 +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ function zfill( N, alpha, x, strideX, offsetX ) { var view; diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.native.js index 464f8520d920..bddb559968cd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.native.js @@ -37,19 +37,15 @@ var addon = require( './../src/addon.node' ); * @returns {Complex128Array} input array * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1, 0 ); -* -* var y = x.get( 0 ); -* // returns [ 10.0, 10.0 ] +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ function zfill( N, alpha, x, strideX, offsetX ) { var view = reinterpret( x, 0 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.js b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.js index 711a59d91c83..ce6d7c435b8c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.js +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.js @@ -36,19 +36,15 @@ var ndarray = require( './ndarray.js' ); * @returns {Complex128Array} input array * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1 ); -* -* var y = x.get( 0 ); -* // returns [ 10.0, 10.0 ] +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ function zfill( N, alpha, x, strideX ) { return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.native.js b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.native.js index 50b38fb87a27..93ad992710dd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.native.js @@ -36,19 +36,15 @@ var addon = require( './../src/addon.node' ); * @returns {Complex128Array} input array * * @example -* var Float64Array = require( '@stdlib/array/float64' ); * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * -* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); -* var x = new Complex128Array( arr ); +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * * var alpha = new Complex128( 10.0, 10.0 ); * * zfill( x.length, alpha, x, 1 ); -* -* var y = x.get( 0 ); -* // returns [ 10.0, 10.0 ] +* // x => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] */ function zfill( N, alpha, x, strideX ) { var view = reinterpret( x, 0 );