smaxsorted

Calculate the maximum value of a sorted single-precision floating-point strided array.

Usage

var smaxsorted = require( '@stdlib/stats/base/smaxsorted' );

smaxsorted( N, x, stride )

Computes the maximum value of a sorted single-precision floating-point strided array x.

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var N = x.length;

var v = smaxsorted( N, x, 1 );
// returns 3.0

x = new Float32Array( [ 3.0, 2.0, 1.0 ] );
N = x.length;

v = smaxsorted( N, x, 1 );
// returns 3.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: sorted input Float32Array.
  • stride: index increment for x.

The N and stride parameters determine which elements in x are accessed at runtime. For example, to compute the maximum value of every other element in x,

var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, 3.0, 3.0, 4.0, 2.0 ] );
var N = floor( x.length / 2 );

var v = smaxsorted( N, x, 2 );
// returns 4.0

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

var x0 = new Float32Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var N = floor( x0.length / 2 );

var v = smaxsorted( N, x1, 2 );
// returns 4.0

smaxsorted.ndarray( N, x, stride, offset )

Computes the maximum value of a sorted single-precision floating-point strided array using alternative indexing semantics.

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var N = x.length;

var v = smaxsorted.ndarray( N, x, 1, 0 );
// returns 3.0

The function has the following additional parameters:

  • offset: starting index for x.

While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the maximum value for every other value in x starting from the second value

var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

var x = new Float32Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var N = floor( x.length / 2 );

var v = smaxsorted.ndarray( N, x, 2, 1 );
// returns 4.0

Notes

  • If N <= 0, both functions return NaN.
  • The input strided array must be sorted in either strictly ascending or descending order.

Examples

var Float32Array = require( '@stdlib/array/float32' );
var smaxsorted = require( '@stdlib/stats/base/smaxsorted' );

var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
    x[ i ] = i - 5.0;
}
console.log( x );

var v = smaxsorted( x.length, x, 1 );
console.log( v );
Did you find this page helpful?