-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
171 lines (157 loc) · 5.2 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
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
169
170
171
/*
* @license Apache-2.0
*
* Copyright (c) 2022 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:unified-signatures
/// <reference types="@stdlib/types"/>
import { ArrayLike, ComplexTypedArray, ComplexDataType as DataType } from '@stdlib/types/array';
import ArrayBuffer = require( '@stdlib/array/buffer' );
/**
* Creates a complex number typed array.
*
* @param dtype - data type (default: 'complex128')
* @returns complex number typed array
*
* @example
* var arr = complexarray();
* // returns <Complex128Array>
*
* @example
* var arr = complexarray( 'complex64');
* // returns <Complex64Array>
*/
declare function complexarray( dtype?: DataType ): ComplexTypedArray;
/**
* Creates a complex number typed array.
*
* @param length - typed array length
* @param dtype - data type (default: 'complex128')
* @returns typed array
*
* @example
* var arr = complexarray( 2 );
* // returns <Complex128Array>
*
* @example
* var arr = complexarray( 2, 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( length: number, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
/**
* Creates a complex number typed array.
*
* @param complexarray - complex number typed array from which to generate another complex number typed array
* @param dtype - data type (default: 'complex128')
* @returns complex number typed array
*
* @example
* var arr = complexarray( new Complex128Array( 2 ) );
* // returns <Complex128Array>
*
* @example
* var arr = complexarray( new Complex128Array( 2 ), 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( complexarray: ComplexTypedArray, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
/**
* Creates a complex number typed array.
*
* @param obj - array-like object or iterable from which to generate a typed array
* @param dtype - data type (default: 'complex128')
* @throws array length must be a multiple of two
* @returns complex number typed array
*
* @example
* var arr = complexarray( [ 0.5, 0.5 ] );
* // returns <Complex128Array>
*
* @example
* var arr = complexarray( [ 5, -3 ], 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( obj: ArrayLike<number> | Iterable<any>, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
/**
* Creates a complex number typed array.
*
* @param buffer - underlying ArrayBuffer
* @param dtype - data type (default: 'complex128')
* @returns complex number typed array
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 32 );
* var arr = complexarray( buf );
* // returns <Complex128Array>
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 32 );
* var arr = complexarray( buf, 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( buffer: ArrayBuffer, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
/**
* Creates a complex number typed array.
*
* @param buffer - underlying ArrayBuffer
* @param byteOffset - integer byte offset specifying the location of the first array element (default: 0)
* @param dtype - data type (default: 'complex128')
* @returns complex number typed array
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 32 );
* var arr = complexarray( buf, 16 );
* // returns <Complex128Array>
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 32 );
* var arr = complexarray( buf, 16, 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( buffer: ArrayBuffer, byteOffset?: number, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
/**
* Creates a complex number typed array.
*
* @param buffer - underlying ArrayBuffer
* @param byteOffset - integer byte offset specifying the location of the first array element (default: 0)
* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
* @param dtype - data type (default: 'complex128')
* @returns complex number typed array
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 64 );
* var arr = complexarray( buf, 16, 2 );
* // returns <Complex128Array>
*
* @example
* var ArrayBuffer = require( `@stdlib/array/buffer` );
*
* var buf = new ArrayBuffer( 64 );
* var arr = complexarray( buf, 16, 2, 'complex64' );
* // returns <Complex64Array>
*/
declare function complexarray( buffer: ArrayBuffer, byteOffset?: number, length?: number, dtype?: DataType ): ComplexTypedArray; // tslint:disable-line:max-line-length
// EXPORTS //
export = complexarray;