@stdlib/math-base-special-wrap
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    wrap

    NPM version Build Status Coverage Status dependencies

    Wrap a value on the half-open interval [min,max).

    Installation

    npm install @stdlib/math-base-special-wrap

    Usage

    var wrap = require( '@stdlib/math-base-special-wrap' );

    wrap( v, min, max )

    Wraps a value on the half-open interval [min,max).

    var v = wrap( 3.14, 0.0, 5.0 );
    // returns 3.14
    
    v = wrap( -3.14, 0.0, 5.0 );
    // returns ~1.86
    
    v = wrap( 10.0, 0.0, 5.0 );
    // returns 0.0
    
    v = wrap( -0.0, 0.0, 5.0 );
    // returns 0.0
    
    v = wrap( 0.0, -3.14, -0.0 );
    // returns -3.14

    If provided NaN for any argument, the function returns NaN.

    var v = wrap( NaN, 0.0, 5.0 );
    // returns NaN
    
    v = wrap( 0.0, NaN, 5.0 );
    // returns NaN
    
    v = wrap( 3.14, 0.0, NaN );
    // returns NaN

    If provided min == max, the function returns NaN.

    var v = wrap( 3.14, 3.0, 3.0 );
    // returns NaN

    Notes

    • The function does not distinguish between positive and negative zero. Where appropriate, the function returns positive zero.

    Examples

    var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
    var wrap = require( '@stdlib/math-base-special-wrap' );
    
    var min;
    var max;
    var v;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        min = discreteUniform( 0.0, 10.0 );
        max = discreteUniform( 5.0, 15.0 );
        v = discreteUniform( -20.0, 20.0 );
        console.log( 'wrap(%d,%d,%d) => %d', v, min, max, wrap( v, min, max ) );
    }

    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/math-base-special-wrap

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    6

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    38.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser