time-to-botec

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

index.js (1301B)

      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 * Test if a value is an array of probabilities that sum to one.
     23 *
     24 * @module @stdlib/assert/is-unity-probability-array
     25 *
     26 * @example
     27 * var isUnityProbabilityArray = require( '@stdlib/assert/is-unity-probability-array' );
     28 *
     29 * var bool = isUnityProbabilityArray( [ 0.25, 0.5, 0.25 ] );
     30 * // returns true
     31 *
     32 * bool = isUnityProbabilityArray( new Uint8Array( [ 0, 1 ] ) );
     33 * // returns true
     34 *
     35 * bool = isUnityProbabilityArray( [ 0.4, 0.4, 0.4 ] );
     36 * // returns false
     37 *
     38 * bool = isUnityProbabilityArray( [ 3.14, 0.0 ] );
     39 * // returns false
     40 */
     41 
     42 // MODULES //
     43 
     44 var isUnityProbabilityArray = require( './main.js' );
     45 
     46 
     47 // EXPORTS //
     48 
     49 module.exports = isUnityProbabilityArray;