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