README.md (1560B)
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 # Positive Infinity 22 23 > [Half-precision floating-point][half-precision-floating-point-format] positive infinity. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var FLOAT16_PINF = require( '@stdlib/constants/float16/pinf' ); 31 ``` 32 33 #### FLOAT16_PINF 34 35 [Half-precision floating-point][half-precision-floating-point-format] positive infinity. 36 37 ```javascript 38 // FLOAT16_PINF is implicitly promoted to a double-precision floating-point number... 39 var bool = ( FLOAT16_PINF === Infinity ); 40 // returns true 41 ``` 42 43 </section> 44 45 <!-- /.usage --> 46 47 <section class="examples"> 48 49 ## Examples 50 51 <!-- TODO: better example --> 52 53 <!-- eslint no-undef: "error" --> 54 55 ```javascript 56 var FLOAT16_PINF = require( '@stdlib/constants/float16/pinf' ); 57 58 console.log( FLOAT16_PINF ); 59 // => +Infinity 60 ``` 61 62 </section> 63 64 <!-- /.examples --> 65 66 <section class="links"> 67 68 [half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format 69 70 </section> 71 72 <!-- /.links -->