About stdlib...

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

Test if a finite double-precision floating-point number is a safe integer.

Installation

npm install @stdlib/math-base-assert-is-safe-integer

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var isSafeInteger = require( '@stdlib/math-base-assert-is-safe-integer' );

isSafeInteger( x )

Tests if a finite double-precision floating-point number is a safe integer.

var bool = isSafeInteger( 1.0 );
// returns true

Notes

• An integer valued number is "safe" when the number can be exactly represented as a double-precision floating-point number. For example,

  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. "Safe" integers are thus double-precision floating-point numbers having integer values with unequivocal binary representations.

Examples

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 APIs

Usage

#include "stdlib/math/base/assert/is_safe_integer.h"

stdlib_base_is_safe_integer( x )

Tests if a finite double-precision floating-point number is a safe integer.

#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.

bool stdlib_base_is_safe_integer( const double x );

Examples

#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" );
    }
}

---

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.