Test if a finite double-precision floating-point number is a positive integer.
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!
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Test if a finite [double-precision floating-point number][ieee754] is a positive integer.
bash
npm install @stdlib/math-base-assert-is-positive-integerscript tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).deno][deno-url] branch (see [README][deno-readme] for usage intructions).umd][umd-url] branch (see [README][umd-readme]).javascript
var isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );integer.javascript
var bool = isPositiveInteger( 1.0 );
// returns true
bool = isPositiveInteger( 0.0 );
// returns false
bool = isPositiveInteger( -10.0 );
// returns falsenumber. 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:javascript
function check( x ) {
return (
x < Infinity &&
isPositiveInteger( x )
);
}
var bool = check( Infinity );
// returns falsejavascript
var isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );
var bool = isPositiveInteger( 5.0 );
// returns true
bool = isPositiveInteger( 0.0 );
// returns false
bool = isPositiveInteger( -1.0 );
// returns false
bool = isPositiveInteger( 3.14 );
// returns false
bool = isPositiveInteger( NaN );
// returns falsec
#include "stdlib/math/base/assert/is_positive_integer.h"c
#include <stdbool.h>
bool out = stdlib_base_is_positive_integer( 3.0 );
// returns true
out = stdlib_base_is_positive_integer( -4.0 );
// returns false[in] double input value.c
bool stdlib_base_is_positive_integer( const double x );c
#include "stdlib/math/base/assert/is_positive_integer.h"
#include <stdio.h>
#include <stdbool.h>
int main( void ) {
const double x[] = { 5.0, -5.0, 3.14, -3.14, 0.0, 0.0/0.0 };
bool b;
int i;
for ( i = 0; i < 6; i++ ) {
b = stdlib_base_is_positive_integer( x[ i ] );
printf( "Value: %lf. Is positive integer? %s.\n", x[ i ], ( b ) ? "True" : "False" );
}
}
