@stdlib/assert-is-infinite
v0.2.1
Published
Test if a value is an infinite number.
Downloads
103
Readme
isInfinite
Test if a value is an infinite number.
Installation
npm install @stdlib/assert-is-infinite
Usage
var isInfinite = require( '@stdlib/assert-is-infinite' );
isInfinite( value )
Tests if a value is an infinite number
.
var Number = require( '@stdlib/number-ctor' );
var bool = isInfinite( 1.0/0.0 );
// returns true
bool = isInfinite( new Number( 1.0/0.0 ) );
// returns true
bool = isInfinite( 1.0 );
// returns false
bool = isInfinite( null );
// returns false
isInfinite.isPrimitive( value )
Tests if a value
is a primitive number
having an infinite value.
var Number = require( '@stdlib/number-ctor' );
var bool = isInfinite.isPrimitive( -1.0/0.0 );
// returns true
bool = isInfinite.isPrimitive( new Number( -1.0/0.0 ) );
// returns false
isInfinite.isObject( value )
Tests if a value
is a Number
object having an infinite value.
var Number = require( '@stdlib/number-ctor' );
var bool = isInfinite.isObject( 1.0/0.0 );
// returns false
bool = isInfinite.isObject( new Number( 1.0/0.0 ) );
// returns true
Examples
var Number = require( '@stdlib/number-ctor' );
var isInfinite = require( '@stdlib/assert-is-infinite' );
var bool = isInfinite( 1.0/0.0 );
// returns true
bool = isInfinite( -1.0/0.0 );
// returns true
bool = isInfinite( new Number( 1.0/0.0 ) );
// returns true
bool = isInfinite( -5.0 );
// returns false
bool = isInfinite( 0.0 );
// returns false
bool = isInfinite( 5.256 );
// returns false
bool = isInfinite( '1.0/0.0' );
// returns false
bool = isInfinite( null );
// returns false
See Also
@stdlib/assert-is-finite
: test if a value is a finite number.
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.