0.2.1 • Published 3 months ago
@stdlib/math-base-special-truncb v0.2.1
truncb
Round a numeric value to the nearest multiple of b^n toward zero.
Installation
npm install @stdlib/math-base-special-truncb
Usage
var truncb = require( '@stdlib/math-base-special-truncb' );
truncb( x, n, b )
Rounds a numeric
value to the nearest multiple of b^n
toward zero.
// Round a value to 4 decimal places:
var v = truncb( 3.141592653589793, -4, 10 );
// returns 3.1415
// If n = 0 or b = 1, `truncb` behaves like `trunc`:
v = truncb( 3.141592653589793, 0, 2 );
// returns 3.0
// Round a value to the nearest multiple of two toward zero:
v = truncb( 5.0, 1, 2 );
// returns 4.0
Notes
- Due to rounding error in floating-point numbers, rounding may not be exact.
Examples
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var pow = require( '@stdlib/math-base-special-pow' );
var truncb = require( '@stdlib/math-base-special-truncb' );
var x;
var n;
var b;
var v;
var i;
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
n = round( (randu()*10.0) - 5.0 );
b = round( randu()*10.0 );
v = truncb( x, n, b );
console.log( 'x: %d. %d^%d: %d. Rounded: %d.', x, b, n, pow( b, n ), v );
}
See Also
@stdlib/math-base/special/ceilb
: round a numeric value to the nearest multiple of b^n toward positive infinity.@stdlib/math-base/special/floorb
: round a numeric value to the nearest multiple of b^n toward negative infinity.@stdlib/math-base/special/roundb
: round a numeric value to the nearest multiple of b^n on a linear scale.@stdlib/math-base/special/trunc
: round a double-precision floating-point number toward zero.@stdlib/math-base/special/truncn
: round a numeric value to the nearest multiple of 10^n toward zero.
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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.