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

124 lines
2.1 KiB
Markdown
Raw Normal View History

<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# trunc10
> Round a numeric value to the nearest power of 10 toward zero.
<section class="usage">
## Usage
```javascript
var trunc10 = require( '@stdlib/math/base/special/trunc10' );
```
#### trunc10( x )
Rounds a `numeric` value to the nearest power of 10 toward zero.
```javascript
var v = trunc10( -4.2 );
// returns -1.0
v = trunc10( -4.5 );
// returns -1.0
v = trunc10( -4.6 );
// returns -1.0
v = trunc10( 9.99999 );
// returns 1.0
v = trunc10( 9.5 );
// returns 1.0
v = trunc10( 13.0 );
// returns 10.0
v = trunc10( -13.0 );
// returns -10.0
v = trunc10( 0.0 );
// returns 0.0
v = trunc10( -0.0 );
// returns -0.0
v = trunc10( Infinity );
// returns Infinity
v = trunc10( -Infinity );
// returns -Infinity
v = trunc10( NaN );
// returns NaN
```
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- The function may not return accurate results for subnormals due to a general loss in precision.
```javascript
var v = trunc10( 1.0e-323 ); // should return 1.0e-323
// returns 0.0
```
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var randu = require( '@stdlib/random/base/randu' );
var trunc10 = require( '@stdlib/math/base/special/trunc10' );
var x;
var v;
var i;
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
v = trunc10( x );
console.log( 'Value: %d. Rounded: %d.', x, v );
}
```
</section>
<!-- /.examples -->
<section class="links">
</section>
<!-- /.links -->