@stdlib/assert-is-nonpositive-finite v0.1.0

isNonPositiveFinite

Test if a value is a number having a nonpositive finite value.

Installation

npm install @stdlib/assert-is-nonpositive-finite

Usage

var isNonPositiveFinite = require( '@stdlib/assert-is-nonpositive-finite' );

isNonPositiveFinite( value )

Tests if a value is a number having a nonpositive finite value.

var Number = require( '@stdlib/number-ctor' );
var NINF = require('@stdlib/constants-float64-ninf');

var bool = isNonPositiveFinite( -5.0 );
// returns true

bool = isNonPositiveFinite( NINF );
// returns false

bool = isNonPositiveFinite( new Number( -5.0 ) );
// returns true

bool = isNonPositiveFinite( -3.14 );
// returns true

bool = isNonPositiveFinite( 5.0 );
// returns false

bool = isNonPositiveFinite( null );
// returns false

isNonPositiveFinite.isPrimitive( value )

Tests if a value is a primitive number having a nonpositive finite value.

var Number = require( '@stdlib/number-ctor' );

var bool = isNonPositiveFinite.isPrimitive( -3.0 );
// returns true

bool = isNonPositiveFinite.isPrimitive( new Number( -3.0 ) );
// returns false

isNonPositiveFinite.isObject( value )

Tests if a value is a Number object having a nonpositive finite value.

var Number = require( '@stdlib/number-ctor' );

var bool = isNonPositiveFinite.isObject( -3.0 );
// returns false

bool = isNonPositiveFinite.isObject( new Number( -3.0 ) );
// returns true

Examples

var Number = require( '@stdlib/number-ctor' );
var isNonPositiveFinite = require( '@stdlib/assert-is-nonpositive-finite' );
var NINF = require('@stdlib/constants-float64-ninf');

var bool = isNonPositiveFinite( -5.0 );
// returns true

bool = isNonPositiveFinite( NINF );
// returns false

bool = isNonPositiveFinite( new Number( -5.0 ) );
// returns true

bool = isNonPositiveFinite( 0.0 );
// returns true

bool = isNonPositiveFinite( -3.14 );
// returns true

bool = isNonPositiveFinite( 5.0 );
// returns false

bool = isNonPositiveFinite( '-5' );
// returns false

bool = isNonPositiveFinite( null );
// 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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.