Skip to content

Commit 0769122

Browse files
committed
Auto-generated commit
1 parent 4c417c9 commit 0769122

File tree

7 files changed

+12
-85
lines changed

7 files changed

+12
-85
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,7 @@ A total of 82 issues were closed in this release:
716716

717717
<details>
718718

719+
- [`b18cbc4`](https://github.com/stdlib-js/stdlib/commit/b18cbc48334f3a417ea68d706df69b683b7ad20c) - **docs:** improve doctests for complex number instances in `math/base/special/cexp` [(#9769)](https://github.com/stdlib-js/stdlib/pull/9769) _(by Vishal Gaikwad)_
719720
- [`8da46ee`](https://github.com/stdlib-js/stdlib/commit/8da46ee80a830f024f0b347b84e48e239b9eaee9) - **docs:** improve doctests for complex number instances in `math/base/special/cfloor` [(#9766)](https://github.com/stdlib-js/stdlib/pull/9766) _(by Vishal Gaikwad)_
720721
- [`a0f0513`](https://github.com/stdlib-js/stdlib/commit/a0f05135e37f5343ba7870b16e124ff2d642643d) - **chore:** fix EditorConfig lint errors [(#9755)](https://github.com/stdlib-js/stdlib/pull/9755) _(by Divyanshu)_
721722
- [`bfc8c3a`](https://github.com/stdlib-js/stdlib/commit/bfc8c3a7bcebf1a049c9e457ab440f540fd5c7a9) - **chore:** use one asterisk for license comment in TS files _(by Philipp Burckhardt)_

base/special/cexp/README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -57,26 +57,12 @@ Evaluates the [exponential][exponential-function] function for a double-precisio
5757

5858
```javascript
5959
var Complex128 = require( '@stdlib/complex/float64/ctor' );
60-
var real = require( '@stdlib/complex/float64/real' );
61-
var imag = require( '@stdlib/complex/float64/imag' );
6260

6361
var v = cexp( new Complex128( 0.0, 0.0 ) );
64-
// returns <Complex128>
65-
66-
var re = real( v );
67-
// returns 1.0
68-
69-
var im = imag( v );
70-
// returns 0.0
62+
// returns <Complex128>[ 1.0, 0.0 ]
7163

7264
v = cexp( new Complex128( 0.0, 1.0 ) );
73-
// returns <Complex128>
74-
75-
re = real( v );
76-
// returns ~0.540
77-
78-
im = imag( v );
79-
// returns ~0.841
65+
// returns <Complex128>[ ~0.540, ~0.841 ]
8066
```
8167

8268
</section>

base/special/cexp/docs/repl.txt

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,9 @@
1616
Examples
1717
--------
1818
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 0.0 ) )
19-
<Complex128>
20-
> var re = {{alias:@stdlib/complex/float64/real}}( y )
21-
1.0
22-
> var im = {{alias:@stdlib/complex/float64/imag}}( y )
23-
0.0
19+
<Complex128>[ 1.0, 0.0 ]
2420
> y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 1.0 ) )
25-
<Complex128>
26-
> re = {{alias:@stdlib/complex/float64/real}}( y )
27-
~0.540
28-
> im = {{alias:@stdlib/complex/float64/imag}}( y )
29-
~0.841
21+
<Complex128>[ ~0.540, ~0.841 ]
3022

3123
See Also
3224
--------

base/special/cexp/docs/types/index.d.ts

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,31 +30,16 @@ import { Complex128 } from '@stdlib/types/complex';
3030
*
3131
* @example
3232
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
33-
* var real = require( '@stdlib/complex/float64/real' );
34-
* var imag = require( '@stdlib/complex/float64/imag' );
3533
*
3634
* var v = cexp( new Complex128( 0.0, 0.0 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns 1.0
41-
*
42-
* var im = imag( v );
43-
* // returns 0.0
35+
* // returns <Complex128>[ 1.0, 0.0 ]
4436
*
4537
* @example
4638
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
47-
* var real = require( '@stdlib/complex/float64/real' );
48-
* var imag = require( '@stdlib/complex/float64/imag' );
4939
*
5040
* var v = cexp( new Complex128( 1.0, 0.0 ) );
51-
* // returns <Complex128>
52-
*
53-
* var re = real( v );
54-
* // returns ~2.718
41+
* // returns <Complex128>[ ~2.718, 0.0 ]
5542
*
56-
* var im = imag( v );
57-
* // returns 0.0
5843
*/
5944
declare function cexp( z: Complex128 ): Complex128;
6045

base/special/cexp/lib/index.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,11 @@
2525
*
2626
* @example
2727
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var cexp = require( '@stdlib/math/base/special/cexp' );
3129
*
3230
* var v = cexp( new Complex128( 0.0, 0.0 ) );
33-
* // returns <Complex128>
31+
* // returns <Complex128>[ 1.0, 0.0 ]
3432
*
35-
* var re = real( v );
36-
* // returns 1.0
37-
*
38-
* var im = imag( v );
39-
* // returns 0.0
4033
*/
4134

4235
// MODULES //

base/special/cexp/lib/main.js

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,33 +42,18 @@ var imag = require( '@stdlib/complex/float64/imag' );
4242
*
4343
* @example
4444
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
45-
* var real = require( '@stdlib/complex/float64/real' );
46-
* var imag = require( '@stdlib/complex/float64/imag' );
4745
* var cexp = require( '@stdlib/math/base/special/cexp' );
4846
*
4947
* var v = cexp( new Complex128( 0.0, 0.0 ) );
50-
* // returns <Complex128>
51-
*
52-
* var re = real( v );
53-
* // returns 1.0
54-
*
55-
* var im = imag( v );
56-
* // returns 0.0
48+
* // returns <Complex128>[ 1.0, 0.0 ]
5749
*
5850
* @example
5951
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
60-
* var real = require( '@stdlib/complex/float64/real' );
61-
* var imag = require( '@stdlib/complex/float64/imag' );
6252
* var cexp = require( '@stdlib/math/base/special/cexp' );
6353
*
6454
* var v = cexp( new Complex128( 1.0, 0.0 ) );
65-
* // returns <Complex128>
66-
*
67-
* var re = real( v );
68-
* // returns ~2.718
55+
* // returns <Complex128>[ ~2.718, 0.0 ]
6956
*
70-
* var im = imag( v );
71-
* // returns 0.0
7257
*/
7358
function cexp( z ) {
7459
var out;

base/special/cexp/lib/native.js

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,33 +35,18 @@ var addon = require( './../src/addon.node' );
3535
*
3636
* @example
3737
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
38-
* var real = require( '@stdlib/complex/float64/real' );
39-
* var imag = require( '@stdlib/complex/float64/imag' );
4038
* var cexp = require( '@stdlib/math/base/special/cexp' );
4139
*
4240
* var v = cexp( new Complex128( 0.0, 0.0 ) );
43-
* // returns <Complex128>
44-
*
45-
* var re = real( v );
46-
* // returns 1.0
47-
*
48-
* var im = imag( v );
49-
* // returns 0.0
41+
* // returns <Complex128>[ 1.0, 0.0 ]
5042
*
5143
* @example
5244
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
53-
* var real = require( '@stdlib/complex/float64/real' );
54-
* var imag = require( '@stdlib/complex/float64/imag' );
5545
* var cexp = require( '@stdlib/math/base/special/cexp' );
5646
*
5747
* var v = cexp( new Complex128( 1.0, 0.0 ) );
58-
* // returns <Complex128>
59-
*
60-
* var re = real( v );
61-
* // returns ~2.718
48+
* // returns <Complex128>[ ~2.718, 0.0 ]
6249
*
63-
* var im = imag( v );
64-
* // returns 0.0
6550
*/
6651
function cexp( z ) {
6752
var v = addon( z );

0 commit comments

Comments
 (0)