stdlib-js
<summary>
About stdlib...
</summary>
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isSafeInteger
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Test if a finite [double-precision floating-point number][ieee754] is a safe integer.
bash
npm install @stdlib/math-base-assert-is-safe-integer
javascript
var isSafeInteger = require( '@stdlib/math-base-assert-is-safe-integer' );
#### isSafeInteger( x )
Tests if a finite [double-precision floating-point number][ieee754] is a safe integer.
javascript
var bool = isSafeInteger( 1.0 );
// returns true
javascript
var MAX_SAFE_INTEGER = require( '@stdlib/constants-float64-max-safe-integer' );
// returns 9007199254740991
var x = 9007199254740992;
// returns 9007199254740992
var y = 9007199254740993;
// returns 9007199254740992
var bool = ( x === y );
// returns true
In this example, x and y should be distinct, but they are not due to constraints imposed by storing numeric values in [double-precision floating-point format][ieee754]. "Safe" integers are thus [double-precision floating-point numbers][ieee754] having integer values with unequivocal binary representations.
javascript
var isSafeInteger = require( '@stdlib/math-base-assert-is-safe-integer' );
var bool = isSafeInteger( -5.0 );
// returns true
bool = isSafeInteger( 2.0e200 );
// returns false
bool = isSafeInteger( 3.14 );
// returns false
bool = isSafeInteger( NaN );
// returns false
c
#include "stdlib/math/base/assert/is_safe_integer.h"
#### stdlib_base_is_safe_integer( x )
Test if a finite [double-precision floating-point number][ieee754] is a safe integer.
c
#include <stdbool.h>
bool out = stdlib_base_is_safe_integer( 3.0 );
// returns true
out = stdlib_base_is_safe_integer( 2.0e200 );
// returns false
The function accepts the following arguments:
- x: [in] double input value.
c
bool stdlib_base_is_safe_integer( const double x );
c
#include "stdlib/math/base/assert/is_safe_integer.h"
#include <stdio.h>
#include <stdbool.h>
int main( void ) {
const double x[] = { 5.0, -5.0, 3.14, -3.14, 0.0, 0.0/0.0 };
bool b;
int i;
for ( i = 0; i < 6; i++ ) {
b = stdlib_base_is_safe_integer( x[ i ] );
printf( "Value: %lf. Is safe integer? %s.\n", x[ i ], ( b ) ? "True" : "False" );
}
}
