time-to-botec

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

README.md (3303B)

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