Skip to content

Commit 0b2faa8

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/csignum
PR-URL: #9012 Ref: #8641 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 01ab290 commit 0b2faa8

File tree

6 files changed

+14
-106
lines changed

6 files changed

+14
-106
lines changed

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

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,15 @@ Evaluates the [signum][signum] function of a double-precision complex floating-p
4646

4747
```javascript
4848
var Complex128 = require( '@stdlib/complex/float64/ctor' );
49-
var real = require( '@stdlib/complex/float64/real' );
50-
var imag = require( '@stdlib/complex/float64/imag' );
5149

5250
var v = csignum( new Complex128( -4.2, 5.5 ) );
53-
// returns <Complex128>
54-
55-
var re = real( v );
56-
// returns -0.6069136033622302
57-
58-
var im = imag( v );
59-
// returns 0.79476781392673
51+
// returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
6052

6153
v = csignum( new Complex128( 0.0, 0.0 ) );
62-
// returns <Complex128>
63-
64-
re = real( v );
65-
// returns 0.0
66-
67-
im = imag( v );
68-
// returns 0.0
54+
// returns <Complex128>[ 0.0, 0.0 ]
6955

7056
v = csignum( new Complex128( NaN, NaN ) );
71-
// returns <Complex128>
72-
73-
re = real( v );
74-
// returns NaN
75-
76-
im = imag( v );
77-
// returns NaN
57+
// returns <Complex128>[ NaN, NaN ]
7858
```
7959

8060
</section>

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,7 @@
1616
Examples
1717
--------
1818
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ) )
19-
<Complex128>
20-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
21-
-0.6069136033622302
22-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
23-
0.79476781392673
19+
<Complex128>[ -0.6069136033622302, 0.79476781392673 ]
2420

2521
See Also
2622
--------

lib/node_modules/@stdlib/math/base/special/csignum/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 = csignum( new Complex128( -4.2, 5.5 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns -0.6069136033622302
41-
*
42-
* var im = imag( v );
43-
* // returns 0.79476781392673
35+
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
4436
*/
4537
declare function csignum( z: Complex128 ): Complex128;
4638

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

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,16 @@
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 csignum = require( '@stdlib/math/base/special/csignum' );
3129
*
3230
* var v = csignum( new Complex128( -4.2, 5.5 ) );
33-
* // returns <Complex128>
34-
*
35-
* var re = real( v );
36-
* // returns -0.6069136033622302
37-
*
38-
* var im = imag( v );
39-
* // returns 0.79476781392673
31+
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
4032
*
4133
* v = csignum( new Complex128( 0.0, 0.0 ) );
42-
* // returns <Complex128>
43-
*
44-
* re = real( v );
45-
* // returns 0.0
46-
*
47-
* im = imag( v );
48-
* // returns 0.0
34+
* // returns <Complex128>[ 0.0, 0.0 ]
4935
*
5036
* v = csignum( new Complex128( NaN, NaN ) );
51-
* // returns <Complex128>
52-
*
53-
* re = real( v );
54-
* // returns NaN
55-
*
56-
* im = imag( v );
57-
* // returns NaN
37+
* // returns <Complex128>[ NaN, NaN ]
5838
*/
5939

6040
// MODULES //

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

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,35 +36,15 @@ var cabs = require( '@stdlib/math/base/special/cabs' );
3636
*
3737
* @example
3838
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
* var real = require( '@stdlib/complex/float64/real' );
40-
* var imag = require( '@stdlib/complex/float64/imag' );
4139
*
4240
* var v = csignum( new Complex128( -4.2, 5.5 ) );
43-
* // returns <Complex128>
44-
*
45-
* var re = real( v );
46-
* // returns -0.6069136033622302
47-
*
48-
* var im = imag( v );
49-
* // returns 0.79476781392673
41+
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
5042
*
5143
* v = csignum( new Complex128( 0.0, 0.0 ) );
52-
* // returns <Complex128>
53-
*
54-
* re = real( v );
55-
* // returns 0.0
56-
*
57-
* im = imag( v );
58-
* // returns 0.0
44+
* // returns <Complex128>[ 0.0, 0.0 ]
5945
*
6046
* v = csignum( new Complex128( NaN, NaN ) );
61-
* // returns <Complex128>
62-
*
63-
* re = real( v );
64-
* // returns NaN
65-
*
66-
* im = imag( v );
67-
* // returns NaN
47+
* // returns <Complex128>[ NaN, NaN ]
6848
*/
6949
function csignum( z ) {
7050
var re;

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

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,35 +35,15 @@ 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 = csignum( new Complex128( -4.2, 5.5 ) );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( v );
45-
* // returns -0.6069136033622302
46-
*
47-
* var im = imag( v );
48-
* // returns 0.79476781392673
40+
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
4941
*
5042
* v = csignum( new Complex128( 0.0, 0.0 ) );
51-
* // returns <Complex128>
52-
*
53-
* re = real( v );
54-
* // returns 0.0
55-
*
56-
* im = imag( v );
57-
* // returns 0.0
43+
* // returns <Complex128>[ 0.0, 0.0 ]
5844
*
5945
* v = csignum( new Complex128( NaN, NaN ) );
60-
* // returns <Complex128>
61-
*
62-
* re = real( v );
63-
* // returns NaN
64-
*
65-
* im = imag( v );
66-
* // returns NaN
46+
* // returns <Complex128>[ NaN, NaN ]
6747
*/
6848
function csignum( z ) {
6949
var v = addon( z );

0 commit comments

Comments
 (0)