294 lines
7.8 KiB
Markdown
294 lines
7.8 KiB
Markdown
|
<!--
|
||
|
|
||
|
@license Apache-2.0
|
||
|
|
||
|
Copyright (c) 2022 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.
|
||
|
|
||
|
-->
|
||
|
|
||
|
|
||
|
<details>
|
||
|
<summary>
|
||
|
About stdlib...
|
||
|
</summary>
|
||
|
<p>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.</p>
|
||
|
<p>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.</p>
|
||
|
<p>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.</p>
|
||
|
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
|
||
|
</details>
|
||
|
|
||
|
# isInteger
|
||
|
|
||
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
||
|
|
||
|
> Test if a finite [double-precision floating-point number][ieee754] is an integer.
|
||
|
|
||
|
<section class="installation">
|
||
|
|
||
|
## Installation
|
||
|
|
||
|
```bash
|
||
|
npm install @stdlib/math-base-assert-is-integer
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<section class="usage">
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
```javascript
|
||
|
var isInteger = require( '@stdlib/math-base-assert-is-integer' );
|
||
|
```
|
||
|
|
||
|
#### isInteger( x )
|
||
|
|
||
|
Tests if a finite [double-precision floating-point number][ieee754] is an integer.
|
||
|
|
||
|
```javascript
|
||
|
var bool = isInteger( 1.0 );
|
||
|
// returns true
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.usage -->
|
||
|
|
||
|
<section class="notes">
|
||
|
|
||
|
## Notes
|
||
|
|
||
|
- The function assumes a **finite** number. If provided positive or negative `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows:
|
||
|
|
||
|
```javascript
|
||
|
function check( x ) {
|
||
|
return (
|
||
|
x < Infinity &&
|
||
|
x > -Infinity &&
|
||
|
isInteger( x )
|
||
|
);
|
||
|
}
|
||
|
|
||
|
var bool = check( Infinity );
|
||
|
// returns false
|
||
|
|
||
|
bool = check( -Infinity );
|
||
|
// returns false
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.notes -->
|
||
|
|
||
|
<section class="examples">
|
||
|
|
||
|
## Examples
|
||
|
|
||
|
<!-- eslint no-undef: "error" -->
|
||
|
|
||
|
```javascript
|
||
|
var isInteger = require( '@stdlib/math-base-assert-is-integer' );
|
||
|
|
||
|
var bool = isInteger( -5.0 );
|
||
|
// returns true
|
||
|
|
||
|
bool = isInteger( 3.14 );
|
||
|
// returns false
|
||
|
|
||
|
bool = isInteger( NaN );
|
||
|
// returns false
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.examples -->
|
||
|
|
||
|
<!-- C interface documentation. -->
|
||
|
|
||
|
* * *
|
||
|
|
||
|
<section class="c">
|
||
|
|
||
|
## C APIs
|
||
|
|
||
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="intro">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.intro -->
|
||
|
|
||
|
<!-- C usage documentation. -->
|
||
|
|
||
|
<section class="usage">
|
||
|
|
||
|
### Usage
|
||
|
|
||
|
```c
|
||
|
#include "stdlib/math/base/assert/is_integer.h"
|
||
|
```
|
||
|
|
||
|
#### stdlib_base_is_integer( x )
|
||
|
|
||
|
Tests if a finite [double-precision floating-point number][ieee754] is an integer.
|
||
|
|
||
|
```c
|
||
|
bool out = stdlib_base_is_integer( 1.0 );
|
||
|
// returns true
|
||
|
|
||
|
out = stdlib_base_is_integer( 3.14 );
|
||
|
// returns false
|
||
|
```
|
||
|
|
||
|
The function accepts the following arguments:
|
||
|
|
||
|
- **x**: `[in] double` input value.
|
||
|
|
||
|
```c
|
||
|
bool stdlib_base_is_integer( const double x );
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.usage -->
|
||
|
|
||
|
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="notes">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.notes -->
|
||
|
|
||
|
<!-- C API usage examples. -->
|
||
|
|
||
|
<section class="examples">
|
||
|
|
||
|
### Examples
|
||
|
|
||
|
```c
|
||
|
#include "stdlib/math/base/assert/is_integer.h"
|
||
|
#include <stdio.h>
|
||
|
#include <stdlib.h>
|
||
|
#include <stdbool.h>
|
||
|
|
||
|
int main( void ) {
|
||
|
double x;
|
||
|
bool v;
|
||
|
int i;
|
||
|
|
||
|
for ( i = 0; i < 100; i++ ) {
|
||
|
x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ) - 50.0;
|
||
|
v = stdlib_base_is_integer( x );
|
||
|
printf( "x = %lf, is_integer(x) = %s\n", x, ( v ) ? "true" : "false" );
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.examples -->
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.c -->
|
||
|
|
||
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
||
|
|
||
|
<section class="related">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.related -->
|
||
|
|
||
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
|
||
|
<section class="main-repo" >
|
||
|
|
||
|
* * *
|
||
|
|
||
|
## 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].
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.stdlib -->
|
||
|
|
||
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
||
|
<section class="links">
|
||
|
|
||
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-integer.svg
|
||
|
[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-integer
|
||
|
|
||
|
[test-image]: https://github.com/stdlib-js/math-base-assert-is-integer/actions/workflows/test.yml/badge.svg?branch=v0.2.5
|
||
|
[test-url]: https://github.com/stdlib-js/math-base-assert-is-integer/actions/workflows/test.yml?query=branch:v0.2.5
|
||
|
|
||
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-integer/main.svg
|
||
|
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-integer?branch=main
|
||
|
|
||
|
<!--
|
||
|
|
||
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-assert-is-integer.svg
|
||
|
[dependencies-url]: https://david-dm.org/stdlib-js/math-base-assert-is-integer/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-integer/tree/deno
|
||
|
[deno-readme]: https://github.com/stdlib-js/math-base-assert-is-integer/blob/deno/README.md
|
||
|
[umd-url]: https://github.com/stdlib-js/math-base-assert-is-integer/tree/umd
|
||
|
[umd-readme]: https://github.com/stdlib-js/math-base-assert-is-integer/blob/umd/README.md
|
||
|
[esm-url]: https://github.com/stdlib-js/math-base-assert-is-integer/tree/esm
|
||
|
[esm-readme]: https://github.com/stdlib-js/math-base-assert-is-integer/blob/esm/README.md
|
||
|
[branches-url]: https://github.com/stdlib-js/math-base-assert-is-integer/blob/main/branches.md
|
||
|
|
||
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-assert-is-integer/main/LICENSE
|
||
|
|
||
|
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.links -->
|