https://github.com/stdlib-js/math-base-assert-is-positive-integer
Test if a finite double-precision floating-point number is a positive integer.
https://github.com/stdlib-js/math-base-assert-is-positive-integer
assert assertion counting int integer is javascript math mathematics natural node node-js nodejs number positive stdlib util utilities utility utils
Last synced: 21 days ago
JSON representation
Test if a finite double-precision floating-point number is a positive integer.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-assert-is-positive-integer
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:28:50.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-03-23T04:31:34.000Z (about 2 months ago)
- Last Synced: 2026-04-08T19:37:04.898Z (about 1 month ago)
- Topics: assert, assertion, counting, int, integer, is, javascript, math, mathematics, natural, node, node-js, nodejs, number, positive, stdlib, util, utilities, utility, utils
- Language: Python
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 437 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
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!
# isPositiveInteger
[![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.
## Installation
```bash
npm install @stdlib/math-base-assert-is-positive-integer
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] 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
```javascript
var isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );
```
#### isPositiveInteger( x )
Tests if a finite [double-precision floating-point number][ieee754] is a positive integer.
```javascript
var bool = isPositiveInteger( 1.0 );
// returns true
bool = isPositiveInteger( 0.0 );
// returns false
bool = isPositiveInteger( -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:
```javascript
function check( x ) {
return (
x < Infinity &&
isPositiveInteger( x )
);
}
var bool = check( Infinity );
// returns false
```
## Examples
```javascript
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 false
```
* * *
## C APIs
### Usage
```c
#include "stdlib/math/base/assert/is_positive_integer.h"
```
#### stdlib_base_is_positive_integer( x )
Tests if a finite [double-precision floating-point number][ieee754] is a positive integer.
```c
#include
bool out = stdlib_base_is_positive_integer( 3.0 );
// returns true
out = stdlib_base_is_positive_integer( -4.0 );
// returns false
```
The function accepts the following arguments:
- **x**: `[in] double` input value.
```c
bool stdlib_base_is_positive_integer( const double x );
```
### Examples
```c
#include "stdlib/math/base/assert/is_positive_integer.h"
#include
#include
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" );
}
}
```
* * *
## See Also
- [`@stdlib/math-base/assert/is-integer`][@stdlib/math/base/assert/is-integer]: test if a finite double-precision floating-point number is an integer.
- [`@stdlib/math-base/assert/is-negative-integer`][@stdlib/math/base/assert/is-negative-integer]: test if a finite double-precision floating-point number is a negative integer.
- [`@stdlib/math-base/assert/is-nonnegative-integer`][@stdlib/math/base/assert/is-nonnegative-integer]: test if a finite double-precision floating-point number is a nonnegative integer.
- [`@stdlib/math-base/assert/is-nonpositive-integer`][@stdlib/math/base/assert/is-nonpositive-integer]: test if a finite double-precision floating-point number is a nonpositive integer.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-positive-integer.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-positive-integer
[test-image]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-positive-integer/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-positive-integer?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-assert-is-positive-integer/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-assert-is-positive-integer/main/LICENSE
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
[@stdlib/math/base/assert/is-integer]: https://github.com/stdlib-js/math-base-assert-is-integer
[@stdlib/math/base/assert/is-negative-integer]: https://github.com/stdlib-js/math-base-assert-is-negative-integer
[@stdlib/math/base/assert/is-nonnegative-integer]: https://github.com/stdlib-js/math-base-assert-is-nonnegative-integer
[@stdlib/math/base/assert/is-nonpositive-integer]: https://github.com/stdlib-js/math-base-assert-is-nonpositive-integer