feat: add stats/base/ndarray/range-by

lib/node_modules/@stdlib/stats/base/ndarray/range-by/README.md

@@ -0,0 +1,119 @@
+<!--
+@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.
+-->
+
+# rangeBy
+
+> Compute the range of a one-dimensional ndarray via a callback function.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var rangeBy = require( '@stdlib/stats/base/ndarray/range-by' );
+```
+
+#### rangeBy( arrays )
+
+Computes the range of a one-dimensional ndarray via a callback function.
+
+```javascript
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+
+function accessor( v ) {
+    return v * 2.0;
+}
+
+var xbuf = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];
+var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+
+var v = rangeBy( [ x, accessor ] );
+// returns 18.0
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing a one-dimensional input ndarray and a callback function.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty one-dimensional ndarray, the function returns `NaN`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var rangeBy = require( '@stdlib/stats/base/ndarray/range-by' );
+
+function accessor( v ) {
+    return v * 2.0;
+}
+
+var options = {
+    'dtype': 'float64'
+};
+
+var xbuf = uniform( 10, -10.0, 10.0, options );
+var x = new ndarray( options.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+console.log( ndarray2array( x ) );
+
+var v = rangeBy( [ x, accessor ] );
+console.log( v );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/range-by/benchmark/benchmark.js

@@ -0,0 +1,113 @@
+/**
+* @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 rangeBy = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Accessor function.
+*
+* @private
+* @param {number} value - array element
+* @returns {number} accessed value
+*/
+function accessor( value ) {
+	return value * 2.0;
+}
+
+/**
+* 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 y;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			y = rangeBy( [ x, accessor ] );
+			if ( isnan( y ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( y ) ) {
+			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+':ndarray:len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/stats/base/ndarray/range-by/docs/repl.txt

@@ -0,0 +1,44 @@
+{{alias}}( arrays )
+    Computes the range of a one-dimensional numeric ndarray via a callback
+    function.
+
+    If provided an empty ndarray, the function returns `NaN`.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a one-dimensional input ndarray.
+
+    Returns
+    -------
+    out: number
+        Range.
+
+    Examples
+    --------
+    > function accessor( v ) { return v * 2.0; };
+    > var xbuf = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0,
+    ... 4.0, -1.0, -3.0 ] );
+    > var dt = 'float64';
+    > var sh = [ xbuf.length ];
+    > var sx = [ 1 ];
+    > var ox = 0;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > {{alias}}( [ x, accessor ] )
+    18.0
+
+    // Using a subset of elements via stride and offset:
+    > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0,
+    ... -4.0, 5.0, -6.0 ] );
+    > var dt = 'float64';
+    > var sh = [ 3 ];
+    > var sx = [ 2 ];
+    > var ox = 1;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > {{alias}}( [ x, accessor ] )
+    8.0
+
+    See Also
+    --------

lib/node_modules/@stdlib/stats/base/ndarray/range-by/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the range of a one-dimensional numeric ndarray via a callback function.
+*
+* @param arrays - array-like object containing an input ndarray and a callback function
+* @returns range
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+*
+* function accessor( v ) {
+*     return v * 2.0;
+* }
+*
+* var xbuf = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
+* var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+*
+* var v = rangeBy( [ x, accessor ] );
+* // returns 18.0
+*/
+declare function rangeBy( arrays: [ ndarray, Function ] ): number;
+
+
+// EXPORTS //
+
+export = rangeBy;