diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/README.md new file mode 100644 index 000000000000..3bf814a792bb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/README.md @@ -0,0 +1,119 @@ + + +# dfill + +> Fill a one-dimensional double-precision floating-point ndarray with a specified scalar constant. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dfill = require( '@stdlib/blas/ext/base/ndarray/dfill' ); +``` + +#### dfill( alpha, arrays ) + +Fills a one-dimensional double-precision floating-point ndarray with a specified scalar constant. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +dfill( 5.0, [ x ] ); +// x => [ 5.0, 5.0, 5.0, 5.0 ] +``` + +The function has the following parameters: + +- **alpha**: scalar constant. +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +## Notes + +- If provided an empty one-dimensional ndarray, the function returns the input ndarray unchanged. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dfill = require( '@stdlib/blas/ext/base/ndarray/dfill' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +dfill( 5.0, [ x ] ); +console.log( ndarray2array( x ) ); +``` + +
+ + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/benchmark/benchmark.js new file mode 100644 index 000000000000..23d3db01f99b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/benchmark/benchmark.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var pkg = require( './../package.json' ).name; +var dfill = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark(len) { + var xbuf; + var x; + + xbuf = uniform(len, -10.0, 10.0, options); + x = new ndarray(options.dtype, xbuf, [len], [1], 0, 'row-major'); + + return benchmark; + + function benchmark(b) { + var d; + var i; + + b.tic(); + for (i = 0; i < b.iterations; i++) { + dfill(i, [x]); + d = getData(x); + if (isnan(d[i % len])) { + b.fail('should not return NaN'); + } + } + b.toc(); + if (isnan(d[i % len])) { + b.fail('should not return NaN'); + } + 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(pkg + ':len=' + len, f); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/repl.txt new file mode 100644 index 000000000000..f63d17069f96 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/repl.txt @@ -0,0 +1,34 @@ + +{{alias}}( alpha, arrays ) + Fills a one-dimensional double-precision floating-point ndarray with a + specified scalar constant. + + Parameters + ---------- + alpha: number + Scalar constant. + + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + x: ndarray + Input ndarray. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0 ] ); + > var dt = 'float64'; + > 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}}( 5.0, [ x ] ); + > xbuf + [ 5.0, 5.0, 5.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/index.d.ts new file mode 100644 index 000000000000..29ac48e06311 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/index.d.ts @@ -0,0 +1,47 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Fills a one-dimensional double-precision floating-point ndarray with a specified scalar constant. +* +* @param alpha - scalar constant +* @param arrays - array-like object containing an input ndarray +* @returns input ndarray +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* dfill( 5.0, [ x ] ); +* // x => [ 5.0, 5.0, 5.0, 5.0 ] +*/ +declare function dfill( alpha: number, arrays: [ float64ndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/test.ts new file mode 100644 index 000000000000..95f52bfdea70 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/docs/types/test.ts @@ -0,0 +1,74 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 dfill = require('./index'); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros([10], { + 'dtype': 'float64' + }); + + dfill(5.0, [x]); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = zeros([10], { + 'dtype': 'float64' + }); + + dfill('10', [x]); // $ExpectError + dfill(true, [x]); // $ExpectError + dfill(false, [x]); // $ExpectError + dfill(null, [x]); // $ExpectError + dfill(undefined, [x]); // $ExpectError + dfill([], [x]); // $ExpectError + dfill({}, [x]); // $ExpectError + dfill((x: number): number => x, [x]); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not an array of ndarrays... +{ + dfill(5.0, '10'); // $ExpectError + dfill(5.0, 10); // $ExpectError + dfill(5.0, true); // $ExpectError + dfill(5.0, false); // $ExpectError + dfill(5.0, null); // $ExpectError + dfill(5.0, undefined); // $ExpectError + dfill(5.0, []); // $ExpectError + dfill(5.0, {}); // $ExpectError + dfill(5.0, (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': 'float64' + }); + + dfill(); // $ExpectError + dfill(5.0); // $ExpectError + dfill(5.0, [x], {}); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/examples/index.js new file mode 100644 index 000000000000..b009bb7808c8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/examples/index.js @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dfill = require( './../lib' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +dfill( 5.0, [ x ] ); +console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/index.js new file mode 100644 index 000000000000..5e7ed7448906 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/index.js @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 floating-point ndarray with a specified scalar constant. +* +* @module @stdlib/blas/ext/base/ndarray/dfill +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var dfill = require( '@stdlib/blas/ext/base/ndarray/dfill' ); +* +* var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* dfill( 5.0, [ x ] ); +* // x => [ 5.0, 5.0, 5.0, 5.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/main.js new file mode 100644 index 000000000000..e4fca9729a13 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/lib/main.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/dfill' ).ndarray; + + +// MAIN // + +/** +* Fills a one-dimensional double-precision floating-point ndarray with a specified scalar constant. +* +* @param {number} alpha - scalar constant +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {ndarray} input ndarray +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* dfill( 5.0, [ x ] ); +* // x => [ 5.0, 5.0, 5.0, 5.0 ] +*/ +function dfill( alpha, arrays ) { + var x = arrays[ 0 ]; + strided( numelDimension( x, 0 ), alpha, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + return x; +} + + +// EXPORTS // + +module.exports = dfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/package.json new file mode 100644 index 000000000000..fa9c8ee8fa3f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/package.json @@ -0,0 +1,66 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/dfill", + "version": "0.0.0", + "description": "Fill a one-dimensional double-precision floating-point ndarray with a specified scalar constant.", + "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", + "constant", + "scalar", + "ndarray", + "float64", + "double" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/test/test.js new file mode 100644 index 000000000000..ad452fd352f9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfill/test/test.js @@ -0,0 +1,161 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 Float64Array = require( '@stdlib/array/float64' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var dfill = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Float64Array} 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( 'float64', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dfill, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 2', function test( t ) { + t.strictEqual( dfill.length, 2, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a one-dimensional ndarray with a specified scalar constant', function test( t ) { + var expected; + var x; + + x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + expected = new Float64Array( [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ] ); + + dfill( 5.0, [ vector( x, 6, 1, 0 ) ] ); + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray', function test( t ) { + var x; + var y; + + x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + y = dfill( 5.0, [ vector( x, 6, 1, 0 ) ] ); + + t.strictEqual( getData( y ), x, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns the input ndarray unchanged', function test( t ) { + var expected; + var x; + + x = new Float64Array( [] ); + expected = new Float64Array( [] ); + + dfill( 5.0, [ vector( x, 0, 1, 0 ) ] ); + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var expected; + var x; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + expected = new Float64Array( [ 5.0, 2.0, 5.0, -7.0, 5.0, 3.0, 5.0, 2.0 ] ); + + dfill( 5.0, [ vector( x, 4, 2, 0 ) ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var expected; + var x; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + expected = new Float64Array( [ 5.0, 2.0, 5.0, -7.0, 5.0, 3.0, 5.0, 2.0 ] ); + + dfill( 5.0, [ vector( x, 4, -2, 6 ) ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var expected; + var x; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + expected = new Float64Array( [ 2.0, 5.0, 2.0, 5.0, -2.0, 5.0, 3.0, 5.0 ] ); + + dfill( 5.0, [ vector( x, 4, 2, 1 ) ] ); + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +});