time-to-botec

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

README.md (1709B)


      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2020 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 # isfinitef
     22 
     23 > Test if a single-precision floating-point numeric value is finite.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isfinitef = require( '@stdlib/math/base/assert/is-finitef' );
     31 ```
     32 
     33 #### isfinitef( x )
     34 
     35 Tests if a single-precision floating-point `numeric` value is finite.
     36 
     37 ```javascript
     38 var bool = isfinitef( 3.14 );
     39 // returns true
     40 
     41 bool = isfinitef( Infinity );
     42 // returns false
     43 
     44 bool = isfinitef( -Infinity );
     45 // returns false
     46 
     47 bool = isfinitef( NaN );
     48 // returns false
     49 ```
     50 
     51 </section>
     52 
     53 <!-- /.usage -->
     54 
     55 <section class="examples">
     56 
     57 ## Examples
     58 
     59 <!-- eslint no-undef: "error" -->
     60 
     61 ```javascript
     62 var PINF = require( '@stdlib/constants/float32/pinf' );
     63 var NINF = require( '@stdlib/constants/float32/ninf' );
     64 var isfinitef = require( '@stdlib/math/base/assert/is-finitef' );
     65 
     66 var bool = isfinitef( 5.0 );
     67 // returns true
     68 
     69 bool = isfinitef( -2.0e32 );
     70 // returns true
     71 
     72 bool = isfinitef( PINF );
     73 // returns false
     74 
     75 bool = isfinitef( NINF );
     76 // returns false
     77 
     78 bool = isfinitef( NaN );
     79 // returns false
     80 ```
     81 
     82 </section>
     83 
     84 <!-- /.examples -->
     85 
     86 <section class="links">
     87 
     88 </section>
     89 
     90 <!-- /.links -->