About stdlib...

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!

isNonNegativeIntegerf

Test if a finite single-precision floating-point number is a nonnegative integer.

Installation

npm install @stdlib/math-base-assert-is-nonnegative-integerf

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var isNonNegativeIntegerf = require( '@stdlib/math-base-assert-is-nonnegative-integerf' );

isNonNegativeIntegerf( x )

Tests if a finite single-precision floating-point number is a nonnegative integer.

var bool = isNonNegativeIntegerf( 1.0 );
// returns true

bool = isNonNegativeIntegerf( 0.0 );
// returns true

bool = isNonNegativeIntegerf( -10.0 );
// returns false

Notes

• The function assumes a finite number. If provided positive infinity, the function will return true, when, in fact, the result is undefined. If x can be infinite, wrap the implementation as follows:

  function check( x ) {
      return (
          x < Infinity &&
          isNonNegativeIntegerf( x )
      );
  }
  
  var bool = check( Infinity );
  // returns false

• The function does not distinguish between positive and negative zero.

  var bool = isNonNegativeIntegerf( 0.0 );
  // returns true
  
  bool = isNonNegativeIntegerf( -0.0 );
  // returns true

Examples

var isNonNegativeIntegerf = require( '@stdlib/math-base-assert-is-nonnegative-integerf' );

var bool = isNonNegativeIntegerf( 5.0 );
// returns true

bool = isNonNegativeIntegerf( 0.0 );
// returns true

bool = isNonNegativeIntegerf( -1.0 );
// returns false

bool = isNonNegativeIntegerf( 3.14 );
// returns false

bool = isNonNegativeIntegerf( NaN );
// returns false

---

C APIs

Usage

#include "stdlib/math/base/assert/is_nonnegative_integerf.h"

stdlib_base_is_nonnegative_integerf( x )

Tests if a finite single-precision floating-point number is a nonnegative integer.

#include <stdbool.h>

bool out = stdlib_base_is_nonnegative_integerf( 1.0f );
// returns true

out = stdlib_base_is_nonnegative_integerf( -10.0f );
// returns false

The function accepts the following arguments:

• x: [in] float input value.

bool stdlib_base_is_nonnegative_integerf( const float x );

Examples

#include "stdlib/math/base/assert/is_nonnegative_integerf.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>

int main( void ) {
    float x;
    bool v;
    int i;

    for ( i = 0; i < 100; i++ ) {
        x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0f ) - 50.0f;
        v = stdlib_base_is_nonnegative_integerf( x );
        printf( "x = %f, is_nonnegative_integerf(x) = %s\n", x, ( v ) ? "true" : "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

---

Copyright

Copyright © 2016-2024. The Stdlib Authors.