Skip to content

range

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

range

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

range

Calculate the range of a strided array.

The range is defined as the difference between the maximum and minimum values.

Usage

var range = require( '@stdlib/stats/strided/range' );

range( N, x, strideX )

Computes the range of a strided array.

var x = [ 1.0, -2.0, 2.0 ];

var v = range( x.length, x, 1 );
// returns 4.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Array or typed 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 range of every other element in x,

var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];

var v = range( 4, x, 2 );
// returns 6.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 = range( 4, x1, 2 );
// returns 6.0

range.ndarray( N, x, strideX, offsetX )

Computes the range of a strided array using alternative indexing semantics.

var x = [ 1.0, -2.0, 2.0 ];

var v = range.ndarray( x.length, x, 1, 0 );
// returns 4.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, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the range for every other element in x starting from the second element

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];

var v = range.ndarray( 4, x, 2, 1 );
// returns 6.0

Notes

  • If N <= 0, both functions return NaN.
  • Depending on the environment, the typed versions (drange, srange, etc.) are likely to be significantly more performant.
  • Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array/base/accessor).

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var range = require( '@stdlib/stats/strided/range' );

var x = discreteUniform(10, -50, 50, {
    'dtype': 'float64'
});
console.log( x );

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

See Also