README.md (1602B)
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 # isInfinitef 22 23 > Test if a single-precision floating-point numeric value is infinite. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isInfinitef = require( '@stdlib/math/base/assert/is-infinitef' ); 31 ``` 32 33 #### isInfinitef( x ) 34 35 Tests if a single-precision floating-point `numeric` value is infinite. 36 37 ```javascript 38 var bool = isInfinitef( Infinity ); 39 // returns true 40 41 bool = isInfinitef( -Infinity ); 42 // returns true 43 ``` 44 45 </section> 46 47 <!-- /.usage --> 48 49 <section class="examples"> 50 51 ## Examples 52 53 <!-- eslint no-undef: "error" --> 54 55 ```javascript 56 var PINF = require( '@stdlib/constants/float32/pinf' ); 57 var NINF = require( '@stdlib/constants/float32/ninf' ); 58 var isInfinitef = require( '@stdlib/math/base/assert/is-infinitef' ); 59 60 var bool = isInfinitef( PINF ); 61 // returns true 62 63 bool = isInfinitef( NINF ); 64 // returns true 65 66 bool = isInfinitef( 5.0 ); 67 // returns false 68 69 bool = isInfinitef( NaN ); 70 // returns false 71 ``` 72 73 </section> 74 75 <!-- /.examples --> 76 77 <section class="links"> 78 79 </section> 80 81 <!-- /.links -->