object.js (1269B)
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 isNumber = require( './../../is-number' ).isObject; 24 25 26 // MAIN // 27 28 /** 29 * Tests if a value is a number object having a value which is a probability. 30 * 31 * @param {*} value - value to test 32 * @returns {boolean} boolean indicating if a value is a number object having a value which is a probability 33 * 34 * @example 35 * var bool = isProbability( 0.5 ); 36 * // returns false 37 * 38 * @example 39 * var bool = isProbability( new Number( 0.5 ) ); 40 * // returns true 41 */ 42 function isProbability( value ) { 43 return ( 44 isNumber( value ) && 45 value.valueOf() >= 0.0 && 46 value.valueOf() <= 1.0 47 ); 48 } 49 50 51 // EXPORTS // 52 53 module.exports = isProbability;