time-to-botec

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

README.md (2795B)

      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 # isNonNegativeNumber
     22 
     23 > Test if a value is a number having a nonnegative value.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' );
     31 ```
     32 
     33 #### isNonNegativeNumber( value )
     34 
     35 Tests if a `value` is a `number` having a nonnegative value.
     36 
     37 <!-- eslint-disable no-new-wrappers -->
     38 
     39 ```javascript
     40 var Number = require( '@stdlib/number/ctor' );
     41 
     42 var bool = isNonNegativeNumber( 5.0 );
     43 // returns true
     44 
     45 bool = isNonNegativeNumber( new Number( 5.0 ) );
     46 // returns true
     47 
     48 bool = isNonNegativeNumber( 3.14 );
     49 // returns true
     50 
     51 bool = isNonNegativeNumber( -5.0 );
     52 // returns false
     53 
     54 bool = isNonNegativeNumber( null );
     55 // returns false
     56 ```
     57 
     58 #### isNonNegativeNumber.isPrimitive( value )
     59 
     60 Tests if a `value` is a primitive `number` having a nonnegative value.
     61 
     62 <!-- eslint-disable no-new-wrappers -->
     63 
     64 ```javascript
     65 var Number = require( '@stdlib/number/ctor' );
     66 
     67 var bool = isNonNegativeNumber.isPrimitive( 3.0 );
     68 // returns true
     69 
     70 bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) );
     71 // returns false
     72 ```
     73 
     74 #### isNonNegativeNumber.isObject( value )
     75 
     76 Tests if a `value` is a `Number` object having a nonnegative value.
     77 
     78 <!-- eslint-disable no-new-wrappers -->
     79 
     80 ```javascript
     81 var Number = require( '@stdlib/number/ctor' );
     82 
     83 var bool = isNonNegativeNumber.isObject( 3.0 );
     84 // returns false
     85 
     86 bool = isNonNegativeNumber.isObject( new Number( 3.0 ) );
     87 // returns true
     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 isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' );
    105 
    106 var bool = isNonNegativeNumber( 5.0 );
    107 // returns true
    108 
    109 bool = isNonNegativeNumber( new Number( 5.0 ) );
    110 // returns true
    111 
    112 bool = isNonNegativeNumber( 0.0 );
    113 // returns true
    114 
    115 bool = isNonNegativeNumber( 3.14 );
    116 // returns true
    117 
    118 bool = isNonNegativeNumber( -5.0 );
    119 // returns false
    120 
    121 bool = isNonNegativeNumber( '5' );
    122 // returns false
    123 
    124 bool = isNonNegativeNumber( null );
    125 // returns false
    126 ```
    127 
    128 </section>
    129 
    130 <!-- /.examples -->
    131 
    132 <section class="links">
    133 
    134 </section>
    135 
    136 <!-- /.links -->