@stdlib/stats-strided-mediansorted
v0.1.1
Published
Calculate the median value of a sorted strided array.
Downloads
665
Readme
mediansorted
Calculate the median value of a sorted strided array.
Installation
npm install @stdlib/stats-strided-mediansortedUsage
var mediansorted = require( '@stdlib/stats-strided-mediansorted' );mediansorted( N, x, strideX )
Computes the median value of a sorted strided array x.
var x = [ 1.0, 2.0, 3.0 ];
var v = mediansorted( x.length, x, 1 );
// returns 2.0
x = [ 3.0, 2.0, 1.0 ];
v = mediansorted( x.length, x, 1 );
// returns 2.0The function has the following parameters:
- N: number of indexed elements.
- x: input
Arrayortyped array. - strideX: stride length for
x.
The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the median 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 = mediansorted( 4, x, 2 );
// returns 2.5Note 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 = mediansorted( 4, x1, 2 );
// returns 2.0mediansorted.ndarray( N, x, strideX, offsetX )
Computes the median value of a sorted strided array using alternative indexing semantics.
var x = [ 1.0, 2.0, 3.0 ];
var v = mediansorted.ndarray( x.length, x, 1, 0 );
// returns 2.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, 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 x = [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ];
var v = mediansorted.ndarray( 4, x, 2, 1 );
// returns 2.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 mediansorted = require( '@stdlib/stats-strided-mediansorted' );
var x = linspace( -5.0, 5.0, 10 );
console.log( x );
var v = mediansorted( x.length, x, 1 );
console.log( v );See Also
@stdlib/stats-strided/dmediansorted: calculate the median value of a sorted double-precision floating-point strided array.@stdlib/stats-strided/mean: calculate the arithmetic mean of a strided array.@stdlib/stats-strided/smediansorted: calculate the median 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.
