index.js (1601B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Half-precision floating-point positive infinity. 23 * 24 * @module @stdlib/constants/float16/pinf 25 * @type {number} 26 * 27 * @example 28 * var FLOAT16_PINF = require( '@stdlib/constants/float16/pinf' ); 29 * // returns +infinity 30 */ 31 32 // MODULES // 33 34 var Number = require( '@stdlib/number/ctor' ); 35 36 37 // MAIN // 38 39 /** 40 * Half-precision floating-point positive infinity. 41 * 42 * ## Notes 43 * 44 * Half-precision floating-point positive infinity has the bit sequence 45 * 46 * ```binarystring 47 * 0 11111 0000000000 48 * ``` 49 * 50 * This bit sequence corresponds to the unsigned 16-bit integer `31744` and to the HEX value `0x7c00`. 51 * 52 * @constant 53 * @type {number} 54 * @default infinity 55 * @see [half-precision floating-point format]{@link https://en.wikipedia.org/wiki/Half-precision_floating-point_format} 56 */ 57 var FLOAT16_PINF = Number.POSITIVE_INFINITY; // TODO: if, and when, float16 is natively available, assign the true constant; otherwise, fall back to float64 58 59 60 // EXPORTS // 61 62 module.exports = FLOAT16_PINF;