From 9b8ac7bc9c8957074c168ee26ae71b1cd65b1c08 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Thu, 8 Jan 2026 13:43:17 +0000 Subject: [PATCH 1/5] feat(stats): add ndarray variant for cuminabs --- 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 --- --- .../stats/base/ndarray/cuminabs/README.md | 125 +++++++++++ .../ndarray/cuminabs/benchmark/benchmark.js | 112 +++++++++ .../stats/base/ndarray/cuminabs/docs/repl.txt | 34 +++ .../ndarray/cuminabs/docs/types/index.d.ts | 57 +++++ .../base/ndarray/cuminabs/docs/types/test.ts | 63 ++++++ .../base/ndarray/cuminabs/examples/index.js | 37 +++ .../stats/base/ndarray/cuminabs/lib/index.js | 54 +++++ .../stats/base/ndarray/cuminabs/lib/main.js | 68 ++++++ .../stats/base/ndarray/cuminabs/package.json | 71 ++++++ .../stats/base/ndarray/cuminabs/test/test.js | 212 ++++++++++++++++++ 10 files changed, 833 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md new file mode 100644 index 000000000000..b9e488fb8fa1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md @@ -0,0 +1,125 @@ + + +# cuminabs + +> Compute the cumulative minimum absolute value of a one-dimensional ndarray. + +
+ +
+ + + +
+ +## Usage + +```javascript +var cuminabs = require( '@stdlib/stats/base/ndarray/cuminabs' ); +``` + +#### cuminabs( arrays ) + +Computes the cumulative minimum absolute value of a one-dimensional ndarray. + +```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; +var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var ybuf = [ 0.0, 0.0, 0.0, 0.0 ]; +var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = cuminabs( [ x, y ] ); +// returns + +var bool = ( v === y ); +// returns true + +var arr = ndarray2array( v ); +// returns [ 1.0, 1.0, 1.0, 1.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray and a one-dimensional output ndarray. + +
+ + + +
+ +## Notes + +- If provided an empty one-dimensional input ndarray, the function returns the output ndarray unchanged. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var zerosLike = require( '@stdlib/ndarray/zeros-like' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var cuminabs = require( '@stdlib/stats/base/ndarray/cuminabs' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'generic' +}); +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var y = zerosLike( x ); +console.log( ndarray2array( y ) ); + +var v = cuminabs( [ x, y ] ); +console.log( ndarray2array( v ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js new file mode 100644 index 000000000000..18feaf93a51b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var zeros = require( '@stdlib/array/zeros' ); +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 pkg = require( './../package.json' ).name; +var cuminabs = 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 ybuf; + var x; + var y; + + // Include negative values so abs() matters: + xbuf = uniform( len, -10.0, 10.0, options ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + ybuf = zeros( len, options.dtype ); + y = new ndarray( options.dtype, ybuf, [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = cuminabs( [ x, y ] ); + if ( typeof v !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + + // Check final cumulative value: + if ( isnan( v.get( len-1 ) ) ) { + 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt new file mode 100644 index 000000000000..40566e4077f9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt @@ -0,0 +1,34 @@ +{{alias}}( arrays ) + Computes the cumulative minimum absolute value of a one-dimensional ndarray. + + If provided an empty input ndarray, the function returns the output ndarray + unchanged. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray and a one- + dimensional output ndarray. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var xbuf = [ 1.0, -2.0, 2.0 ]; + > var ybuf = [ 0.0, 0.0, 0.0 ]; + > var dt = 'generic'; + > var sh = [ xbuf.length ]; + > var st = [ 1 ]; + > var oo = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); + > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); + > {{alias}}( [ x, y ] ); + > {{alias:@stdlib/ndarray/to-array}}( y ) + [ 1.0, 1.0, 1.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts new file mode 100644 index 000000000000..839fc69a6bf0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts @@ -0,0 +1,57 @@ +/* +* @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 { ndarray, typedndarray } from '@stdlib/types/ndarray'; + +/** +* Computes the cumulative minimum absolute value of a one-dimensional ndarray. +* +* @param arrays - array-like object containing an input ndarray and an output ndarray +* @returns output ndarray +* +* @example +* var ndarray2array = require( '@stdlib/ndarray/to-array' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = cuminabs( [ x, y ] ); +* // returns +* +* var bool = ( v === y ); +* // returns true +* +* var arr = ndarray2array( v ); +* // returns [ 1.0, 1.0, 1.0, 1.0 ] +*/ +declare function cuminabs< + T extends typedndarray = typedndarray +>( arrays: [ ndarray, T ] ): T; + + +// EXPORTS // + +export = cuminabs; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts new file mode 100644 index 000000000000..6107f1ef4ae9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @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 cuminabs = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + const y = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + cuminabs( [ x, y ] ); // $ExpectType genericndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + cuminabs( '10' ); // $ExpectError + cuminabs( 10 ); // $ExpectError + cuminabs( true ); // $ExpectError + cuminabs( false ); // $ExpectError + cuminabs( null ); // $ExpectError + cuminabs( undefined ); // $ExpectError + cuminabs( [] ); // $ExpectError + cuminabs( {} ); // $ExpectError + cuminabs( ( 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' + }); + const y = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + cuminabs(); // $ExpectError + cuminabs( [ x, y ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js new file mode 100644 index 000000000000..3557c0be4e89 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js @@ -0,0 +1,37 @@ +/** +* @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 zerosLike = require( '@stdlib/ndarray/zeros-like' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var cuminabs = require( './../lib' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'generic' +}); +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var y = zerosLike( x ); +console.log( ndarray2array( y ) ); + +var v = cuminabs( [ x, y ] ); +console.log( ndarray2array( v ) ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js new file mode 100644 index 000000000000..2834521f3882 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js @@ -0,0 +1,54 @@ +/** +* @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'; + +/** +* Compute the cumulative minimum absolute value of a one-dimensional ndarray. +* +* @module @stdlib/stats/base/ndarray/cuminabs +* +* @example +* var ndarray2array = require( '@stdlib/ndarray/to-array' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var cuminabs = require( '@stdlib/stats/base/ndarray/cuminabs' ); +* +* var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = cuminabs( [ x, y ] ); +* // returns +* +* var bool = ( v === y ); +* // returns true +* +* var arr = ndarray2array( v ); +* // returns [ 1.0, 1.0, 1.0, 1.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js new file mode 100644 index 000000000000..8108e204edc1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js @@ -0,0 +1,68 @@ +/** +* @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/stats/base/cuminabs' ).ndarray; + + +// MAIN // + +/** +* Computes the cumulative minimum absolute value of a one-dimensional ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray and an output ndarray +* @returns {ndarrayLike} output ndarray +* +* @example +* var ndarray2array = require( '@stdlib/ndarray/to-array' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = [ 0.0, 0.0, 0.0, 0.0 ]; +* var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = cuminabs( [ x, y ] ); +* // returns +* +* var bool = ( v === y ); +* // returns true +* +* var arr = ndarray2array( v ); +* // returns [ 1.0, 1.0, 1.0, 1.0 ] +*/ +function cuminabs( arrays ) { + var x = arrays[ 0 ]; + var y = arrays[ 1 ]; + + strided(numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y )); + return y; +} + + +// EXPORTS // + +module.exports = cuminabs; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/package.json new file mode 100644 index 000000000000..89c47be0305f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/stats/base/ndarray/cuminabs", + "version": "0.0.0", + "description": "Compute the cumulative minimum absolute value of a one-dimensional ndarray.", + "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", + "statistics", + "stats", + "mathematics", + "math", + "cumulative", + "accumulate", + "minimum", + "min", + "absolute", + "abs", + "range", + "extremes", + "domain", + "extent", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js new file mode 100644 index 000000000000..98faf37d012d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js @@ -0,0 +1,212 @@ +/** +* @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 isSameArray = require( '@stdlib/assert/is-same-array' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var zerosLike = require( '@stdlib/ndarray/zeros-like' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var cuminabs = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Array} 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( 'generic', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cuminabs, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( cuminabs.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the cumulative minimum absolute value of a one-dimensional ndarray', function test( t ) { + var expected; + var xbuf; + var x; + var y; + var v; + + xbuf = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + x = vector( xbuf, 6, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + expected = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0 ]; + + t.strictEqual( v, y, 'returns output array' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + + xbuf = [ -4.0, -5.0 ]; + x = vector( xbuf, 2, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + expected = [ 4.0, 4.0 ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + + xbuf = [ -0.0, 0.0, -0.0 ]; + x = vector( xbuf, 3, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + expected = [ 0.0, 0.0, 0.0 ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + + xbuf = [ NaN ]; + x = vector( xbuf, 1, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + expected = [ NaN ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + + xbuf = [ NaN, NaN ]; + x = vector( xbuf, 2, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + expected = [ NaN, NaN ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns the output array unchanged', function test( t ) { + var x; + var y; + var v; + + x = vector( [], 0, 1, 0 ); + y = zerosLike( x ); + + v = cuminabs( [ x, y ] ); + + t.strictEqual( v, y, 'returns output array' ); + t.strictEqual( getData( v ).length, 0, 'output array is empty' ); + t.end(); +}); + +tape( 'the function supports non-unit strides', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + var i; + + xbuf = [ + 1.0, // 0 + 2.0, + -2.0, // 1 + -7.0, + -3.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + x = vector( xbuf, 4, 2, 0 ); + + ybuf = []; + for ( i = 0; i < 8; i++ ) { + ybuf.push( 0.0 ); + } + y = vector( ybuf, 4, 2, 0 ); + + v = cuminabs( [ x, y ] ); + + expected = [ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0, + 2.0, // 2 + 0.0, + 2.0, // 3 + 0.0 + ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.end(); +}); + +tape( 'the function supports negative strides and offsets', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + var i; + + xbuf = [ + 1.0, // 2 + -2.0, + 3.0, // 1 + 4.0, + -5.0 // 0 + ]; + x = vector( xbuf, 3, -2, 4 ); + + ybuf = []; + for ( i = 0; i < 5; i++ ) { + ybuf.push( 0.0 ); + } + y = vector( ybuf, 3, -1, 2 ); + + v = cuminabs( [ x, y ] ); + + expected = [ + 5.0, // 2 + 2.0, // 1 + 1.0, // 0 + 0.0, + 0.0 + ]; + + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.end(); +}); From b8c016cf5fc050b9fb5a6fffc4280752985a9ee3 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Thu, 8 Jan 2026 13:56:04 +0000 Subject: [PATCH 2/5] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/examples/index.js | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/lib/index.js | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/lib/main.js | 2 +- .../@stdlib/stats/base/ndarray/cuminabs/test/test.js | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md index b9e488fb8fa1..f99d4d161577 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js index 18feaf93a51b..814b978edc84 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts index 839fc69a6bf0..ef153b07e07c 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts index 6107f1ef4ae9..2fd77e82c260 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js index 3557c0be4e89..f9905791f1df 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js index 2834521f3882..85481850c43a 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js index 8108e204edc1..a87fb42a14b1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js index 98faf37d012d..7e746aefff80 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. From 873ef9c62b4e4a51336c0ddde879b56ff9076913 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Thu, 8 Jan 2026 14:15:36 +0000 Subject: [PATCH 3/5] feat(stats): add ndarray variant for cuminabs --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/cuminabs/test/test.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js index 7e746aefff80..2c0f3d8adb7a 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js @@ -159,13 +159,13 @@ tape( 'the function supports non-unit strides', function test( t ) { v = cuminabs( [ x, y ] ); expected = [ - 1.0, // 0 + 1.0, 0.0, - 2.0, // 1 + 1.0, 0.0, - 2.0, // 2 + 1.0, 0.0, - 2.0, // 3 + 1.0, 0.0 ]; @@ -200,9 +200,9 @@ tape( 'the function supports negative strides and offsets', function test( t ) { v = cuminabs( [ x, y ] ); expected = [ - 5.0, // 2 - 2.0, // 1 - 1.0, // 0 + 1.0, + 3.0, + 5.0, 0.0, 0.0 ]; From 90965cfe70ae8d615a80d74a234000f955bccf65 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 9 Jan 2026 17:42:21 +0000 Subject: [PATCH 4/5] docs(stats): align cuminabs ndarray with stdlib conventions --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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 --- --- .../stats/base/ndarray/cuminabs/docs/repl.txt | 2 ++ .../base/ndarray/cuminabs/docs/types/index.d.ts | 4 +--- .../stats/base/ndarray/cuminabs/test/test.js | 14 +++++++------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt index 40566e4077f9..da92883c3fe7 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/repl.txt @@ -1,3 +1,4 @@ + {{alias}}( arrays ) Computes the cumulative minimum absolute value of a one-dimensional ndarray. @@ -32,3 +33,4 @@ See Also -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts index ef153b07e07c..e58f57d9b418 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts @@ -47,9 +47,7 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray'; * var arr = ndarray2array( v ); * // returns [ 1.0, 1.0, 1.0, 1.0 ] */ -declare function cuminabs< - T extends typedndarray = typedndarray ->( arrays: [ ndarray, T ] ): T; +declare function cuminabs = typedndarray>( arrays: [ ndarray, T ] ): T; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js index 2c0f3d8adb7a..8af463b7afaa 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js @@ -73,7 +73,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di expected = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0 ]; t.strictEqual( v, y, 'returns output array' ); - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); xbuf = [ -4.0, -5.0 ]; x = vector( xbuf, 2, 1, 0 ); @@ -82,7 +82,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di v = cuminabs( [ x, y ] ); expected = [ 4.0, 4.0 ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); xbuf = [ -0.0, 0.0, -0.0 ]; x = vector( xbuf, 3, 1, 0 ); @@ -91,7 +91,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di v = cuminabs( [ x, y ] ); expected = [ 0.0, 0.0, 0.0 ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); xbuf = [ NaN ]; x = vector( xbuf, 1, 1, 0 ); @@ -100,7 +100,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di v = cuminabs( [ x, y ] ); expected = [ NaN ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); xbuf = [ NaN, NaN ]; x = vector( xbuf, 2, 1, 0 ); @@ -109,7 +109,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di v = cuminabs( [ x, y ] ); expected = [ NaN, NaN ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); t.end(); }); @@ -169,7 +169,7 @@ tape( 'the function supports non-unit strides', function test( t ) { 0.0 ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); t.end(); }); @@ -207,6 +207,6 @@ tape( 'the function supports negative strides and offsets', function test( t ) { 0.0 ]; - t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected values' ); + t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); t.end(); }); From 3714fe525cd311c1060591a505397ac325ca10e7 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 16:45:46 +0000 Subject: [PATCH 5/5] docs: use ndarray instance notation in cuminabs README examples --- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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 --- --- .../stats/base/ndarray/cuminabs/README.md | 6 +--- .../ndarray/cuminabs/benchmark/benchmark.js | 2 -- .../ndarray/cuminabs/docs/types/index.d.ts | 6 +--- .../stats/base/ndarray/cuminabs/lib/index.js | 6 +--- .../stats/base/ndarray/cuminabs/lib/main.js | 8 ++--- .../stats/base/ndarray/cuminabs/test/test.js | 35 +++++++++++-------- 6 files changed, 26 insertions(+), 37 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md index f99d4d161577..45de2e14c0eb 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/README.md @@ -41,7 +41,6 @@ var cuminabs = require( '@stdlib/stats/base/ndarray/cuminabs' ); Computes the cumulative minimum absolute value of a one-dimensional ndarray. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; @@ -51,13 +50,10 @@ var ybuf = [ 0.0, 0.0, 0.0, 0.0 ]; var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); var v = cuminabs( [ x, y ] ); -// returns +// returns [ 1.0, 1.0, 1.0, 1.0 ] var bool = ( v === y ); // returns true - -var arr = ndarray2array( v ); -// returns [ 1.0, 1.0, 1.0, 1.0 ] ``` The function has the following parameters: diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js index 814b978edc84..69e7f33a9bb1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/benchmark/benchmark.js @@ -53,7 +53,6 @@ function createBenchmark( len ) { var x; var y; - // Include negative values so abs() matters: xbuf = uniform( len, -10.0, 10.0, options ); x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); @@ -75,7 +74,6 @@ function createBenchmark( len ) { } b.toc(); - // Check final cumulative value: if ( isnan( v.get( len-1 ) ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts index e58f57d9b418..af538392d895 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/docs/types/index.d.ts @@ -29,7 +29,6 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray'; * @returns output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; @@ -39,13 +38,10 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray'; * var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = cuminabs( [ x, y ] ); -* // returns +* // returns [ 1.0, 1.0, 1.0, 1.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 1.0, 1.0, 1.0 ] */ declare function cuminabs = typedndarray>( arrays: [ ndarray, T ] ): T; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js index 85481850c43a..2b534e86741c 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/index.js @@ -24,7 +24,6 @@ * @module @stdlib/stats/base/ndarray/cuminabs * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var cuminabs = require( '@stdlib/stats/base/ndarray/cuminabs' ); * @@ -35,13 +34,10 @@ * var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = cuminabs( [ x, y ] ); -* // returns +* // returns [ 1.0, 1.0, 1.0, 1.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 1.0, 1.0, 1.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js index a87fb42a14b1..c1265afa4043 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/lib/main.js @@ -36,7 +36,6 @@ var strided = require( '@stdlib/stats/base/cuminabs' ).ndarray; * @returns {ndarrayLike} output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = [ 1.0, -3.0, 4.0, -2.0 ]; @@ -46,19 +45,16 @@ var strided = require( '@stdlib/stats/base/cuminabs' ).ndarray; * var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = cuminabs( [ x, y ] ); -* // returns +* // returns [ 1.0, 1.0, 1.0, 1.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 1.0, 1.0, 1.0 ] */ function cuminabs( arrays ) { var x = arrays[ 0 ]; var y = arrays[ 1 ]; - strided(numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y )); + strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); return y; } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js index 8af463b7afaa..1a34869363aa 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cuminabs/test/test.js @@ -34,7 +34,7 @@ var cuminabs = require( './../lib' ); * Returns a one-dimensional ndarray. * * @private -* @param {Array} buffer - underlying data buffer +* @param {Collection} buffer - underlying data buffer * @param {NonNegativeInteger} length - number of indexed elements * @param {integer} stride - stride length * @param {NonNegativeInteger} offset - index offset @@ -72,7 +72,7 @@ tape( 'the function calculates the cumulative minimum absolute value of a one-di v = cuminabs( [ x, y ] ); expected = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0 ]; - t.strictEqual( v, y, 'returns output array' ); + t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameArray( getData( v ), expected ), true, 'returns expected value' ); xbuf = [ -4.0, -5.0 ]; @@ -124,8 +124,8 @@ tape( 'if provided an empty ndarray, the function returns the output array uncha v = cuminabs( [ x, y ] ); - t.strictEqual( v, y, 'returns output array' ); - t.strictEqual( getData( v ).length, 0, 'output array is empty' ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( getData( v ).length, 0, 'returns expected value' ); t.end(); }); @@ -136,7 +136,6 @@ tape( 'the function supports non-unit strides', function test( t ) { var x; var y; var v; - var i; xbuf = [ 1.0, // 0 @@ -150,10 +149,16 @@ tape( 'the function supports non-unit strides', function test( t ) { ]; x = vector( xbuf, 4, 2, 0 ); - ybuf = []; - for ( i = 0; i < 8; i++ ) { - ybuf.push( 0.0 ); - } + ybuf = [ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ]; y = vector( ybuf, 4, 2, 0 ); v = cuminabs( [ x, y ] ); @@ -180,7 +185,6 @@ tape( 'the function supports negative strides and offsets', function test( t ) { var x; var y; var v; - var i; xbuf = [ 1.0, // 2 @@ -191,10 +195,13 @@ tape( 'the function supports negative strides and offsets', function test( t ) { ]; x = vector( xbuf, 3, -2, 4 ); - ybuf = []; - for ( i = 0; i < 5; i++ ) { - ybuf.push( 0.0 ); - } + ybuf = [ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ]; y = vector( ybuf, 3, -1, 2 ); v = cuminabs( [ x, y ] );