@stdlib/math-base-assert-is-infinite
v0.2.2
Published
Test if a double-precision floating-point numeric value is infinite.
Downloads
1,778,579
Readme
isInfinite
Test if a double-precision floating-point numeric value is infinite.
Installation
npm install @stdlib/math-base-assert-is-infinite
Usage
var isInfinite = require( '@stdlib/math-base-assert-is-infinite' );
isInfinite( x )
Tests if a double-precision floating-point numeric
value is infinite.
var bool = isInfinite( Infinity );
// returns true
bool = isInfinite( -Infinity );
// returns true
Examples
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
See Also
@stdlib/math-base/assert/is-finite
: test if a double-precision floating-point numeric value is finite.
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.