diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/README.md new file mode 100644 index 000000000000..c74fc2065a6b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/README.md @@ -0,0 +1,110 @@ + + +# gzeroTo + +> Fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero. + +
+ +
+ + + +
+ +## Usage + +```javascript +var gzeroTo = require( '@stdlib/blas/ext/base/ndarray/gzero-to' ); +``` + +#### gzeroTo( arrays ) + +Fills a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero. + +```javascript +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = [ 0.0, 0.0, 0.0, 0.0 ]; +var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +// returns [ 0.0, 0.0, 0.0, 0.0 ] + +var out = gzeroTo( [ x ] ); +// returns [ 0.0, 1.0, 2.0, 3.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +## Notes + +- The input ndarray is modified **in-place** (i.e., the input ndarray is **mutated**). + +
+ + + +
+ +## Examples + + + +```javascript +var zeros = require( '@stdlib/array/zeros' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gzeroTo = require( '@stdlib/blas/ext/base/ndarray/gzero-to' ); + +var xbuf = zeros( 10, 'generic' ); +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +gzeroTo( [ x ] ); +console.log( ndarray2array( x ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/benchmark/benchmark.js new file mode 100644 index 000000000000..f1f4be906bee --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/benchmark/benchmark.js @@ -0,0 +1,108 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var zeros = require( '@stdlib/array/zeros' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var pkg = require( './../package.json' ).name; +var gzeroTo = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var x; + + xbuf = zeros( len, options.dtype ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = gzeroTo( [ x ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/repl.txt new file mode 100644 index 000000000000..0e0d2146e046 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( arrays ) + Fills a one-dimensional ndarray with linearly spaced numeric elements which + increment by `1` starting from zero. + + The input ndarray is modified *in-place* (i.e., the input ndarray is + *mutated*). + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: ndarray + Input ndarray. + + Examples + -------- + > var xbuf = [ 0.0, 0.0, 0.0, 0.0 ]; + > var dt = 'generic'; + > var sh = [ xbuf.length ]; + > var sx = [ 1 ]; + > var ox = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > {{alias}}( [ x ] ) + [ 0.0, 1.0, 2.0, 3.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/index.d.ts new file mode 100644 index 000000000000..2e62a998d90a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/index.d.ts @@ -0,0 +1,46 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { typedndarray } from '@stdlib/types/ndarray'; + +/** +* Fills a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero. +* +* @param arrays - array-like object containing a one-dimensional input ndarray +* @returns input ndarray +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* // returns [ 0.0, 0.0, 0.0, 0.0 ] +* +* var out = gzeroTo( [ x ] ); +* // returns [ 0.0, 1.0, 2.0, 3.0 ] +*/ +declare function gzeroTo = typedndarray>( arrays: [ T ] ): T; + + +// EXPORTS // + +export = gzeroTo; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/test.ts new file mode 100644 index 000000000000..dd7b68f14a68 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/docs/types/test.ts @@ -0,0 +1,57 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import gzeroTo = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + gzeroTo( [ x ] ); // $ExpectType genericndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + gzeroTo( '10' ); // $ExpectError + gzeroTo( 10 ); // $ExpectError + gzeroTo( true ); // $ExpectError + gzeroTo( false ); // $ExpectError + gzeroTo( null ); // $ExpectError + gzeroTo( undefined ); // $ExpectError + gzeroTo( [] ); // $ExpectError + gzeroTo( {} ); // $ExpectError + gzeroTo( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + gzeroTo(); // $ExpectError + gzeroTo( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/examples/index.js new file mode 100644 index 000000000000..3f47add4a9ff --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/examples/index.js @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var zeros = require( '@stdlib/array/zeros' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gzeroTo = require( './../lib' ); + +var xbuf = zeros( 10, 'generic' ); +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +gzeroTo( [ x ] ); +console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/index.js new file mode 100644 index 000000000000..913ab165f040 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/index.js @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero. +* +* @module @stdlib/blas/ext/base/ndarray/gzero-to +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var gzeroTo = require( '@stdlib/blas/ext/base/ndarray/gzero-to' ); +* +* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* // returns [ 0.0, 0.0, 0.0, 0.0 ] +* +* var out = gzeroTo( [ x ] ); +* // returns [ 0.0, 1.0, 2.0, 3.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/main.js new file mode 100644 index 000000000000..9337dc94621c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/lib/main.js @@ -0,0 +1,57 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/gzero-to' ).ndarray; + + +// MAIN // + +/** +* Fills a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero. +* +* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray +* @returns {ndarray} input ndarray +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* // returns [ 0.0, 0.0, 0.0, 0.0 ] +* +* var out = gzeroTo( [ x ] ); +* // returns [ 0.0, 1.0, 2.0, 3.0 ] +*/ +function gzeroTo( arrays ) { + var x = arrays[ 0 ]; + strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + return x; +} + + +// EXPORTS // + +module.exports = gzeroTo; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/package.json new file mode 100644 index 000000000000..f744da95ae82 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/gzero-to", + "version": "0.0.0", + "description": "Fill a one-dimensional ndarray with linearly spaced numeric elements which increment by 1 starting from zero.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "fill", + "zero", + "zeroto", + "zero-to", + "linearly", + "spaced", + "increment", + "strided", + "array", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/test/test.js new file mode 100644 index 000000000000..6797c726f494 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gzero-to/test/test.js @@ -0,0 +1,139 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var gzeroTo = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof gzeroTo, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( gzeroTo.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a one-dimensional ndarray with linearly spaced numeric elements which increment by 1 starting from zero', function test( t ) { + var actual; + var x; + + x = ndarray( 'generic', [ 0.0, 0.0, 0.0, 0.0 ], [ 4 ], [ 1 ], 0, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 0.0, 1.0, 2.0, 3.0 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray is empty', function test( t ) { + var actual; + var x; + + x = ndarray( 'generic', [], [ 0 ], [ 1 ], 0, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function fills a one-dimensional ndarray containing a single element', function test( t ) { + var actual; + var x; + + x = ndarray( 'generic', [ 5.0 ], [ 1 ], [ 1 ], 0, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 0.0 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-unit stride', function test( t ) { + var actual; + var xbuf; + var x; + + xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; + x = ndarray( 'generic', xbuf, [ 4 ], [ 2 ], 0, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride', function test( t ) { + var actual; + var xbuf; + var x; + + xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; + x = ndarray( 'generic', xbuf, [ 5 ], [ -1 ], 4, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 4.0, 3.0, 2.0, 1.0, 0.0 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + + xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; + x = ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 2, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 0.0, 0.0, 0.0, 1.0, 2.0, 3.0 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride and non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + + xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; + x = ndarray( 'generic', xbuf, [ 5 ], [ -2 ], 9, 'row-major' ); + + actual = gzeroTo( [ x ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), [ 0.0, 4.0, 0.0, 3.0, 0.0, 2.0, 0.0, 1.0, 0.0, 0.0 ], 'returns expected value' ); + + t.end(); +});