time-to-botec

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

index.js (2111B)

      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-like object containing only probabilities.
     23 *
     24 * @module @stdlib/assert/is-probability-array
     25 *
     26 * @example
     27 * var isNonNegativeNumberArray = require( '@stdlib/assert/is-probability-array' );
     28 *
     29 * var bool = isProbabilityArray( [ 0.5, new Number(0.8) ] );
     30 * // returns true
     31 *
     32 * bool = isProbabilityArray( [ 0.8, 1.2 ] );
     33 * // returns false
     34 *
     35 * bool = isProbabilityArray( [ 0.8, '0.2' ] );
     36 * // returns false
     37 *
     38 * @example
     39 * var isProbabilityArray = require( '@stdlib/assert/is-probability-array' ).primitives;
     40 *
     41 * var bool = isProbabilityArray( [ 1.0, 0.0, 0.5 ] );
     42 * // returns true
     43 *
     44 * bool = isProbabilityArray( [ 0.3, new Number(0.4) ] );
     45 * // returns false
     46 *
     47 * @example
     48 * var isProbabilityArray = require( '@stdlib/assert/is-probability-array' ).objects;
     49 *
     50 * var bool = isProbabilityArray( [ new Number(0.7), new Number(1.0) ] );
     51 * // returns true
     52 *
     53 * bool = isProbabilityArray( [ 1.0, 0.0, new Number(0.7) ] );
     54 * // returns false
     55 */
     56 
     57 // MODULES //
     58 
     59 var isProbability = require( './../../is-probability' );
     60 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     61 var arrayfun = require( './../../tools/array-like-function' );
     62 
     63 
     64 // MAIN //
     65 
     66 var isProbabilityArray = arrayfun( isProbability );
     67 setReadOnly( isProbabilityArray, 'primitives', arrayfun( isProbability.isPrimitive ) );
     68 setReadOnly( isProbabilityArray, 'objects', arrayfun( isProbability.isObject ) );
     69 
     70 
     71 // EXPORTS //
     72 
     73 module.exports = isProbabilityArray;