time-to-botec

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

README.md (1812B)

      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 # isPRNGLike
     22 
     23 > Test if a value is PRNG-like.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isPRNGLike = require( '@stdlib/assert/is-prng-like' );
     31 ```
     32 
     33 #### isPRNGLike( value )
     34 
     35 Tests if a value is PRNG-like.
     36 
     37 ```javascript
     38 var randu = require( '@stdlib/random/base/randu' );
     39 
     40 var bool = isPRNGLike( randu );
     41 // returns true
     42 ```
     43 
     44 </section>
     45 
     46 <!-- /.usage -->
     47 
     48 <section class="notes">
     49 
     50 ## Notes
     51 
     52 -   The function is **not** rigorous and only checks for the existence of particular properties which **should** be bound to a seedable pseudorandom number generator (PRNG) function. The function's main use case is for testing that a provided `value` (loosely) conforms to a particular interface.
     53 
     54 </section>
     55 
     56 <!-- /.notes -->
     57 
     58 <section class="examples">
     59 
     60 ## Examples
     61 
     62 <!-- eslint no-undef: "error" -->
     63 
     64 ```javascript
     65 var randu = require( '@stdlib/random/base/randu' );
     66 var isPRNGLike = require( '@stdlib/assert/is-prng-like' );
     67 
     68 var bool = isPRNGLike( randu );
     69 // returns true
     70 
     71 bool = isPRNGLike( [ 1, 2, 3, 4 ] );
     72 // returns false
     73 
     74 bool = isPRNGLike( {} );
     75 // returns false
     76 
     77 bool = isPRNGLike( null );
     78 // returns false
     79 ```
     80 
     81 </section>
     82 
     83 <!-- /.examples -->
     84 
     85 <section class="links">
     86 
     87 </section>
     88 
     89 <!-- /.links -->