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

    0.0.6 • Public • Published

    Round

    NPM version Build Status Coverage Status dependencies

    Round a numeric value to the nearest integer.

    Installation

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

    Usage

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

    round( x )

    Rounds a numeric value to the nearest integer.

    var v = round( -4.2 );
    // returns -4.0
    
    v = round( -4.5 );
    // returns -4.0
    
    v = round( -4.6 );
    // returns -5.0
    
    v = round( 9.99999 );
    // returns 10.0
    
    v = round( 9.5 );
    // returns 10.0
    
    v = round( 9.2 );
    // returns 9.0
    
    v = round( 0.0 );
    // returns 0.0
    
    v = round( -0.0 );
    // returns -0.0
    
    v = round( Infinity );
    // returns Infinity
    
    v = round( -Infinity );
    // returns -Infinity
    
    v = round( NaN );
    // returns NaN

    Notes

    • Ties are rounded toward positive infinity.

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var round = require( '@stdlib/math-base-special-round' );
    
    var x;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        x = (randu()*100.0) - 50.0;
        console.log( 'Value: %d. Rounded: %d.', x, round( x ) );
    }

    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-round

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    3,005

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    36 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser