-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
61 lines (56 loc) · 1.66 KB
/
index.d.ts
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
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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
/**
* Returns the size (in bytes) of the canonical binary representation of a specified numeric type.
*
* ## Notes
*
* The following numeric types are supported:
*
* - float64: double-precision floating-point numbers
* - float32: single-precision floating-point numbers
* - float16: half-precision floating-point numbers
* - int32: 32-bit two's complement signed integers
* - uint32: 32-bit unsigned integers
* - int16: 16-bit two's complement signed integers
* - uint16: 16-bit unsigned integers
* - int8: 8-bit two's complement signed integers
* - uint8: 8-bit unsigned integers
* - uint8c: 8-bit unsigned integers clamped to 0-255
* - complex128: 128-bit complex numbers
* - complex64: 64-bit complex numbers
*
* @param dtype - numeric type
* @returns size in bytes
*
* @example
* var s = sizeOf( 'int8' );
* // returns 1
*
* @example
* var s = sizeOf( 'uint8' );
* // returns 1
*
* @example
* var s = sizeOf( 'int16' );
* // returns 2
*/
declare function sizeOf( dtype: string ): number;
// EXPORTS //
export = sizeOf;