feat: add stats/base/ndarray/dmidrange

lib/node_modules/@stdlib/stats/base/ndarray/dmidrange/README.md

@@ -0,0 +1,140 @@
+<!--
+
+@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.
+
+-->
+
+# dmidrange
+
+> Compute the [midrange][midrange] of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values .
+
+<section class="intro">
+
+The [midrange][midrange] is defined as
+
+<!-- <equation class="equation" label="eq:midrange" align="center" raw="\mathrm{midrange} = \frac{\max(x) + \min(x)}{2}" alt="Equation for the midrange."> -->
+
+```math
+\mathrm{midrange} = \frac{\max(x) + \min(x)}{2}
+```
+
+<!-- <div class="equation" align="center" data-raw-text="\mathrm{midrange} = \frac{\max(x) + \min(x)}{2}" data-equation="eq:midrange"> <img src="img/equation_midrange.svg" alt="Equation for the midrange."> <br> </div> -->
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dmidrange = require( '@stdlib/stats/base/ndarray/dmidrange' );
+```
+
+#### dmidrange( arrays )
+
+Computes the [midrange][midrange] of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+
+var xbuf = new Float64Array( [ 1.0, -2.0, 2.0, 2.0 ] );
+var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+
+var v = dmidrange( [ x ] );
+// returns 0.0
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing a one-dimensional input ndarray.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty one-dimensional ndarray, the function returns `NaN`.
+-   The midrange is a simple measure of central tendency and is sensitive to outliers because it depends only on extremes..
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var dmidrange = require( '@stdlib/stats/base/ndarray/dmidrange' );
+
+function rand() {
+    if ( bernoulli( 0.8 ) === 1 ) {
+        return NaN;
+    }
+    return uniform( -50.0, 50.0 );
+}
+
+var xbuf = filledarrayBy( 10, 'float64', rand );
+var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+console.log( ndarray2array( x ) );
+
+var v = dmidrange( [ x ] );
+console.log( v );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- 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">
+
+[midrange]: https://en.wikipedia.org/wiki/Mid-range
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/dmidrange/benchmark/benchmark.js

@@ -0,0 +1,103 @@
+/**
+* @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/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+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 dmidrange = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Returns a random number (80% chance of returning a `NaN`).
+*
+* @private
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	return uniform( -10.0, 10.0 );
+}
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var xbuf;
+	var x;
+
+	xbuf = filledarrayBy( len, 'float64', rand );
+	x = new ndarray( 'float64', 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 = dmidrange( [ x ] );
+		}
+		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();

lib/node_modules/@stdlib/stats/base/ndarray/dmidrange/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( arrays )
+    Computes the midrange of a one-dimensional double-precision floating-
+    point ndarray, ignoring `NaN` values.
+
+    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
+        Midrange value.
+
+    Examples
+    --------
+    > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0, 4.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 ] )
+    1.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/base/ndarray/dmidrange/docs/types/index.d.ts

@@ -0,0 +1,46 @@
+/*
+* @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 { float64ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the midrange value of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
+*
+* @param arrays - array-like object containing an input ndarray
+* @returns midrange value
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+*
+* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0, 4.0 ] );
+* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var v = dmidrange( [ x ] );
+* // returns 1.0
+*/
+declare function dmidrange( arrays: [ float64ndarray ] ): number;
+
+
+// EXPORTS //
+
+export = dmidrange;

lib/node_modules/@stdlib/stats/base/ndarray/dmidrange/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 dmidrange = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float64'
+	});
+
+	dmidrange( [ x ] ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	dmidrange( '10' ); // $ExpectError
+	dmidrange( 10 ); // $ExpectError
+	dmidrange( true ); // $ExpectError
+	dmidrange( false ); // $ExpectError
+	dmidrange( null ); // $ExpectError
+	dmidrange( undefined ); // $ExpectError
+	dmidrange( [] ); // $ExpectError
+	dmidrange( {} ); // $ExpectError
+	dmidrange( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float64'
+	});
+
+	dmidrange(); // $ExpectError
+	dmidrange( [ x ], {} ); // $ExpectError
+}