Skip to content

Commit b15e507

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/cinv
PR-URL: #9024 Ref: #8641 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 2c59b22 commit b15e507

File tree

6 files changed

+6
-50
lines changed

6 files changed

+6
-50
lines changed

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,9 @@ Computes the inverse of a double-precision complex floating-point number.
5353

5454
```javascript
5555
var Complex128 = require( '@stdlib/complex/float64/ctor' );
56-
var real = require( '@stdlib/complex/float64/real' );
57-
var imag = require( '@stdlib/complex/float64/imag' );
5856

5957
var v = cinv( new Complex128( 2.0, 4.0 ) );
60-
// returns <Complex128>
61-
62-
var re = real( v );
63-
// returns 0.1
64-
65-
var im = imag( v );
66-
// returns -0.2
58+
// returns <Complex128>[ 0.1, -0.2 ]
6759
```
6860

6961
</section>

lib/node_modules/@stdlib/math/base/special/cinv/docs/repl.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,7 @@
1515
Examples
1616
--------
1717
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 4.0 ) )
18-
<Complex128>
19-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
20-
0.1
21-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
22-
-0.2
18+
<Complex128>[ 0.1, -0.2 ]
2319

2420
See Also
2521
--------

lib/node_modules/@stdlib/math/base/special/cinv/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,9 @@ 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 = cinv( new Complex128( 2.0, 4.0 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns 0.1
41-
*
42-
* var im = imag( v );
43-
* // returns -0.2
35+
* // returns <Complex128>[ ~0.1, ~-0.2 ]
4436
*/
4537
declare function cinv( z: Complex128 ): Complex128;
4638

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,10 @@
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 cinv = require( '@stdlib/math/base/special/cinv' );
3129
*
3230
* var v = cinv( new Complex128( 2.0, 4.0 ) );
33-
* // returns <Complex128>
34-
*
35-
* var re = real( v );
36-
* // returns 0.1
37-
*
38-
* var im = imag( v );
39-
* // returns -0.2
31+
* // returns <Complex128>[ 0.1, -0.2 ]
4032
*/
4133

4234
// MODULES //

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,9 @@ var RECIP_EPS_SQR = 2.0 / ( EPS * EPS );
5151
*
5252
* @example
5353
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
54-
* var real = require( '@stdlib/complex/float64/real' );
55-
* var imag = require( '@stdlib/complex/float64/imag' );
5654
*
5755
* var v = cinv( new Complex128( 2.0, 4.0 ) );
58-
* // returns <Complex128>
59-
*
60-
* var re = real( v );
61-
* // returns 0.1
62-
*
63-
* var im = imag( v );
64-
* // returns -0.2
56+
* // returns <Complex128>[ 0.1, -0.2 ]
6557
*/
6658
function cinv( z ) {
6759
var ab;

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,9 @@ 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 v = cinv( new Complex128( 2.0, 4.0 ) );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( v );
45-
* // returns 0.1
46-
*
47-
* var im = imag( v );
48-
* // returns -0.2
40+
* // returns <Complex128>[ 0.1, -0.2 ]
4941
*/
5042
function cinv( z ) {
5143
var v = addon( z );

0 commit comments

Comments
 (0)