Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/math-base-assert-is-safe-integer

Test if a finite double-precision floating-point number is a safe integer.
https://github.com/stdlib-js/math-base-assert-is-safe-integer

assert assertion int integer is isinteger issafeinteger javascript math mathematics node node-js nodejs number safe stdlib util utilities utility utils

Last synced: 4 days ago
JSON representation

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

Awesome Lists containing this project

README 

        



  

    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



[![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.



## Installation



```bash

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][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] 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



```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

```



## Notes



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



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



## Examples



```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 APIs



### Usage



```c

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

```



#### stdlib_base_is_safe_integer( x )



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



```c

#include 



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 );

```



### Examples



```c

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

#include 

#include 



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][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-safe-integer.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-safe-integer



[test-image]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-safe-integer/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-safe-integer?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-assert-is-safe-integer/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-assert-is-safe-integer/main/LICENSE



[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985