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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*
* @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 complex = require( './../../cmplx' );
import conj = require( './../../conj' );
import Complex64 = require( './../../float32' );
import Complex128 = require( './../../float64' );
import imag = require( './../../imag' );
import real = require( './../../real' );
import reim = require( './../../reim' );
import reviveComplex = require( './../../reviver' );
import reviveComplex64 = require( './../../reviver-float32' );
import reviveComplex128 = require( './../../reviver-float64' );
/**
* Interface describing the `complex` namespace.
*/
interface Namespace {
/**
* Creates a complex number.
*
* @param real - real component
* @param imag - imaginary component
* @param dtype - data type (default: 'float64')
* @returns complex number
*
* @example
* var z = ns.complex( 5.0, 3.0, 'float64' );
* // returns <Complex128>
*/
complex: typeof complex;
/**
* Returns the complex conjugate of a complex number.
*
* @param z - complex number
* @returns complex conjugate
*
* @example
* var Complex128 = require( `@stdlib/complex/float64` );
*
* var z = new Complex128( 5.0, 3.0 );
*
* var v = ns.conj( z );
* // returns <Complex128>
*/
conj: typeof conj;
/**
* 64-bit complex number.
*/
Complex64: typeof Complex64;
/**
* 128-bit complex number.
*/
Complex128: typeof Complex128;
/**
* Returns the imaginary component of a complex number.
*
* @param z - complex number
* @returns imaginary component
*
* @example
* var Complex128 = require( `@stdlib/complex/float64` );
*
* var z = new Complex128( 5.0, 3.0 );
*
* var im = ns.imag( z );
* // returns 3.0
*/
imag: typeof imag;
/**
* Returns the real component of a complex number.
*
* @param z - complex number
* @returns real component
*
* @example
* var Complex128 = require( `@stdlib/complex/float64` );
*
* var z = new Complex128( 5.0, 3.0 );
*
* var re = ns.real( z );
* // returns 5.0
*/
real: typeof real;
/**
* Returns the real and imaginary components of a complex number.
*
* @param z - complex number
* @returns real and imaginary components
*
* @example
* var Complex128 = require( `@stdlib/complex/float64` );
*
* var z = new Complex128( 5.0, 3.0 );
*
* var out = ns.reim( z );
* // returns <Float64Array>[ 5.0, 3.0 ]
*
* @example
* var Complex64 = require( `@stdlib/complex/float32` );
*
* var z = new Complex64( 5.0, 3.0 );
*
* var out = ns.reim( z );
* // returns <Float32Array>[ 5.0, 3.0 ]
*/
reim: typeof reim;
/**
* Revives a JSON-serialized complex number.
*
* @param key - key
* @param value - value
* @returns value or complex number
*
* @example
* var parseJSON = require( `@stdlib/utils/parse-json` );
*
* var str = '{"type":"Complex128","re":5,"im":3}';
*
* var z = parseJSON( str, ns.reviveComplex );
* // returns <Complex128>
*/
reviveComplex: typeof reviveComplex;
/**
* Revives a JSON-serialized 64-bit complex number.
*
* @param key - key
* @param value - value
* @returns value or 64-bit complex number
*
* @example
* var parseJSON = require( `@stdlib/utils/parse-json` );
*
* var str = '{"type":"Complex64","re":5,"im":3}';
*
* var z = parseJSON( str, ns.reviveComplex64 );
* // returns <Complex64>
*/
reviveComplex64: typeof reviveComplex64;
/**
* Revives a JSON-serialized 128-bit complex number.
*
* @param key - key
* @param value - value
* @returns value or 128-bit complex number
*
* @example
* var parseJSON = require( `@stdlib/utils/parse-json` );
*
* var str = '{"type":"Complex128","re":5,"im":3}';
*
* var z = parseJSON( str, ns.reviveComplex128 );
* // returns <Complex128>
*/
reviveComplex128: typeof reviveComplex128;
}
/**
* Complex numbers.
*/
declare var ns: Namespace;
// EXPORTS //
export = ns;
|
