82 lines
1.6 KiB
Markdown
82 lines
1.6 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# isInfinite
|
||
|
|
|
||
|
|
> Test if a double-precision floating-point numeric value is infinite.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var isInfinite = require( '@stdlib/math/base/assert/is-infinite' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### isInfinite( x )
|
||
|
|
|
||
|
|
Tests if a double-precision floating-point `numeric` value is infinite.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bool = isInfinite( Infinity );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isInfinite( -Infinity );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var PINF = require( '@stdlib/constants/float64/pinf' );
|
||
|
|
var NINF = require( '@stdlib/constants/float64/ninf' );
|
||
|
|
var isInfinite = require( '@stdlib/math/base/assert/is-infinite' );
|
||
|
|
|
||
|
|
var bool = isInfinite( PINF );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isInfinite( NINF );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isInfinite( 5.0 );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isInfinite( NaN );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|