@stdlib/math-base-assert-is-infinite

What is @stdlib/math-base-assert-is-infinite?

@stdlib/math-base-assert-is-infinite is a utility package that provides functions to check if a given value is infinite. This can be useful in various mathematical computations and validations where you need to ensure that values are within a finite range.

What are @stdlib/math-base-assert-is-infinite's main functionalities?

Check if a value is infinite

This feature allows you to check if a given value is either positive or negative infinity. It returns `true` if the value is infinite and `false` otherwise.

const isInfinite = require('@stdlib/math-base-assert-is-infinite');

console.log(isInfinite(Infinity)); // true
console.log(isInfinite(-Infinity)); // true
console.log(isInfinite(5)); // false
console.log(isInfinite(NaN)); // false

Other packages similar to @stdlib/math-base-assert-is-infinite

lodash

Lodash is a utility library that provides a wide range of functions for common programming tasks, including checking if a value is infinite using `_.isFinite`. While it offers more functionality than @stdlib/math-base-assert-is-infinite, it is also a larger library.

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

---

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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.3 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.2">