From df34736743337a113ffee3564acf7992655873a5 Mon Sep 17 00:00:00 2001 From: Sachin Pangal Date: Fri, 7 Nov 2025 21:36:17 +0530 Subject: [PATCH 1/8] feat: add stats/base/ndarray/minsorted --- .../stats/base/ndarray/minsorted/README.md | 121 ++++++++++++ .../ndarray/minsorted/benchmark/benchmark.js | 115 +++++++++++ .../base/ndarray/minsorted/docs/repl.txt | 24 +++ .../ndarray/minsorted/docs/types/index.d.ts | 45 +++++ .../base/ndarray/minsorted/docs/types/test.ts | 48 +++++ .../base/ndarray/minsorted/examples/index.js | 34 ++++ .../stats/base/ndarray/minsorted/lib/index.js | 44 +++++ .../stats/base/ndarray/minsorted/lib/main.js | 55 ++++++ .../stats/base/ndarray/minsorted/package.json | 68 +++++++ .../stats/base/ndarray/minsorted/test/test.js | 178 ++++++++++++++++++ 10 files changed, 732 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md new file mode 100644 index 000000000000..e3f977f978dc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md @@ -0,0 +1,121 @@ + + +# minsorted + +> Compute the minimum value of a sorted one-dimensional ndarray. + +
+ +
+ + + +
+ +## Usage + +```javascript +var minsorted = require( '@stdlib/stats/base/ndarray/minsorted' ); +``` + +#### minsorted( arrays ) + +Computes the minimum value of a sorted one-dimensional ndarray. + +```javascript +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; +var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = minsorted( [ x ] ); +// returns 1.0 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +## Notes + +- If provided an empty one-dimensional ndarray, the function returns `NaN`. +- The input ndarray must be sorted in either ascending or descending order. + +
+ + + +
+ +## 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 minsorted = require( '@stdlib/stats/base/ndarray/minsorted' ); + +// Define a comparison function for sorting in ascending order: +function ascending( a, b ) { + return a - b; +} + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'generic' +}); + +// Sort the array: +xbuf.sort( ascending ); + +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = minsorted( [ x ] ); +console.log( v ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js new file mode 100644 index 000000000000..f7f290d629db --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js @@ -0,0 +1,115 @@ +/** +* @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 discreteUniform = require( '@stdlib/random/array/discrete-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 pkg = require( './../package.json' ).name; +var minsorted = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Comparison function for sorting in ascending order. +* +* @private +* @param {number} a - first value +* @param {number} b - second value +* @returns {number} difference +*/ +function ascending( a, b ) { + return a - b; +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var x; + + xbuf = discreteUniform( len, -100, 100, options ); + xbuf.sort( ascending ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = minsorted( [ x ] ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + 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/stats/base/ndarray/minsorted/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/repl.txt new file mode 100644 index 000000000000..9106c3eeab9b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/repl.txt @@ -0,0 +1,24 @@ + +{{alias}}( arrays ) + Computes the minimum value of a sorted one-dimensional ndarray. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number + Minimum value. + + Examples + -------- + > var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; + > var x = {{alias:@stdlib/ndarray/base/ctor}}( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + > {{alias}}( [ x ] ) + 1.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/index.d.ts new file mode 100644 index 000000000000..33ee2ce99c41 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/index.d.ts @@ -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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { ndarray } from '@stdlib/types/ndarray'; + +/** +* Computes the minimum value of a sorted one-dimensional ndarray. +* +* @param arrays - array-like object containing a one-dimensional input ndarray +* @returns minimum value +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = minsorted( [ x ] ); +* // returns 1.0 +*/ +declare function minsorted( arrays: ArrayLike ): number; + + +// EXPORTS // + +export = minsorted; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/test.ts new file mode 100644 index 000000000000..fd7bab214093 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/docs/types/test.ts @@ -0,0 +1,48 @@ +/* +* @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. +*/ + +import ndarray = require( '@stdlib/ndarray/base/ctor' ); +import minsorted = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; + const x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + minsorted( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array-like object containing ndarrays... +{ + minsorted( 5 ); // $ExpectError + minsorted( true ); // $ExpectError + minsorted( false ); // $ExpectError + minsorted( null ); // $ExpectError + minsorted( undefined ); // $ExpectError + minsorted( {} ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; + const x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + minsorted(); // $ExpectError + minsorted( [ x ], 2 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js new file mode 100644 index 000000000000..927dbff4300c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js @@ -0,0 +1,34 @@ +/** +* @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 ndarray = require( '@stdlib/ndarray/base/ctor' ); +var minsorted = require( './../lib' ); + +// Create a sorted array: +var xbuf = [ -3.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]; + +// Create an ndarray: +var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' ); + +// Compute the minimum: +var v = minsorted( [ x ] ); + +console.log( 'x: %s', x.data ); +console.log( 'min: %d', v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/index.js new file mode 100644 index 000000000000..456cdb11ceb0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/index.js @@ -0,0 +1,44 @@ +/** +* @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 minimum value of a sorted one-dimensional ndarray. +* +* @module @stdlib/stats/base/ndarray/minsorted +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var minsorted = require( '@stdlib/stats/base/ndarray/minsorted' ); +* +* var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = minsorted( [ x ] ); +* // returns 1.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/main.js new file mode 100644 index 000000000000..d0074ab0264b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/lib/main.js @@ -0,0 +1,55 @@ +/** +* @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/strided/minsorted' ).ndarray; + + +// MAIN // + +/** +* Computes the minimum value of a sorted one-dimensional ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {number} minimum value +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = minsorted( [ x ] ); +* // returns 1.0 +*/ +function minsorted( arrays ) { + var x = arrays[ 0 ]; + return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = minsorted; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/package.json new file mode 100644 index 000000000000..0cd09eefb884 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/stats/base/ndarray/minsorted", + "version": "0.0.0", + "description": "Compute the minimum value of a sorted 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", + "minimum", + "min", + "sorted", + "range", + "extremes", + "domain", + "extent", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js new file mode 100644 index 000000000000..ca58c61d6391 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js @@ -0,0 +1,178 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var minsorted = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} 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 minsorted, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( minsorted.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the minimum value of a sorted one-dimensional ndarray (ascending)', function test( t ) { + var x; + var v; + + x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; + v = minsorted( [ vector( x, 5, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -5.0, -4.0, -3.0, -2.0, -1.0 ]; + v = minsorted( [ vector( x, 5, 1, 0 ) ] ); + t.strictEqual( v, -5.0, 'returns expected value' ); + + x = [ 0.0, 1.0, 2.0 ]; + v = minsorted( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the minimum value of a sorted one-dimensional ndarray (descending)', function test( t ) { + var x; + var v; + + x = [ 5.0, 4.0, 3.0, 2.0, 1.0 ]; + v = minsorted( [ vector( x, 5, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -1.0, -2.0, -3.0, -4.0, -5.0 ]; + v = minsorted( [ vector( x, 5, 1, 0 ) ] ); + t.strictEqual( v, -5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty vector, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = []; + + v = minsorted( [ vector( x, 0, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a vector containing a single element, the function returns that element', function test( t ) { + var x; + var v; + + x = [ 1.0 ]; + + v = minsorted( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + 3.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = minsorted( [ vector( x, 4, 2, 0 ) ] ); + + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + 3.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = minsorted( [ vector( x, 4, -2, 6 ) ] ); + + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var x; + var v; + + x = [ + 2.0, + -2.0, // 0 + 2.0, + 1.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]; + + v = minsorted( [ vector( x, 4, 2, 1 ) ] ); + t.strictEqual( v, -2.0, 'returns expected value' ); + + t.end(); +}); From 85c5c70ccd1a2f222cbd82f16cb8eceded57bcf3 Mon Sep 17 00:00:00 2001 From: Sachin Pangal Date: Sat, 8 Nov 2025 03:03:30 +0530 Subject: [PATCH 2/8] update: readme and testcases --- .../stats/base/ndarray/minsorted/README.md | 17 ++----- .../ndarray/minsorted/benchmark/benchmark.js | 20 ++------ .../base/ndarray/minsorted/examples/index.js | 8 +-- .../stats/base/ndarray/minsorted/test/test.js | 51 +++++++++++++++++++ 4 files changed, 66 insertions(+), 30 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md index e3f977f978dc..b4111a0b3393 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md @@ -76,26 +76,19 @@ The function has the following parameters: ```javascript -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var linspace = require( '@stdlib/array/base/linspace' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var minsorted = require( '@stdlib/stats/base/ndarray/minsorted' ); -// Define a comparison function for sorting in ascending order: -function ascending( a, b ) { - return a - b; -} - -var xbuf = discreteUniform( 10, -50, 50, { - 'dtype': 'generic' -}); - -// Sort the array: -xbuf.sort( ascending ); +// Create a sorted buffer using a linear space: +var xbuf = linspace( -5.0, 5.0, 10 ); +// Wrap in an ndarray: var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); +// Compute the minimum of the sorted ndarray: var v = minsorted( [ x ] ); console.log( v ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js index f7f290d629db..c7171c48618b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js @@ -21,8 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var linspace = require( '@stdlib/array/base/linspace' ); var pow = require( '@stdlib/math/base/special/pow' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var pkg = require( './../package.json' ).name; @@ -38,18 +38,6 @@ var options = { // FUNCTIONS // -/** -* Comparison function for sorting in ascending order. -* -* @private -* @param {number} a - first value -* @param {number} b - second value -* @returns {number} difference -*/ -function ascending( a, b ) { - return a - b; -} - /** * Creates a benchmark function. * @@ -61,8 +49,8 @@ function createBenchmark( len ) { var xbuf; var x; - xbuf = discreteUniform( len, -100, 100, options ); - xbuf.sort( ascending ); + // Create a sorted buffer deterministically: + xbuf = linspace( 0.0, len, len ); x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); return benchmark; @@ -73,6 +61,8 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { + // Mutate first element to vary input while keeping simple semantics: + x.data[ 0 ] = i; v = minsorted( [ x ] ); if ( isnan( v ) ) { b.fail( 'should not return NaN' ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js index 927dbff4300c..12591bfc9050 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js @@ -18,11 +18,13 @@ 'use strict'; +var linspace = require( '@stdlib/array/base/linspace' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); var minsorted = require( './../lib' ); -// Create a sorted array: -var xbuf = [ -3.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]; +// Create a sorted array buffer using a linear space: +var xbuf = linspace( -5.0, 5.0, 10 ); // Create an ndarray: var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' ); @@ -30,5 +32,5 @@ var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' ); // Compute the minimum: var v = minsorted( [ x ] ); -console.log( 'x: %s', x.data ); +console.log( ndarray2array( x ) ); console.log( 'min: %d', v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js index ca58c61d6391..c905453098ac 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/test/test.js @@ -22,6 +22,7 @@ var tape = require( 'tape' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var minsorted = require( './../lib' ); @@ -90,6 +91,44 @@ tape( 'the function calculates the minimum value of a sorted one-dimensional nda t.end(); }); +tape( 'the function returns negative zero when appropriate', function test( t ) { + var x; + var v; + + x = [ -0.0, -0.0, 0.0 ]; + v = minsorted( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ 0.0, -0.0, -0.0 ]; + v = minsorted( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a vector containing `NaN`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = [ NaN ]; + v = minsorted( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = minsorted( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 5.0, NaN ]; + v = minsorted( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, 5.0 ]; + v = minsorted( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an empty vector, the function returns `NaN`', function test( t ) { var x; var v; @@ -176,3 +215,15 @@ tape( 'the function supports one-dimensional ndarrays having non-zero offsets', t.end(); }); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, -5.0, -6.0 ]; + + v = minsorted( [ vector( x, x.length, 0, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); From 11cab72986abea53368e574ed29c997307f31812 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:43:45 -0800 Subject: [PATCH 3/8] docs: update comment Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md index b4111a0b3393..da12331faf82 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md @@ -81,7 +81,7 @@ var ndarray = require( '@stdlib/ndarray/base/ctor' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var minsorted = require( '@stdlib/stats/base/ndarray/minsorted' ); -// Create a sorted buffer using a linear space: +// Create a sorted data buffer: var xbuf = linspace( -5.0, 5.0, 10 ); // Wrap in an ndarray: From e1922523209fbd31e063abb1f9de815030d75c1d Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:44:23 -0800 Subject: [PATCH 4/8] docs: remove comment Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js index c7171c48618b..54521ec66dc8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js @@ -49,7 +49,6 @@ function createBenchmark( len ) { var xbuf; var x; - // Create a sorted buffer deterministically: xbuf = linspace( 0.0, len, len ); x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); From bb37c23e6c57bbda1b7496d23023b993f0660152 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:45:56 -0800 Subject: [PATCH 5/8] bench: update logic Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js index 54521ec66dc8..c66f02635af2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/benchmark/benchmark.js @@ -60,8 +60,6 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - // Mutate first element to vary input while keeping simple semantics: - x.data[ 0 ] = i; v = minsorted( [ x ] ); if ( isnan( v ) ) { b.fail( 'should not return NaN' ); From fb9259b6f64d7ce589e6764371bee458c5111082 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:47:00 -0800 Subject: [PATCH 6/8] docs: update comment Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/minsorted/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js index 12591bfc9050..c7ae5c5b0639 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js @@ -23,7 +23,7 @@ var ndarray = require( '@stdlib/ndarray/base/ctor' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var minsorted = require( './../lib' ); -// Create a sorted array buffer using a linear space: +// Create a sorted data buffer: var xbuf = linspace( -5.0, 5.0, 10 ); // Create an ndarray: From 4f332ad257c8c0b8a08f2d18212aa0c11ae5118d Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:47:18 -0800 Subject: [PATCH 7/8] docs: update comment Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/minsorted/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js index c7ae5c5b0639..1802c20c2351 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js @@ -29,7 +29,7 @@ var xbuf = linspace( -5.0, 5.0, 10 ); // Create an ndarray: var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' ); -// Compute the minimum: +// Compute the minimum value: var v = minsorted( [ x ] ); console.log( ndarray2array( x ) ); From 00784e680f42908c7850662ca27369b0a7575223 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 8 Nov 2025 13:47:45 -0800 Subject: [PATCH 8/8] docs: update example Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/minsorted/examples/index.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js index 1802c20c2351..0cfdbfb44926 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js @@ -28,9 +28,8 @@ var xbuf = linspace( -5.0, 5.0, 10 ); // Create an ndarray: var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); // Compute the minimum value: var v = minsorted( [ x ] ); - -console.log( ndarray2array( x ) ); console.log( 'min: %d', v );