File: index.d.ts

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (168 lines) | stat: -rw-r--r-- 4,033 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 2.0

/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */

import CBRT_EPS = require( './../../../float16/cbrt-eps' );
import EPS = require( './../../../float16/eps' );
import EXPONENT_BIAS = require( './../../../float16/exponent-bias' );
import MAX = require( './../../../float16/max' );
import MAX_SAFE_INTEGER = require( './../../../float16/max-safe-integer' );
import MIN_SAFE_INTEGER = require( './../../../float16/min-safe-integer' );
import NINF = require( './../../../float16/ninf' );
import NUM_BYTES = require( './../../../float16/num-bytes' );
import PINF = require( './../../../float16/pinf' );
import PRECISION = require( './../../../float16/precision' );
import SMALLEST_NORMAL = require( './../../../float16/smallest-normal' );
import SMALLEST_SUBNORMAL = require( './../../../float16/smallest-subnormal' );
import SQRT_EPS = require( './../../../float16/sqrt-eps' );

/**
* Interface describing the `float16` namespace.
*/
interface Namespace {
	/**
	* Cube root of half-precision floating-point epsilon.
	*
	* @example
	* var eps = ns.CBRT_EPS;
	* // returns 0.09921256574801247
	*/
	CBRT_EPS: typeof CBRT_EPS;

	/**
	* Difference between one and the smallest value greater than one that can be represented as a half-precision floating-point number.
	*
	* @example
	* var eps = ns.EPSILON;
	* // returns 0.0009765625
	*/
	EPS: typeof EPS;

	/**
	* The bias of a half-precision floating-point number's exponent.
	*
	* @example
	* var bias = ns.EXPONENT_BIAS;
	* // returns 15
	*/
	EXPONENT_BIAS: typeof EXPONENT_BIAS;

	/**
	* Maximum half-precision floating-point number.
	*
	* @example
	* var max = ns.MAX;
	* // returns 65504.0
	*/
	MAX: typeof MAX;

	/**
	* Maximum safe half-precision floating-point integer.
	*
	* @example
	* var max = ns.MAX_SAFE_INTEGER;
	* // returns 2047
	*/
	MAX_SAFE_INTEGER: typeof MAX_SAFE_INTEGER;

	/**
	* Minimum safe half-precision floating-point integer.
	*
	* @example
	* var min = ns.MIN_SAFE_INTEGER;
	* // returns -2047
	*/
	MIN_SAFE_INTEGER: typeof MIN_SAFE_INTEGER;

	/**
	* Half-precision floating-point negative infinity.
	*
	* @example
	* var ninf = ns.NINF;
	* // returns -infinity
	*/
	NINF: typeof NINF;

	/**
	* Size (in bytes) of a half-precision floating-point number.
	*
	* @example
	* var bytes = ns.NUM_BYTES;
	* // returns 2
	*/
	NUM_BYTES: typeof NUM_BYTES;

	/**
	* Half-precision floating-point positive infinity.
	*
	* @example
	* var pinf = ns.PINF;
	* // returns +infinity
	*/
	PINF: typeof PINF;

	/**
	* Effective number of bits in the significand of a half-precision floating-point number.
	*
	* @example
	* var precision = ns.PRECISION;
	* // returns 11
	*/
	PRECISION: typeof PRECISION;

	/**
	* Smallest positive half-precision floating-point normal number.
	*
	* @example
	* var smallest = ns.SMALLEST_NORMAL;
	* // returns 6.103515625e-5
	*/
	SMALLEST_NORMAL: typeof SMALLEST_NORMAL;

	/**
	* Smallest positive half-precision floating-point subnormal number.
	*
	* @example
	* var smallest = ns.SMALLEST_SUBNORMAL;
	* // returns 5.960464477539063e-8
	*/
	SMALLEST_SUBNORMAL: typeof SMALLEST_SUBNORMAL;

	/**
	* Square root of half-precision floating-point epsilon.
	*
	* @example
	* var eps = ns.SQRT_EPS;
	* // returns 0.03125
	*/
	SQRT_EPS: typeof SQRT_EPS;
}

/**
* Half-precision floating-point mathematical constants.
*/
declare var ns: Namespace;


// EXPORTS //

export = ns;