Skip to content

Commit afb2f08

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent b33ef93 commit afb2f08

2 files changed

Lines changed: 160 additions & 4 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-07-18)
7+
## Unreleased (2024-07-19)
88

99
<section class="packages">
1010

@@ -20,6 +20,7 @@
2020

2121
##### Features
2222

23+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628)
2324
- [`e797f05`](https://github.com/stdlib-js/stdlib/commit/e797f0544c2b5a8415c230350d8dfa4917691d33) - add `base` to namespace
2425
- [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4) - convert `complex/float64` to a namespace
2526

@@ -31,6 +32,11 @@
3132

3233
##### BREAKING CHANGES
3334

35+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
36+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations
37+
38+
- To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
39+
3440
- [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): convert `complex/float64` to a namespace
3541
- [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): `complex/float64` converted to a namespace
3642

@@ -65,13 +71,27 @@
6571

6672
##### Features
6773

74+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628)
6875
- [`c89d08c`](https://github.com/stdlib-js/stdlib/commit/c89d08c3733ca6b6f1fab8d8ebc95663b8190b5e) - add `assert` to namespace
6976
- [`12e3d27`](https://github.com/stdlib-js/stdlib/commit/12e3d27221fea685a32218d5bd7255bba1c3b4a3) - add `complex/float64/base` namespace
7077

7178
</section>
7279

7380
<!-- /.features -->
7481

82+
<section class="breaking-changes">
83+
84+
##### BREAKING CHANGES
85+
86+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
87+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations
88+
89+
- To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
90+
91+
</section>
92+
93+
<!-- /.breaking-changes -->
94+
7595
</details>
7696

7797
</section>
@@ -110,12 +130,26 @@
110130

111131
##### Features
112132

133+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628)
113134
- [`5bb602e`](https://github.com/stdlib-js/stdlib/commit/5bb602e63ab9d543d6f2702a556e7569d01277bb) - add `complex/float64/base/assert` namespace
114135

115136
</section>
116137

117138
<!-- /.features -->
118139

140+
<section class="breaking-changes">
141+
142+
##### BREAKING CHANGES
143+
144+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
145+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations
146+
147+
- To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
148+
149+
</section>
150+
151+
<!-- /.breaking-changes -->
152+
119153
</details>
120154

121155
</section>
@@ -430,6 +464,11 @@
430464

431465
### BREAKING CHANGES
432466

467+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
468+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations
469+
470+
- To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
471+
433472
- [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): convert `complex/float64` to a namespace
434473
- [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): `complex/float64` converted to a namespace
435474

@@ -479,6 +518,7 @@ A total of 2 people contributed to this release. Thank you to the following cont
479518

480519
<details>
481520

521+
- [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - **feat:** update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628) _(by stdlib-bot, Athan Reines)_
482522
- [`c89d08c`](https://github.com/stdlib-js/stdlib/commit/c89d08c3733ca6b6f1fab8d8ebc95663b8190b5e) - **feat:** add `assert` to namespace _(by Athan Reines)_
483523
- [`5bb602e`](https://github.com/stdlib-js/stdlib/commit/5bb602e63ab9d543d6f2702a556e7569d01277bb) - **feat:** add `complex/float64/base/assert` namespace _(by Athan Reines)_
484524
- [`e797f05`](https://github.com/stdlib-js/stdlib/commit/e797f0544c2b5a8415c230350d8dfa4917691d33) - **feat:** add `base` to namespace _(by Athan Reines)_

‎docs/types/index.d.ts‎

Lines changed: 119 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,136 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import base = require( '@stdlib/complex-float64-base' );
24+
import conj = require( '@stdlib/complex-float64-conj' );
25+
import Complex128 = require( '@stdlib/complex-float64-ctor' );
2326
import imag = require( '@stdlib/complex-float64-imag' );
27+
import parseComplex128 = require( '@stdlib/complex-float64-parse' );
28+
import real = require( '@stdlib/complex-float64-real' );
29+
import reim = require( '@stdlib/complex-float64-reim' );
30+
import reviveComplex128 = require( '@stdlib/complex-float64-reviver' );
2431

2532
/**
26-
* Interface describing the namespace.
33+
* Interface describing the `float64` namespace.
2734
*/
2835
interface Namespace {
2936
/**
30-
* TODO
37+
* Base (i.e., lower-level) double-precision complex number functions.
38+
*/
39+
base: typeof base;
40+
41+
/**
42+
* Returns the complex conjugate of a double-precision complex floating-point number.
43+
*
44+
* @param z - complex number
45+
* @returns complex conjugate
46+
*
47+
* @example
48+
* var Complex128 = require( '@stdlib/complex-float64-ctor' );
49+
* var real = require( '@stdlib/complex-float64-real' );
50+
* var imag = require( '@stdlib/complex-float64-imag' );
51+
*
52+
* var z = new Complex128( 5.0, 3.0 );
53+
*
54+
* var v = ns.conj( z );
55+
* // returns <Complex128>
56+
*
57+
* var re = real( v );
58+
* // returns 5.0
59+
*
60+
* var im = imag( v );
61+
* // returns -3.0
62+
*/
63+
conj: typeof conj;
64+
65+
/**
66+
* 128-bit complex number.
67+
*/
68+
Complex128: typeof Complex128;
69+
70+
/**
71+
* Returns the imaginary component of a double-precision complex floating-point number.
72+
*
73+
* @param z - complex number
74+
* @returns imaginary component
75+
*
76+
* @example
77+
* var Complex128 = require( '@stdlib/complex-float64-ctor' );
78+
*
79+
* var z = new Complex128( 5.0, 3.0 );
80+
*
81+
* var im = ns.imag( z );
82+
* // returns 3.0
3183
*/
3284
imag: typeof imag;
85+
86+
/**
87+
* Parse a string representation of a 128-bit complex number.
88+
*
89+
* @param str - string representation of a complex number
90+
* @returns Complex128 instance
91+
* @throws must provide a string recognized as a complex number
92+
*
93+
* @example
94+
* var str = '5 + 3i';
95+
*
96+
* var z = ns.parseComplex128( str );
97+
* // returns <Complex128>
98+
*/
99+
parseComplex128: typeof parseComplex128;
100+
101+
/**
102+
* Returns the real component of a double-precision complex floating-point number.
103+
*
104+
* @param z - complex number
105+
* @returns real component
106+
*
107+
* @example
108+
* var Complex128 = require( '@stdlib/complex-float64-ctor' );
109+
*
110+
* var z = new Complex128( 5.0, 3.0 );
111+
*
112+
* var re = ns.real( z );
113+
* // returns 5.0
114+
*/
115+
real: typeof real;
116+
117+
/**
118+
* Returns the real and imaginary components of a double-precision complex floating-point number.
119+
*
120+
* @param z - complex number
121+
* @returns real and imaginary components
122+
*
123+
* @example
124+
* var Complex128 = require( '@stdlib/complex-float64-ctor' );
125+
*
126+
* var z = new Complex128( 5.0, 3.0 );
127+
*
128+
* var out = ns.reim( z );
129+
* // returns <Float64Array>[ 5.0, 3.0 ]
130+
*/
131+
reim: typeof reim;
132+
133+
/**
134+
* Revives a JSON-serialized 128-bit complex number.
135+
*
136+
* @param key - key
137+
* @param value - value
138+
* @returns value or 128-bit complex number
139+
*
140+
* @example
141+
* var parseJSON = require( '@stdlib/utils-parse-json' );
142+
*
143+
* var str = '{"type":"Complex128","re":5,"im":3}';
144+
*
145+
* var z = parseJSON( str, ns.reviveComplex128 );
146+
* // returns <Complex128>
147+
*/
148+
reviveComplex128: typeof reviveComplex128;
33149
}
34150

35151
/**
36-
* Double-precision complex floating-point number functions.
152+
* Double-precision complex number functions.
37153
*/
38154
declare var ns: Namespace;
39155

0 commit comments

Comments
 (0)