time-to-botec

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

is_probability.js (1114B)

      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 /**
     22 * Tests if a numeric value is a probability.
     23 *
     24 * @param {number} x - value to test
     25 * @returns {boolean} boolean indicating whether the value is a probability
     26 *
     27 * @example
     28 * var bool = isProbability( 0.5 );
     29 * // returns true
     30 *
     31 * @example
     32 * var bool = isProbability( 3.14 );
     33 * // returns false
     34 *
     35 * @example
     36 * var bool = isProbability( NaN );
     37 * // returns false
     38 */
     39 function isProbability( x ) {
     40 	return ( x >= 0.0 && x <= 1.0 );
     41 }
     42 
     43 
     44 // EXPORTS //
     45 
     46 module.exports = isProbability;