From b401bfe9053ceed1404eb546d733e1306bed3aba Mon Sep 17 00:00:00 2001 From: headlessNode Date: Thu, 23 Apr 2026 02:29:00 +0500 Subject: [PATCH 1/3] feat: add blas/ext/base/ndarray/zunitspace --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../ext/base/ndarray/zunitspace/README.md | 122 ++++++ .../ndarray/zunitspace/benchmark/benchmark.js | 112 ++++++ .../ext/base/ndarray/zunitspace/docs/repl.txt | 36 ++ .../ndarray/zunitspace/docs/types/index.d.ts | 50 +++ .../ndarray/zunitspace/docs/types/test.ts | 63 ++++ .../base/ndarray/zunitspace/examples/index.js | 37 ++ .../ext/base/ndarray/zunitspace/lib/index.js | 49 +++ .../ext/base/ndarray/zunitspace/lib/main.js | 63 ++++ .../ext/base/ndarray/zunitspace/package.json | 73 ++++ .../ext/base/ndarray/zunitspace/test/test.js | 346 ++++++++++++++++++ 10 files changed, 951 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md new file mode 100644 index 000000000000..dc03a5786d63 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md @@ -0,0 +1,122 @@ + + +# zunitspace + +> Fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. + +
+ +
+ + + +
+ +## Usage + +```javascript +var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' ); +``` + +#### zunitspace( arrays ) + +Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. + + + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + +var out = zunitspace( [ x, start ] ); +// returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value. + +
+ + + +
+ +## 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 Complex128 = require( '@stdlib/complex/float64/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' ); + +var xbuf = zeros( 10, 'complex128' ); +var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { + 'dtype': 'complex128' +}); + +console.log( ndarray2array( x ) ); + +zunitspace( [ x, start ] ); +console.log( ndarray2array( x ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js new file mode 100644 index 000000000000..529e2721355c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @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 scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var pkg = require( './../package.json' ).name; +var zunitspace = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'complex128' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var start; + var xbuf; + var x; + + xbuf = zeros( len, options.dtype ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), options.dtype, '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 = zunitspace( [ x, start ] ); + 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/zunitspace/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt new file mode 100644 index 000000000000..c5398f3d9206 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt @@ -0,0 +1,36 @@ + +{{alias}}( arrays ) + Fills a one-dimensional double-precision complex floating-point ndarray with + linearly spaced numeric elements which increment by `1` starting from a + specified value. + + 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 and a + zero-dimensional ndarray containing a starting value. + + Returns + ------- + out: ndarray + Input ndarray. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] ); + > var dt = 'complex128'; + > var sh = [ 2 ]; + > var sx = [ 1 ]; + > var ox = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > var s = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 0.0 ); + > var start = {{alias:@stdlib/ndarray/base/from-scalar}}( s, dt, ord ); + > {{alias}}( [ x, start ] ) + [ [ 3.0, 0.0 ], [ 4.0, 0.0 ] ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts new file mode 100644 index 000000000000..7698fa020b83 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts @@ -0,0 +1,50 @@ +/* +* @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 { complex128ndarray } from '@stdlib/types/ndarray'; + +/** +* Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +* +* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value +* @returns input ndarray +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128 = require( '@stdlib/complex/float64/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* +* var out = zunitspace( [ x, start ] ); +* // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] +*/ +declare function zunitspace( arrays: [ complex128ndarray, complex128ndarray ] ): complex128ndarray; + + +// EXPORTS // + +export = zunitspace; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/test.ts new file mode 100644 index 000000000000..dad1c55cf52c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @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 zunitspace = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'complex128' + }); + const start = zeros( [], { + 'dtype': 'complex128' + }); + + zunitspace( [ x, start ] ); // $ExpectType complex128ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + zunitspace( '10' ); // $ExpectError + zunitspace( 10 ); // $ExpectError + zunitspace( true ); // $ExpectError + zunitspace( false ); // $ExpectError + zunitspace( null ); // $ExpectError + zunitspace( undefined ); // $ExpectError + zunitspace( [] ); // $ExpectError + zunitspace( {} ); // $ExpectError + zunitspace( ( 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': 'complex128' + }); + const start = zeros( [], { + 'dtype': 'complex128' + }); + + zunitspace(); // $ExpectError + zunitspace( [ x, start ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js new file mode 100644 index 000000000000..86785ae628a5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js @@ -0,0 +1,37 @@ +/** +* @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 Complex128 = require( '@stdlib/complex/float64/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var zunitspace = require( './../lib' ); + +var xbuf = zeros( 10, 'complex128' ); +var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { + 'dtype': 'complex128' +}); + +console.log( ndarray2array( x ) ); + +zunitspace( [ x, start ] ); +console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js new file mode 100644 index 000000000000..c79014eef77c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js @@ -0,0 +1,49 @@ +/** +* @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 double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +* +* @module @stdlib/blas/ext/base/ndarray/zunitspace +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128 = require( '@stdlib/complex/float64/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' ); +* +* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* +* var out = zunitspace( [ x, start ] ); +* // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js new file mode 100644 index 000000000000..c30f480f0661 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js @@ -0,0 +1,63 @@ +/** +* @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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +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/zunitspace' ).ndarray; + + +// MAIN // + +/** +* Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +* +* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value +* @returns {ndarray} input ndarray +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128 = require( '@stdlib/complex/float64/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* +* var out = zunitspace( [ x, start ] ); +* // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] +*/ +function zunitspace( arrays ) { + var start = ndarraylike2scalar( arrays[ 1 ] ); + var x = arrays[ 0 ]; + strided( numelDimension( x, 0 ), start, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + return x; +} + + +// EXPORTS // + +module.exports = zunitspace; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/package.json new file mode 100644 index 000000000000..55d37e6c0263 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/zunitspace", + "version": "0.0.0", + "description": "Fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by 1 starting from a specified value.", + "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", + "unitspace", + "unit-space", + "linearly", + "spaced", + "increment", + "strided", + "array", + "ndarray", + "complex128", + "complex", + "double-precision", + "float64" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/test/test.js new file mode 100644 index 000000000000..f76b5af9fafa --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/test/test.js @@ -0,0 +1,346 @@ +/** +* @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 isSameComplex128Array = require( '@stdlib/assert/is-same-complex128array' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var zunitspace = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Complex128Array} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'complex128', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof zunitspace, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( zunitspace.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 a specified value', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 4, 1, 0 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array( [ 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ] ); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function preserves the imaginary component of the starting value', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 4, 1, 0 ); + start = scalar2ndarray( new Complex128( 3.0, -1.5 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array( [ 3.0, -1.5, 4.0, -1.5, 5.0, -1.5, 6.0, -1.5 ] ); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, '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 start; + var xbuf; + var x; + + xbuf = new Complex128Array( [] ); + x = vector( xbuf, 0, 1, 0 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.strictEqual( getData( actual ).length, 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function fills a one-dimensional ndarray containing a single element', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array( [ 0.0, 0.0 ] ); + x = vector( xbuf, 1, 1, 0 ); + start = scalar2ndarray( new Complex128( 5.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array( [ 5.0, 0.0 ] ); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-unit stride', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array([ + 0.0, // 0 + 0.0, // 0 + 9.0, + 9.0, + 0.0, // 1 + 0.0, // 1 + 9.0, + 9.0, + 0.0, // 2 + 0.0, // 2 + 9.0, + 9.0, + 0.0, // 3 + 0.0, // 3 + 9.0, + 9.0 + ]); + x = vector( xbuf, 4, 2, 0 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array([ + 3.0, // 0 + 0.0, // 0 + 9.0, + 9.0, + 4.0, // 1 + 0.0, // 1 + 9.0, + 9.0, + 5.0, // 2 + 0.0, // 2 + 9.0, + 9.0, + 6.0, // 3 + 0.0, // 3 + 9.0, + 9.0 + ]); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a zero stride', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 4, 0, 0 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array( [ 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array([ + 0.0, // 4 + 0.0, // 4 + 0.0, // 3 + 0.0, // 3 + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, // 0 + 0.0 // 0 + ]); + x = vector( xbuf, 5, -1, 4 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array([ + 7.0, // 4 + 0.0, // 4 + 6.0, // 3 + 0.0, // 3 + 5.0, // 2 + 0.0, // 2 + 4.0, // 1 + 0.0, // 1 + 3.0, // 0 + 0.0 // 0 + ]); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-zero offset', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array([ + 9.0, + 9.0, + 9.0, + 9.0, + 0.0, // 0 + 0.0, // 0 + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, // 3 + 0.0 // 3 + ]); + x = vector( xbuf, 4, 1, 2 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array([ + 9.0, + 9.0, + 9.0, + 9.0, + 3.0, // 0 + 0.0, // 0 + 4.0, // 1 + 0.0, // 1 + 5.0, // 2 + 0.0, // 2 + 6.0, // 3 + 0.0 // 3 + ]); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride and non-zero offset', function test( t ) { + var expected; + var actual; + var start; + var xbuf; + var x; + + xbuf = new Complex128Array([ + 9.0, + 9.0, + 0.0, // 2 + 0.0, // 2 + 9.0, + 9.0, + 0.0, // 1 + 0.0, // 1 + 9.0, + 9.0, + 0.0, // 0 + 0.0 // 0 + ]); + x = vector( xbuf, 3, -2, 5 ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); + + actual = zunitspace( [ x, start ] ); + t.strictEqual( actual, x, 'returns expected value' ); + + expected = new Complex128Array([ + 9.0, + 9.0, + 5.0, // 2 + 0.0, // 2 + 9.0, + 9.0, + 4.0, // 1 + 0.0, // 1 + 9.0, + 9.0, + 3.0, // 0 + 0.0 // 0 + ]); + t.strictEqual( isSameComplex128Array( getData( actual ), expected ), true, 'returns expected value' ); + + t.end(); +}); From c17403c1299381c577f4b4f4ad0eef49de602d4e Mon Sep 17 00:00:00 2001 From: headlessNode Date: Sat, 25 Apr 2026 14:49:22 +0500 Subject: [PATCH 2/3] fix: apply suggestions from code review --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../ext/base/ndarray/zunitspace/README.md | 22 +++++++++---------- .../ndarray/zunitspace/benchmark/benchmark.js | 20 +++++------------ .../ext/base/ndarray/zunitspace/docs/repl.txt | 10 ++------- .../ndarray/zunitspace/docs/types/index.d.ts | 21 ++++++++++++------ .../base/ndarray/zunitspace/examples/index.js | 10 ++++----- .../ext/base/ndarray/zunitspace/lib/index.js | 12 +++++----- .../ext/base/ndarray/zunitspace/lib/main.js | 21 ++++++++++++------ 7 files changed, 56 insertions(+), 60 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md index dc03a5786d63..017fdfb0158c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md @@ -43,15 +43,15 @@ Fills a one-dimensional double-precision complex floating-point ndarray with lin ```javascript -var Complex128Array = require( '@stdlib/array/complex128' ); +var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); -var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +var x = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); -var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { + 'dtype': 'complex128' +}); var out = zunitspace( [ x, start ] ); // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] @@ -82,21 +82,19 @@ The function has the following parameters: ```javascript -var zeros = require( '@stdlib/array/zeros' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' ); -var xbuf = zeros( 10, 'complex128' ); -var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var x = new Complex128Vector( 10 ); +console.log( ndarray2array( x ) ); + var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { 'dtype': 'complex128' }); -console.log( ndarray2array( x ) ); - zunitspace( [ x, start ] ); console.log( ndarray2array( x ) ); ``` diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js index 529e2721355c..e80647a2fd2c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/benchmark/benchmark.js @@ -21,23 +21,15 @@ // 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 scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); +var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var pkg = require( './../package.json' ).name; var zunitspace = require( './../lib' ); -// VARIABLES // - -var options = { - 'dtype': 'complex128' -}; - - // FUNCTIONS // /** @@ -49,12 +41,12 @@ var options = { */ function createBenchmark( len ) { var start; - var xbuf; var x; - xbuf = zeros( len, options.dtype ); - x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); - start = scalar2ndarray( new Complex128( 3.0, 0.0 ), options.dtype, 'row-major' ); + start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { + 'dtype': 'complex128' + }); + x = new Complex128Vector( len ); return benchmark; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt index c5398f3d9206..6aa472ab911d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt @@ -20,15 +20,9 @@ Examples -------- - > var xbuf = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] ); - > var dt = 'complex128'; - > var sh = [ 2 ]; - > var sx = [ 1 ]; - > var ox = 0; - > var ord = 'row-major'; - > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > var x = new {{alias:@stdlib/ndarray/vector/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] ); > var s = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 0.0 ); - > var start = {{alias:@stdlib/ndarray/base/from-scalar}}( s, dt, ord ); + > var start = {{alias:@stdlib/ndarray/from-scalar}}( s, { 'dtype': 'complex128' } ); > {{alias}}( [ x, start ] ) [ [ 3.0, 0.0 ], [ 4.0, 0.0 ] ] diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts index 7698fa020b83..d60f2fadae1a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/types/index.d.ts @@ -25,19 +25,26 @@ import { complex128ndarray } from '@stdlib/types/ndarray'; /** * Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. * -* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a zero-dimensional ndarray containing a starting value. +* +* @param arrays - array-like object containing ndarrays * @returns input ndarray * * @example -* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * -* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); -* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* var x = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); * -* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { +* 'dtype': 'complex128' +* }); * * var out = zunitspace( [ x, start ] ); * // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js index 86785ae628a5..17c2228b41e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/examples/index.js @@ -18,20 +18,18 @@ 'use strict'; -var zeros = require( '@stdlib/array/zeros' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var zunitspace = require( './../lib' ); -var xbuf = zeros( 10, 'complex128' ); -var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var x = new Complex128Vector( 10 ); +console.log( ndarray2array( x ) ); + var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { 'dtype': 'complex128' }); -console.log( ndarray2array( x ) ); - zunitspace( [ x, start ] ); console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js index c79014eef77c..fbe3ff38b6cb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/index.js @@ -24,16 +24,16 @@ * @module @stdlib/blas/ext/base/ndarray/zunitspace * * @example -* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' ); * -* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); -* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* var x = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); * -* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { +* 'dtype': 'complex128' +* }); * * var out = zunitspace( [ x, start ] ); * // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js index c30f480f0661..7ab84e312266 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/lib/main.js @@ -33,19 +33,26 @@ var strided = require( '@stdlib/blas/ext/base/zunitspace' ).ndarray; /** * Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. * -* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a zero-dimensional ndarray containing a starting value. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays * @returns {ndarray} input ndarray * * @example -* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * -* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); -* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* var x = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); * -* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), 'complex128', 'row-major' ); +* var start = scalar2ndarray( new Complex128( 3.0, 0.0 ), { +* 'dtype': 'complex128' +* }); * * var out = zunitspace( [ x, start ] ); * // returns [ [ 3.0, 0.0 ], [ 4.0, 0.0 ], [ 5.0, 0.0 ], [ 6.0, 0.0 ] ] From c1569648165c02cabe7c5083702044f9393b3be3 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 26 Apr 2026 04:28:49 -0700 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- .../@stdlib/blas/ext/base/ndarray/zunitspace/README.md | 5 ++++- .../@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt | 6 ++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md index 017fdfb0158c..2cf6fcfd7082 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/README.md @@ -59,7 +59,10 @@ var out = zunitspace( [ x, start ] ); The function has the following parameters: -- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value. +- **arrays**: array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a zero-dimensional ndarray containing a starting value. diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt index 6aa472ab911d..b413f1c301af 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/zunitspace/docs/repl.txt @@ -10,8 +10,10 @@ Parameters ---------- arrays: ArrayLikeObject - Array-like object containing a one-dimensional input ndarray and a - zero-dimensional ndarray containing a starting value. + Array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a zero-dimensional ndarray containing a starting value. Returns -------