Skip to content

Commit b9dd967

Browse files
authored
docs: update examples for complex/float64/base/mul
PR-URL: #7265 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 91765b1 commit b9dd967

File tree

5 files changed

+6
-69
lines changed

5 files changed

+6
-69
lines changed

lib/node_modules/@stdlib/complex/float64/base/mul/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,12 @@ Multiplies two double-precision complex floating-point numbers.
4242

4343
```javascript
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

4846
var z1 = new Complex128( 5.0, 3.0 );
4947
var z2 = new Complex128( -2.0, 1.0 );
5048

5149
var v = mul( z1, z2 );
52-
// returns <Complex128>
53-
54-
var re = real( v );
55-
// returns -13.0
56-
57-
var im = imag( v );
58-
// returns -1.0
50+
// returns <Complex128>[ -13.0, -1.0 ]
5951
```
6052

6153
The function supports the following parameters:

lib/node_modules/@stdlib/complex/float64/base/mul/docs/types/index.d.ts

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,12 @@ interface Mul {
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 z1 = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
44-
*
4541
* var z2 = new Complex128( -2.0, 1.0 );
46-
* // returns <Complex128>
4742
*
4843
* var out = mul( z1, z2 );
49-
* // returns <Complex128>
50-
*
51-
* var re = real( out );
52-
* // returns -13.0
53-
*
54-
* var im = imag( out );
55-
* // returns -1.0
44+
* // returns <Complex128>[ -13.0, -1.0 ]
5645
*/
5746
( z1: Complex128, z2: Complex128 ): Complex128;
5847

@@ -115,23 +104,12 @@ interface Mul {
115104
*
116105
* @example
117106
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
118-
* var real = require( '@stdlib/complex/float64/real' );
119-
* var imag = require( '@stdlib/complex/float64/imag' );
120107
*
121108
* var z1 = new Complex128( 5.0, 3.0 );
122-
* // returns <Complex128>
123-
*
124109
* var z2 = new Complex128( -2.0, 1.0 );
125-
* // returns <Complex128>
126110
*
127111
* var out = mul( z1, z2 );
128-
* // returns <Complex128>
129-
*
130-
* var re = real( out );
131-
* // returns -13.0
132-
*
133-
* var im = imag( out );
134-
* // returns -1.0
112+
* // returns <Complex128>[ -13.0, -1.0 ]
135113
*
136114
* @example
137115
* var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/complex/float64/base/mul/lib/index.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,13 @@
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 mul = require( '@stdlib/complex/float64/base/mul' );
3129
*
3230
* var z1 = new Complex128( 5.0, 3.0 );
33-
* // returns <Complex128>
34-
*
3531
* var z2 = new Complex128( -2.0, 1.0 );
36-
* // returns <Complex128>
3732
*
3833
* var out = mul( z1, z2 );
39-
* // returns <Complex128>
40-
*
41-
* var re = real( out );
42-
* // returns -13.0
43-
*
44-
* var im = imag( out );
45-
* // returns -1.0
34+
* // returns <Complex128>[ -13.0, -1.0 ]
4635
*/
4736

4837
// MODULES //

lib/node_modules/@stdlib/complex/float64/base/mul/lib/main.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,12 @@ var imag = require( '@stdlib/complex/float64/imag' );
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 z1 = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
44-
*
4541
* var z2 = new Complex128( -2.0, 1.0 );
46-
* // returns <Complex128>
4742
*
4843
* var out = mul( z1, z2 );
49-
* // returns <Complex128>
50-
*
51-
* var re = real( out );
52-
* // returns -13.0
53-
*
54-
* var im = imag( out );
55-
* // returns -1.0
44+
* // returns <Complex128>[ -13.0, -1.0 ]
5645
*/
5746
function mul( z1, z2 ) {
5847
var re1 = real( z1 );

lib/node_modules/@stdlib/complex/float64/base/mul/lib/native.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,12 @@ var addon = require( './../src/addon.node' );
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 z1 = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
44-
*
4541
* var z2 = new Complex128( -2.0, 1.0 );
46-
* // returns <Complex128>
4742
*
4843
* var out = mul( z1, z2 );
49-
* // returns <Complex128>
50-
*
51-
* var re = real( out );
52-
* // returns -13.0
53-
*
54-
* var im = imag( out );
55-
* // returns -1.0
44+
* // returns <Complex128>[ -13.0, -1.0 ]
5645
*/
5746
function mul( z1, z2 ) {
5847
var v = addon( z1, z2 );

0 commit comments

Comments
 (0)