-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9234264
commit 10cb9db
Showing
18 changed files
with
1,327 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,6 +21,7 @@ Joey Reed <[email protected]> | |
Jordan Gallivan <[email protected]> | ||
Joris Labie <[email protected]> | ||
Justin Dennison <[email protected]> | ||
Karthik Prakash <[email protected]> | ||
Marcus Fantham <[email protected]> | ||
Matt Cochrane <[email protected]> | ||
Milan Raj <[email protected]> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,163 @@ | ||
<!-- | ||
@license Apache-2.0 | ||
Copyright (c) 2024 The Stdlib Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
# isNonNegativeFinite | ||
|
||
> Test if a value is a number having a nonnegative finite value. | ||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' ); | ||
``` | ||
|
||
#### isNonNegativeFinite( value ) | ||
|
||
Tests if a `value` is a `number` having a nonnegative finite value. | ||
|
||
<!-- eslint-disable no-new-wrappers --> | ||
|
||
```javascript | ||
var Number = require( '@stdlib/number/ctor' ); | ||
|
||
var bool = isNonNegativeFinite( 5.0 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( new Number( 5.0 ) ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( 3.14 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( -5.0 ); | ||
// returns false | ||
|
||
bool = isNonNegativeFinite( null ); | ||
// returns false | ||
|
||
bool = isNonNegativeFinite( Infinity ); | ||
// returns false | ||
``` | ||
|
||
#### isNonNegativeFinite.isPrimitive( value ) | ||
|
||
Tests if a `value` is a primitive `number` having a nonnegative finite value. | ||
|
||
<!-- eslint-disable no-new-wrappers --> | ||
|
||
```javascript | ||
var Number = require( '@stdlib/number/ctor' ); | ||
|
||
var bool = isNonNegativeFinite.isPrimitive( 3.0 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite.isPrimitive( new Number( 3.0 ) ); | ||
// returns false | ||
``` | ||
|
||
#### isNonNegativeFinite.isObject( value ) | ||
|
||
Tests if a `value` is a `Number` object having a nonnegative finite value. | ||
|
||
<!-- eslint-disable no-new-wrappers --> | ||
|
||
```javascript | ||
var Number = require( '@stdlib/number/ctor' ); | ||
|
||
var bool = isNonNegativeFinite.isObject( 3.0 ); | ||
// returns false | ||
|
||
bool = isNonNegativeFinite.isObject( new Number( 3.0 ) ); | ||
// returns true | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint-disable no-new-wrappers --> | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var Number = require( '@stdlib/number/ctor' ); | ||
var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' ); | ||
|
||
var bool = isNonNegativeFinite( 5.0 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( new Number( 5.0 ) ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( 0.0 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( 3.14 ); | ||
// returns true | ||
|
||
bool = isNonNegativeFinite( -5.0 ); | ||
// returns false | ||
|
||
bool = isNonNegativeFinite( '5' ); | ||
// returns false | ||
|
||
bool = isNonNegativeFinite( null ); | ||
// returns false | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
||
* * * | ||
|
||
## See Also | ||
|
||
- <span class="package-name">[`@stdlib/assert/is-number`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span> | ||
- <span class="package-name">[`@stdlib/assert/is-finite`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span> | ||
|
||
</section> | ||
|
||
<!-- /.related --> | ||
|
||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="links"> | ||
|
||
<!-- <related-links> --> | ||
|
||
[@stdlib/assert/is-number]: https://github.com/stdlib-js/assert/tree/main/is-number | ||
[@stdlib/assert/is-finite]: https://github.com/stdlib-js/assert/tree/main/is-finite | ||
|
||
<!-- </related-links> --> | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
Oops, something went wrong.