@stdlib/stats-base-smaxabssorted
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.5 • Public • Published

    smaxabssorted

    NPM version Build Status Coverage Status dependencies

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

    Installation

    npm install @stdlib/stats-base-smaxabssorted

    Usage

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

    smaxabssorted( N, x, stride )

    Computes the maximum absolute 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 = smaxabssorted( x.length, x, 1 );
    // returns 3.0
    
    x = new Float32Array( [ -3.0, -2.0, -1.0 ] );
    v = smaxabssorted( x.length, 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 absolute 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 = smaxabssorted( 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 = smaxabssorted( N, x1, 2 );
    // returns 4.0

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

    Computes the maximum absolute 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 v = smaxabssorted.ndarray( x.length, 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 absolute 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 = smaxabssorted.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 smaxabssorted = require( '@stdlib/stats-base-smaxabssorted' );
    
    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 = smaxabssorted( x.length, x, 1 );
    console.log( v );

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/stats-base-smaxabssorted

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    5

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    68.3 kB

    Total Files

    20

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser