Skip to content

Commit 512334c

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/ccis
PR-URL: #9014 Ref: #8641 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 0909988 commit 512334c

File tree

5 files changed

+10
-80
lines changed

5 files changed

+10
-80
lines changed

lib/node_modules/@stdlib/math/base/special/ccis/README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -57,30 +57,16 @@ Evaluates the [cis][cis] function for a double-precision complex floating-point
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 z = new Complex128( 0.0, 0.0 );
6462

6563
var v = ccis( z );
66-
// returns <Complex128>
67-
68-
var re = real( v );
69-
// returns 1.0
70-
71-
var im = imag( v );
72-
// returns 0.0
64+
// returns <Complex128>[ 1.0, 0.0 ]
7365

7466
z = new Complex128( 1.0, 0.0 );
7567

7668
v = ccis( z );
77-
// returns <Complex128>
78-
79-
re = real( v );
80-
// returns ~0.540
81-
82-
im = imag( v );
83-
// returns ~0.841
69+
// returns <Complex128>[ ~0.540, ~0.841 ]
8470
```
8571

8672
</section>

lib/node_modules/@stdlib/math/base/special/ccis/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}}( 1.0, 0.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
--------

lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,39 +25,23 @@
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 ccis = require( '@stdlib/math/base/special/ccis' );
3129
*
3230
* var z = new Complex128( 0.0, 0.0 );
3331
* // returns <Complex128>
3432
*
3533
* var out = ccis( z );
36-
* // returns <Complex128>
37-
*
38-
* var re = real( out );
39-
* // returns 1.0
40-
*
41-
* var im = imag( out );
42-
* // returns 0.0
34+
* // returns <Complex128>[ 1.0, 0.0 ]
4335
*
4436
* @example
4537
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4838
* var ccis = require( '@stdlib/math/base/special/ccis' );
4939
*
5040
* var z = new Complex128( 1.0, 0.0 );
5141
* // returns <Complex128>
5242
*
5343
* var out = ccis( z );
54-
* // returns <Complex128>
55-
*
56-
* var re = real( out );
57-
* // returns ~0.540
58-
*
59-
* var im = imag( out );
60-
* // returns ~0.841
44+
* // returns <Complex128>[ ~0.540, ~0.841 ]
6145
*/
6246

6347
// MODULES //

lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,37 +43,21 @@ var WORKSPACE = [ 0.0, 0.0 ];
4343
*
4444
* @example
4545
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4846
*
4947
* var z = new Complex128( 0.0, 0.0 );
5048
* // returns <Complex128>
5149
*
5250
* var out = ccis( z );
53-
* // returns <Complex128>
54-
*
55-
* var re = real( out );
56-
* // returns 1.0
57-
*
58-
* var im = imag( out );
59-
* // returns 0.0
51+
* // returns <Complex128>[ 1.0, 0.0 ]
6052
*
6153
* @example
6254
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
63-
* var real = require( '@stdlib/complex/float64/real' );
64-
* var imag = require( '@stdlib/complex/float64/imag' );
6555
*
6656
* var z = new Complex128( 1.0, 0.0 );
6757
* // returns <Complex128>
6858
*
6959
* var out = ccis( z );
70-
* // returns <Complex128>
71-
*
72-
* var re = real( out );
73-
* // returns ~0.54
74-
*
75-
* var im = imag( out );
76-
* // returns ~0.841
60+
* // returns <Complex128>[ ~0.540, ~0.841 ]
7761
*/
7862
function ccis( z ) {
7963
var re;

lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,37 +35,21 @@ 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
*
4139
* var z = new Complex128( 0.0, 0.0 );
4240
* // returns <Complex128>
4341
*
4442
* var out = ccis( z );
45-
* // returns <Complex128>
46-
*
47-
* var re = real( out );
48-
* // returns 1.0
49-
*
50-
* var im = imag( out );
51-
* // returns 0.0
43+
* // returns <Complex128>[ 1.0, 0.0 ]
5244
*
5345
* @example
5446
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
55-
* var real = require( '@stdlib/complex/float64/real' );
56-
* var imag = require( '@stdlib/complex/float64/imag' );
5747
*
5848
* var z = new Complex128( 1.0, 0.0 );
5949
* // returns <Complex128>
6050
*
6151
* var out = ccis( z );
62-
* // returns <Complex128>
63-
*
64-
* var re = real( out );
65-
* // returns ~0.540
66-
*
67-
* var im = imag( out );
68-
* // returns ~0.841
52+
* // returns <Complex128>[ ~0.540, ~0.841 ]
6953
*/
7054
function ccis( z ) {
7155
var v = addon( z );

0 commit comments

Comments
 (0)