@stdlib/stats-strided-minsorted
v0.1.1
Published
Calculate the minimum value of a sorted strided array.
Readme
minsorted
Calculate the minimum value of a sorted strided array.
Installation
npm install @stdlib/stats-strided-minsortedUsage
var minsorted = require( '@stdlib/stats-strided-minsorted' );minsorted( N, x, strideX )
Computes the minimum value of a sorted strided array x.
var x = [ 1.0, 2.0, 3.0 ];
var N = x.length;
var v = minsorted( N, x, 1 );
// returns 1.0
x = [ 3.0, 2.0, 1.0 ];
N = x.length;
v = minsorted( N, x, 1 );
// returns 1.0The function has the following parameters:
- N: number of indexed elements.
- x: sorted input
Arrayortyped array. - strideX: stride length for
x.
The N and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum value of every other element in x,
var x = [ 1.0, 2.0, 2.0, -7.0, 3.0, 3.0, 4.0, 2.0 ];
var v = minsorted( 4, x, 2 );
// returns 1.0Note that indexing is relative to the first index. To introduce an offset, use typed array views.
var Float64Array = require( '@stdlib/array-float64' );
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var v = minsorted( 4, x1, 2 );
// returns 1.0minsorted.ndarray( N, x, strideX, offsetX )
Computes the minimum value of a sorted strided array using alternative indexing semantics.
var x = [ 1.0, 2.0, 3.0 ];
var v = minsorted.ndarray( x.length, x, 1, 0 );
// returns 1.0The function has the following additional parameters:
- offsetX: starting index for
x.
While typed array views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to calculate the minimum value for every other value in x starting from the second value
var x = [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ];
var v = minsorted.ndarray( 4, x, 2, 1 );
// returns 1.0Notes
- If
N <= 0, both functions returnNaN. - The input strided array must be sorted in either strictly ascending or descending order.
- Both functions support array-like objects having getter and setter accessors for array element access (e.g.,
@stdlib/array-base/accessor).
Examples
var linspace = require( '@stdlib/array-base-linspace' );
var minsorted = require( '@stdlib/stats-strided-minsorted' );
var x = linspace( -5.0, 5.0, 10 );
console.log( x );
var v = minsorted( x.length, x, 1 );
console.log( v );See Also
@stdlib/stats-strided/dminsorted: calculate the minimum value of a sorted double-precision floating-point strided array.@stdlib/stats-strided/maxsorted: calculate the maximum value of a sorted strided array.@stdlib/stats-strided/min: calculate the minimum value of a strided array.@stdlib/stats-strided/sminsorted: calculate the minimum value of a sorted single-precision floating-point strided array.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
