@stdlib/math-base-assert-is-nonpositive-integer
Version:
Test if a finite double-precision floating-point number is a nonpositive integer.
52 lines (42 loc) • 1.25 kB
JavaScript
/**
* @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.
*/
;
// MODULES //
var Boolean = require( '@stdlib/boolean-ctor' );
var addon = require( './../src/addon.node' );
// MAIN //
/**
* Tests if a finite double-precision floating-point number is a nonpositive integer.
*
* @private
* @param {number} x - value to test
* @returns {boolean} boolean indicating whether the number is nonpositive integer
*
* @example
* var bool = isNonPositiveInteger( -2.0 );
* // returns true
*
* @example
* var bool = isNonPositiveInteger( 5.0 );
* // returns false
*/
function isNonPositiveInteger( x ) {
return Boolean( addon( x ) );
}
// EXPORTS //
module.exports = isNonPositiveInteger;