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 (111 lines) | stat: -rw-r--r-- 2,277 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
/*
* @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

/**
* 128-bit complex number.
*/
declare class Complex128 {
	/**
	* 128-bit complex number constructor.
	*
	* @param real - real component
	* @param imag - imaginary component
	* @returns 128-bit complex number
	*
	* @example
	* var z = new Complex128( 5.0, 3.0 );
	* // returns <Complex128>
	*/
	constructor( real: number, imag: number );

	/**
	* Read-only property returning the real component.
	*
	* @returns real component
	*/
	readonly re: number;

	/**
	* Read-only property returning the imaginary component.
	*
	* @returns imaginary component
	*/
	readonly im: number;

	/**
	* Size (in bytes) of each component.
	*
	* @returns size of each component
	*
	* @example
	* var nbytes = Complex128.BYTES_PER_ELEMENT;
	* // returns 8
	*/
	readonly BYTES_PER_ELEMENT: number;

	/**
	* Length (in bytes) of a complex number.
	*
	* @returns byte length
	*
	* @example
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var nbytes = z.byteLength;
	* // returns 16
	*/
	readonly byteLength: number;

	/**
	* Serializes a complex number as a string.
	*
	* @returns serialized complex number
	*
	* @example
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var str = z.toString();
	* // returns '5 + 3i'
	*/
	toString(): string;

	/**
	* Serializes a complex number as a JSON object.
	*
	* ## Notes
	*
	* -   `JSON.stringify()` implicitly calls this method when stringifying a `Complex128` instance.
	*
	*
	* @returns serialized complex number
	*
	* @example
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var obj = z.toJSON();
	* // returns { 'type': 'Complex128', 're': 5.0, 'im': 3.0 }
	*/
	toJSON(): any;
}


// EXPORTS //

export = Complex128;