README.md (1562B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # isProbability 22 23 > Test if a numeric value is a probability. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isProbability = require( '@stdlib/math/base/assert/is-probability' ); 31 ``` 32 33 #### isProbability( x ) 34 35 Tests if a `numeric` value is a probability. 36 37 ```javascript 38 var bool = isProbability( 0.5 ); 39 // returns true 40 41 bool = isProbability( 3.14 ); 42 // returns false 43 44 bool = isProbability( NaN ); 45 // returns false 46 ``` 47 48 </section> 49 50 <!-- /.usage --> 51 52 <section class="examples"> 53 54 ## Examples 55 56 <!-- eslint no-undef: "error" --> 57 58 ```javascript 59 var randu = require( '@stdlib/random/base/randu' ); 60 var isProbability = require( '@stdlib/math/base/assert/is-probability' ); 61 62 var bool; 63 var x; 64 var i; 65 66 for ( i = 0; i < 100; i++ ) { 67 x = ( randu()*2.0 ) - 1.0; 68 bool = isProbability( x ); 69 console.log( '%d is %s', x, ( bool ) ? 'a probability' : 'not a probability' ); 70 } 71 ``` 72 73 </section> 74 75 <!-- /.examples --> 76 77 <section class="links"> 78 79 </section> 80 81 <!-- /.links -->