@stdlib/math-base-assert-is-positive-integer

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

Test if a finite double-precision floating-point number is a positive integer.

Installation

npm install @stdlib/math-base-assert-is-positive-integer

Usage

var isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );

isPositiveInteger( x )

Tests if a finite double-precision floating-point number is a positive integer.

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:

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

Examples

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

---

See Also

• @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: test if a finite double-precision floating-point number is a negative 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: test if a finite double-precision floating-point number is a nonpositive integer.

---

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-2023. The Stdlib Authors.

Changelog

0.1.0 (2023-09-23)

<section class="features">

Features

• 58832ee - update minimum TypeScript version

</section> <!-- /.features --> <section class="breaking-changes">

BREAKING CHANGES

• 58832ee: update minimum TypeScript version to 4.1

  • To migrate, users should upgrade their TypeScript version to at least version 4.1.

</section> <!-- /.breaking-changes --> <section class="commits">

Commits

<details>

• 58832ee - feat: update minimum TypeScript version (by Philipp Burckhardt)
• b734544 - refactor: use strictEqual checks (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.0.7">