$ npm install @stdlib/assert-is-nonnegative-number
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isNonNegativeNumber
Test if a value is a number having a nonnegative value.
Installation
npm install @stdlib/assert-is-nonnegative-number
Usage
var isNonNegativeNumber = require( '@stdlib/assert-is-nonnegative-number' );
isNonNegativeNumber( value )
Tests if a value is a number having a nonnegative value.
var Number = require( '@stdlib/number-ctor' );
var bool = isNonNegativeNumber( 5.0 );
// returns true
bool = isNonNegativeNumber( new Number( 5.0 ) );
// returns true
bool = isNonNegativeNumber( 3.14 );
// returns true
bool = isNonNegativeNumber( -5.0 );
// returns false
bool = isNonNegativeNumber( null );
// returns false
isNonNegativeNumber.isPrimitive( value )
Tests if a value is a primitive number having a nonnegative value.
var Number = require( '@stdlib/number-ctor' );
var bool = isNonNegativeNumber.isPrimitive( 3.0 );
// returns true
bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) );
// returns false
isNonNegativeNumber.isObject( value )
Tests if a value is a Number object having a nonnegative value.
var Number = require( '@stdlib/number-ctor' );
var bool = isNonNegativeNumber.isObject( 3.0 );
// returns false
bool = isNonNegativeNumber.isObject( new Number( 3.0 ) );
// returns true
Examples
var Number = require( '@stdlib/number-ctor' );
var isNonNegativeNumber = require( '@stdlib/assert-is-nonnegative-number' );
var bool = isNonNegativeNumber( 5.0 );
// returns true
bool = isNonNegativeNumber( new Number( 5.0 ) );
// returns true
bool = isNonNegativeNumber( 0.0 );
// returns true
bool = isNonNegativeNumber( 3.14 );
// returns true
bool = isNonNegativeNumber( -5.0 );
// returns false
bool = isNonNegativeNumber( '5' );
// returns false
bool = isNonNegativeNumber( null );
// returns false
See Also
@stdlib/assert-is-nonnegative-finite: test if a value is a number having a nonnegative finite value.@stdlib/assert-is-nonnegative-integer: test if a value is a number having a nonnegative integer value.@stdlib/assert-is-number: test if a value is a 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.
Current Tags
- 0.2.2 ... latest (4 months ago)
stdlib-bot
kgryte
planeshifter
rreusser