feat: add stats/base/ndarray/minsorted

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

@@ -0,0 +1,114 @@
+<!--
+
+@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.
+
+-->
+
+# minsorted
+
+> Compute the minimum value of a sorted one-dimensional ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## 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.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty one-dimensional ndarray, the function returns `NaN`.
+-   The input ndarray must be sorted in either ascending or descending order.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+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' );
+
+// 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 );
+```
+
+</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/minsorted/benchmark/benchmark.js

@@ -0,0 +1,105 @@
+/**
+* @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 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;
+var minsorted = 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 x;
+
+	// Create a sorted buffer deterministically:
+	xbuf = linspace( 0.0, len, len );
+	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++ ) {
+			// 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' );
+			}
+		}
+		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/minsorted/docs/repl.txt

@@ -0,0 +1,24 @@
+
+{{alias}}( arrays )
+    Computes the minimum value of a sorted one-dimensional ndarray.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        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
+    --------
+

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
+
+/// <reference types="@stdlib/types"/>
+
+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<ndarray> ): number;
+
+
+// EXPORTS //
+
+export = minsorted;

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
+}

lib/node_modules/@stdlib/stats/base/ndarray/minsorted/examples/index.js

@@ -0,0 +1,36 @@
+/**
+* @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 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 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' );
+
+// Compute the minimum:
+var v = minsorted( [ x ] );
+
+console.log( ndarray2array( x ) );
+console.log( 'min: %d', v );