time-to-botec/squiggle/node_modules/@stdlib/number/float32/base/to-int32/README.md

102 lines
2.3 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.
-->
# toInt32
> Convert a [single-precision floating-point number][ieee754] to a signed 32-bit integer.
<section class="usage">
## Usage
```javascript
var float32ToInt32 = require( '@stdlib/number/float32/base/to-int32' );
```
#### float32ToInt32( x )
Converts a [single-precision floating-point number][ieee754] to a signed 32-bit integer.
```javascript
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
var y = float32ToInt32( float64ToFloat32( 4294967295.0 ) );
// returns 0
y = float32ToInt32( float64ToFloat32( 3.14 ) );
// returns 3
y = float32ToInt32( float64ToFloat32( -3.14 ) );
// returns -3
y = float32ToInt32( float64ToFloat32( NaN ) );
// returns 0
y = float32ToInt32( float64ToFloat32( Infinity ) );
// returns 0
y = float32ToInt32( float64ToFloat32( -Infinity ) );
// returns 0
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var MAX_INT = require( '@stdlib/constants/uint32/max' );
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
var float32ToInt32 = require( '@stdlib/number/float32/base/to-int32' );
var int32;
var f32;
var i;
for ( i = 0; i < 500; i++ ) {
// Generate a random single-precision floating-point integer:
f32 = float64ToFloat32( round( randu()*MAX_INT ) );
// Convert the single-precision floating-point integer to a signed integer:
int32 = float32ToInt32( f32 );
console.log( 'float32: %d => int32: %d', f32, int32 );
}
```
</section>
<!-- /.examples -->
<section class="links">
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
</section>
<!-- /.links -->