time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

is_nonpositive_integer.js (1287B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var floor = require( './../../../../base/special/floor' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Tests if a finite double-precision floating-point number is a nonpositive integer.
     30 *
     31 * @param {number} x - value to test
     32 * @returns {boolean} boolean indicating whether the value is a nonpositive integer
     33 *
     34 * @example
     35 * var bool = isNonPositiveInteger( -1.0 );
     36 * // returns true
     37 *
     38 * @example
     39 * var bool = isNonPositiveInteger( 0.0 );
     40 * // returns true
     41 *
     42 * @example
     43 * var bool = isNonPositiveInteger( 10.0 );
     44 * // returns false
     45 */
     46 function isNonPositiveInteger( x ) {
     47 	return (floor(x) === x && x <= 0);
     48 }
     49 
     50 
     51 // EXPORTS //
     52 
     53 module.exports = isNonPositiveInteger;