time-to-botec

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

is_integer.js (1237B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2021 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 // MAIN //
     22 
     23 /**
     24 * Tests if a finite double-precision floating-point number is an integer.
     25 *
     26 * @private
     27 * @param {number} x - value to test
     28 * @returns {boolean} boolean indicating whether the value is an integer
     29 *
     30 * @example
     31 * var bool = isInteger( 1.0 );
     32 * // returns true
     33 *
     34 * @example
     35 * var bool = isInteger( 3.14 );
     36 * // returns false
     37 */
     38 function isInteger( x ) {
     39 	// NOTE: we explicitly avoid using `@stdlib/math/base/special` here in order to avoid circular dependencies.
     40 	return ( Math.floor( x ) === x ); // eslint-disable-line stdlib/no-builtin-math
     41 }
     42 
     43 
     44 // EXPORTS //
     45 
     46 module.exports = isInteger;