@stdlib/stats-base-smediansorted
v0.2.2
Published
Calculate the median value of a sorted single-precision floating-point strided array.
Downloads
172
Readme
smediansorted
Calculate the median value of a sorted single-precision floating-point strided array.
Installation
npm install @stdlib/stats-base-smediansorted
Usage
var smediansorted = require( '@stdlib/stats-base-smediansorted' );
smediansorted( N, x, stride )
Computes the median 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 v = smediansorted( x.length, x, 1 );
// returns 2.0
x = new Float32Array( [ 3.0, 2.0, 1.0 ] );
v = smediansorted( x.length, x, 1 );
// returns 2.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 median 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 = smediansorted( N, x, 2 );
// returns 2.5
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 = smediansorted( N, x1, 2 );
// returns 2.0
smediansorted.ndarray( N, x, stride, offset )
Computes the median 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 = smediansorted.ndarray( N, x, 1, 0 );
// returns 2.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 median 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 = smediansorted.ndarray( N, x, 2, 1 );
// returns 2.0
Notes
- If
N <= 0
, both functions returnNaN
. - The input strided array must be sorted in either strictly ascending or descending order.
Examples
var Float32Array = require( '@stdlib/array-float32' );
var smediansorted = require( '@stdlib/stats-base-smediansorted' );
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 = smediansorted( x.length, x, 1 );
console.log( v );
See Also
@stdlib/stats-base/dmediansorted
: calculate the median value of a sorted double-precision floating-point strided array.@stdlib/stats-base/mediansorted
: calculate the median value of a sorted strided array.@stdlib/stats-base/smean
: calculate the arithmetic mean of a 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-2024. The Stdlib Authors.