time-to-botec

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

README.md (2874B)

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