time-to-botec/squiggle/node_modules/@stdlib/math/base/special/roundsd/README.md

roundsd

Round a numeric value to the nearest number with n significant figures.

Usage

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

roundsd( x, n[, b] )

Rounds a numeric value to the nearest number with n significant figures.

var v = roundsd( 3.141592653589793, 3 );
// returns 3.14

v = roundsd( 3.141592653589793, 1 );
// returns 3.0

v = roundsd( 12368.0, 2 );
// returns 12000.0

The default base is 10 (decimal). To round using a different base, provide a third argument.

var v = roundsd( 0.0313, 2, 2 );
// returns 0.03125

Examples

var randu = require( '@stdlib/random/base/randu' );
var roundsd = require( '@stdlib/math/base/special/roundsd' );

var x;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
    x = (randu()*10000.0) - 5000.0;
    y = roundsd( x, 5 );
    console.log( 'x: %d. Rounded: %d.', x, y );
}