Skip to content

Latest commit

 

History

History

minsorted

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

minsorted

Calculate the minimum value of a sorted strided array.

Usage

var minsorted = require( '@stdlib/stats/base/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.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: sorted input Array or typed 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.0

Note 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.0

minsorted.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.0

The 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.0

Notes

  • If N <= 0, both functions return NaN.
  • 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/base/minsorted' );

var x = linspace( -5.0, 5.0, 10 );
console.log( x );

var v = minsorted( x.length, x, 1 );
console.log( v );

See Also