-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.d.ts
More file actions
167 lines (142 loc) · 2.66 KB
/
index.d.ts
File metadata and controls
167 lines (142 loc) · 2.66 KB
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
/*
* @license Apache-2.0
*
* Copyright (c) 2024 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: 4.1
/**
* Interface describing default data types.
*/
interface DataTypes {
/**
* Default data type.
*/
default: 'float64';
/**
* Default numeric data type.
*/
numeric: 'float64';
/**
* Default real-valued data type.
*/
real: 'float64';
/**
* Default floating-point data type.
*/
floating_point: 'float64';
/**
* Default real-valued floating-point data type.
*/
real_floating_point: 'float64';
/**
* Default complex-valued floating-point data type.
*/
complex_floating_point: 'complex128';
/**
* Default integer data type.
*/
integer: 'int32';
/**
* Default signed integer data type.
*/
signed_integer: 'int32';
/**
* Default unsigned integer data type.
*/
unsigned_integer: 'uint32';
/**
* Default boolean value data type.
*/
boolean: 'bool';
/**
* Default index data type.
*/
index: 'int32';
/**
* Default integer index data type.
*/
integer_index: 'int32';
/**
* Default boolean index data type.
*/
boolean_index: 'bool';
/**
* Default mask index data type.
*/
mask_index: 'uint8';
}
/**
* Interface describing default ndarray settings.
*/
interface Defaults {
/**
* Default data types.
*/
dtypes: DataTypes;
/**
* Default memory layout.
*/
order: 'row-major';
/**
* Default casting mode.
*/
casting: 'safe';
/**
* Default index mode.
*/
index_mode: 'throw';
}
/**
* Interface for returning default ndarray settings.
*/
interface DefaultsFunction {
/**
* Returns default ndarray settings.
*
* @returns default settings
*
* @example
* var o = defaults();
* // returns {...}
*/
(): Defaults;
/**
* Returns a default ndarray setting.
*
* @param name - setting name
* @returns setting value or null
*
* @example
* var v = defaults.get( 'order' );
* // returns <string>
*/
get( name: string ): any;
}
/**
* Returns default ndarray settings.
*
* @returns default settings
*
* @example
* var o = defaults();
* // returns {...}
*
* @example
* var v = defaults.get( 'order' );
* // returns <string>
*/
declare var defaults: DefaultsFunction;
// EXPORTS //
export = defaults;