time-to-botec

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

README.md (3329B)

      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 # isSafeIntegerArray
     22 
     23 > Test if a value is an array-like object containing only [safe integers][@stdlib/assert/is-safe-integer].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isSafeIntegerArray = require( '@stdlib/assert/is-safe-integer-array' );
     31 ```
     32 
     33 #### isSafeIntegerArray( value )
     34 
     35 Tests if a `value` is an array-like object containing **only** [safe `integer`][@stdlib/assert/is-safe-integer] values.
     36 
     37 <!-- eslint-disable no-new-wrappers -->
     38 
     39 ```javascript
     40 var Number = require( '@stdlib/number/ctor' );
     41 
     42 var bool = isSafeIntegerArray( [ -3, new Number(3) ] );
     43 // returns true
     44 
     45 bool = isSafeIntegerArray( [ -1e100, 2e200 ] );
     46 // returns false
     47 
     48 bool = isSafeIntegerArray( [ -3, 'abc' ] );
     49 // returns false
     50 ```
     51 
     52 #### isSafeIntegerArray.primitives( value )
     53 
     54 Tests if a `value` is an array-like object containing **only** primitive [safe `integer`][@stdlib/assert/is-safe-integer] values.
     55 
     56 <!-- eslint-disable no-new-wrappers -->
     57 
     58 ```javascript
     59 var Number = require( '@stdlib/number/ctor' );
     60 
     61 var bool = isSafeIntegerArray.primitives( [ -1.0, 0.0, 4.0 ] );
     62 // returns true
     63 
     64 bool = isSafeIntegerArray.primitives( [ -1.0, 2.2 ] );
     65 // returns false
     66 
     67 bool = isSafeIntegerArray.primitives( [ -3.0, new Number(2.0) ] );
     68 // returns false
     69 ```
     70 
     71 #### isSafeIntegerArray.objects( value )
     72 
     73 Tests if a `value` is an array-like object containing **only** `Number` objects holding [safe `integer`][@stdlib/assert/is-safe-integer] values.
     74 
     75 <!-- eslint-disable no-new-wrappers -->
     76 
     77 ```javascript
     78 var Number = require( '@stdlib/number/ctor' );
     79 
     80 var bool = isSafeIntegerArray.objects( [ new Number(-1.0), new Number(2.0) ] );
     81 // returns true
     82 
     83 bool = isSafeIntegerArray.objects( [ -1.0, 0.0, 1.0 ] );
     84 // returns false
     85 
     86 bool = isSafeIntegerArray.objects( [ -3.0, new Number(1.0) ] );
     87 // returns false
     88 ```
     89 
     90 </section>
     91 
     92 <!-- /.usage -->
     93 
     94 <section class="examples">
     95 
     96 ## Examples
     97 
     98 <!-- eslint-disable no-new-wrappers -->
     99 
    100 <!-- eslint no-undef: "error" -->
    101 
    102 ```javascript
    103 var Number = require( '@stdlib/number/ctor' );
    104 var isSafeIntegerArray = require( '@stdlib/assert/is-safe-integer-array' );
    105 
    106 var bool = isSafeIntegerArray( [ -5, 0, 2, 5 ] );
    107 // returns true
    108 
    109 bool = isSafeIntegerArray( [ -4, -3, 1, 3 ] );
    110 // returns true
    111 
    112 bool = isSafeIntegerArray( [ -1, new Number( -6 ), 2 ] );
    113 // returns true
    114 
    115 bool = isSafeIntegerArray( [ 1e100, 2e200, 3e300 ] );
    116 // returns false
    117 
    118 bool = isSafeIntegerArray( [ -1, 'abc', 3 ] );
    119 // returns false
    120 
    121 bool = isSafeIntegerArray( [ -2.3, 0, 3 ] );
    122 // returns false
    123 
    124 bool = isSafeIntegerArray( [] );
    125 // returns false
    126 ```
    127 
    128 </section>
    129 
    130 <!-- /.examples -->
    131 
    132 <section class="links">
    133 
    134 [@stdlib/assert/is-safe-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-safe-integer
    135 
    136 </section>
    137 
    138 <!-- /.links -->