From 85d48aedbae2453cb55f0a321429747a9aa5801a Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 6 Jul 2025 09:24:41 +0000 Subject: [PATCH 1/3] feat: add `stats/base/ndarray/srange` --- 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/srange/README.md | 115 ++++++++++++ .../ndarray/srange/benchmark/benchmark.js | 102 +++++++++++ .../stats/base/ndarray/srange/docs/repl.txt | 32 ++++ .../base/ndarray/srange/docs/types/index.d.ts | 45 +++++ .../base/ndarray/srange/docs/types/test.ts | 57 ++++++ .../base/ndarray/srange/examples/index.js | 33 ++++ .../stats/base/ndarray/srange/lib/index.js | 44 +++++ .../stats/base/ndarray/srange/lib/main.js | 55 ++++++ .../stats/base/ndarray/srange/package.json | 71 +++++++ .../stats/base/ndarray/srange/test/test.js | 173 ++++++++++++++++++ 10 files changed, 727 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md new file mode 100644 index 000000000000..7492ed259d86 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md @@ -0,0 +1,115 @@ + + +# srange + +> Compute the [range][range] of a one-dimensional single-precision floating-point ndarray. + +
+ +The [**range**][range] is defined as the difference between the maximum and minimum values. + +
+ + + +
+ +## Usage + +```javascript +var srange = require( '@stdlib/stats/base/ndarray/srange' ); +``` + +#### srange( arrays ) + +Computes the [range][range] of a one-dimensional single-precision floating-point ndarray. + +```javascript +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = srange( [ x ] ); +// returns 3.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`. + +
+ + + +
+ +## 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 srange = require( '@stdlib/stats/base/ndarray/srange' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = srange( [ x ] ); +console.log( v ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/benchmark/benchmark.js new file mode 100644 index 000000000000..db5d035e9ab4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/benchmark/benchmark.js @@ -0,0 +1,102 @@ +/** +* @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 pkg = require( './../package.json' ).name; +var srange = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// 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 v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = srange( [ 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/srange/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt new file mode 100644 index 000000000000..35c367db1240 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( arrays ) + Computes the range of a one-dimensional single-precision floating-point + ndarray. + + If provided an empty ndarray, the function returns `NaN`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number + Range. + + Examples + -------- + > var xbuf = [ 1.0, -2.0, 2.0 ]; + > var dt = 'float32'; + > var sh = [ xbuf.length ]; + > var sx = [ 1 ]; + > var ox = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > {{alias}}( [ x ] ) + 4.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts new file mode 100644 index 000000000000..0e89f80cbf51 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/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 range of a one-dimensional single-precision floating-point ndarray. +* +* @param arrays - array-like object containing an input ndarray +* @returns range +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = srange( [ x ] ); +* // returns 3.0 +*/ +declare function srange( arrays: [ T ] ): number; + + +// EXPORTS // + +export = srange; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/test.ts new file mode 100644 index 000000000000..66e4ed7a30d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/test.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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import srange = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + + srange( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + srange( '10' ); // $ExpectError + srange( 10 ); // $ExpectError + srange( true ); // $ExpectError + srange( false ); // $ExpectError + srange( null ); // $ExpectError + srange( undefined ); // $ExpectError + srange( [] ); // $ExpectError + srange( {} ); // $ExpectError + srange( ( 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': 'float32' + }); + + srange(); // $ExpectError + srange( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/examples/index.js new file mode 100644 index 000000000000..cf2beb86a819 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/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 srange = require( './../lib' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = srange( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js new file mode 100644 index 000000000000..aa92f1b69c87 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/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 range of a one-dimensional single-precision floating-point ndarray. +* +* @module @stdlib/stats/base/ndarray/srange +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var srange = require( '@stdlib/stats/base/ndarray/srange' ); +* +* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = srange( [ x ] ); +* // returns 3.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js new file mode 100644 index 000000000000..7c6538dc13e0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/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/srange' ).ndarray; + + +// MAIN // + +/** +* Computes the range of a one-dimensional single-precision floating-point ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {number} range +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = srange( [ x ] ); +* // returns 3.0 +*/ +function srange( 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 = srange; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/srange/package.json new file mode 100644 index 000000000000..ce73218d30fc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/stats/base/ndarray/srange", + "version": "0.0.0", + "description": "Compute the range of a one-dimensional single-precision floating-point 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", + "maximum", + "max", + "minimum", + "min", + "range", + "extremes", + "domain", + "extent", + "float32", + "float", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js new file mode 100644 index 000000000000..be38140b5d33 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js @@ -0,0 +1,173 @@ +/** +* @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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var Float32Array = require( '@stdlib/array/float32' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var srange = 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( 'float32', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof srange, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( srange.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the range of a one-dimensional ndarray', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + v = srange( [ vector( x, 6, 1, 0 ) ] ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = new Float32Array( [ -4.0, -5.0 ] ); + v = srange( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = new Float32Array( [ -0.0, 0.0, -0.0 ] ); + v = srange( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + v = srange( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + v = srange( [ 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; + + x = new Float32Array( [] ); + + v = srange( [ 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 `0`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0 ] ); + + v = srange( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( v, 0.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 = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + v = srange( [ vector( x, 4, 2, 0 ) ] ); + + t.strictEqual( v, 6.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var x; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + v = srange( [ vector( x, 4, -2, 6 ) ] ); + + t.strictEqual( v, 6.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 = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + + v = srange( [ vector( x, 4, 2, 1 ) ] ); + t.strictEqual( v, 6.0, 'returns expected value' ); + + t.end(); +}); From 13a2315806f46b7173125fb2ece405f4a5817b44 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 6 Jul 2025 11:11:08 +0000 Subject: [PATCH 2/3] fix: update 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - 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 --- --- .../@stdlib/stats/base/ndarray/srange/README.md | 3 ++- .../@stdlib/stats/base/ndarray/srange/docs/repl.txt | 2 +- .../stats/base/ndarray/srange/docs/types/index.d.ts | 7 ++++--- .../@stdlib/stats/base/ndarray/srange/lib/index.js | 3 ++- .../@stdlib/stats/base/ndarray/srange/lib/main.js | 3 ++- 5 files changed, 11 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md index 7492ed259d86..2a781e522fec 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/README.md @@ -43,9 +43,10 @@ var srange = require( '@stdlib/stats/base/ndarray/srange' ); Computes the [range][range] of a one-dimensional single-precision floating-point ndarray. ```javascript +var Float32Array = require( '@stdlib/array/float32' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); var v = srange( [ x ] ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt index 35c367db1240..6254ed4c2aa3 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/repl.txt @@ -17,7 +17,7 @@ Examples -------- - > var xbuf = [ 1.0, -2.0, 2.0 ]; + > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); > var dt = 'float32'; > var sh = [ xbuf.length ]; > var sx = [ 1 ]; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts index 0e89f80cbf51..bc7e62d6ad2b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/docs/types/index.d.ts @@ -20,7 +20,7 @@ /// -import { ndarray } from '@stdlib/types/ndarray'; +import { float32ndarray } from '@stdlib/types/ndarray'; /** * Computes the range of a one-dimensional single-precision floating-point ndarray. @@ -29,15 +29,16 @@ import { ndarray } from '@stdlib/types/ndarray'; * @returns range * * @example +* var Float32Array = require( '@stdlib/array/float32' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * -* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = srange( [ x ] ); * // returns 3.0 */ -declare function srange( arrays: [ T ] ): number; +declare function srange( arrays: [ float32ndarray ] ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js index aa92f1b69c87..e31bef09ffeb 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/index.js @@ -24,10 +24,11 @@ * @module @stdlib/stats/base/ndarray/srange * * @example +* var Float32Array = require( '@stdlib/array/float32' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var srange = require( '@stdlib/stats/base/ndarray/srange' ); * -* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = srange( [ x ] ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js index 7c6538dc13e0..f14fd0379842 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/lib/main.js @@ -36,9 +36,10 @@ var strided = require( '@stdlib/stats/strided/srange' ).ndarray; * @returns {number} range * * @example +* var Float32Array = require( '@stdlib/array/float32' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * -* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = srange( [ x ] ); From 0347f1e6a84fc1c2f6ef31cf95db4fbc49325af3 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 6 Jul 2025 12:17:43 -0700 Subject: [PATCH 3/3] test: use single-precision assertion packages Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/srange/test/test.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js index be38140b5d33..2460b742f955 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/srange/test/test.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var srange = require( './../lib' ); @@ -72,15 +72,15 @@ tape( 'the function calculates the range of a one-dimensional ndarray', function x = new Float32Array( [ -0.0, 0.0, -0.0 ] ); v = srange( [ vector( x, 3, 1, 0 ) ] ); - t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); x = new Float32Array( [ NaN ] ); v = srange( [ vector( x, 1, 1, 0 ) ] ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); x = new Float32Array( [ NaN, NaN ] ); v = srange( [ vector( x, 2, 1, 0 ) ] ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); t.end(); }); @@ -92,7 +92,7 @@ tape( 'if provided an empty vector, the function returns `NaN`', function test( x = new Float32Array( [] ); v = srange( [ vector( x, 0, 1, 0 ) ] ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); t.end(); });