Skip to content

Commit f482c99

Browse files
authored
docs: update examples for complex/float64/base/mul-add
PR-URL: #7267 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 6aeced9 commit f482c99

File tree

5 files changed

+6
-77
lines changed

5 files changed

+6
-77
lines changed

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,7 @@ var z3 = new Complex128( 7.0, -8.0 );
5151

5252
// Compute `alpha*x + y`:
5353
var v = muladd( z1, z2, z3 );
54-
// returns <Complex128>
55-
56-
var re = real( v );
57-
// returns -6.0
58-
59-
var im = imag( v );
60-
// returns -9.0
54+
// returns <Complex128>[ -6.0, -9.0 ]
6155
```
6256

6357
The function supports the following parameters:

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

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -47,26 +47,13 @@ interface MulAdd {
4747
*
4848
* @example
4949
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
50-
* var real = require( '@stdlib/complex/float64/real' );
51-
* var imag = require( '@stdlib/complex/float64/imag' );
5250
*
5351
* var z1 = new Complex128( 5.0, 3.0 );
54-
* // returns <Complex128>
55-
*
5652
* var z2 = new Complex128( -2.0, 1.0 );
57-
* // returns <Complex128>
58-
*
5953
* var z3 = new Complex128( 7.0, -8.0 );
60-
* // returns <Complex128>
6154
*
6255
* var out = muladd( z1, z2, z3 );
63-
* // returns <Complex128>
64-
*
65-
* var re = real( out );
66-
* // returns -6.0
67-
*
68-
* var im = imag( out );
69-
* // returns -9.0
56+
* // returns <Complex128>[ -6.0, -9.0 ]
7057
*/
7158
( alpha: Complex128, x: Complex128, y: Complex128 ): Complex128;
7259

@@ -132,26 +119,13 @@ interface MulAdd {
132119
*
133120
* @example
134121
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
135-
* var real = require( '@stdlib/complex/float64/real' );
136-
* var imag = require( '@stdlib/complex/float64/imag' );
137122
*
138123
* var z1 = new Complex128( 5.0, 3.0 );
139-
* // returns <Complex128>
140-
*
141124
* var z2 = new Complex128( -2.0, 1.0 );
142-
* // returns <Complex128>
143-
*
144125
* var z3 = new Complex128( 7.0, -8.0 );
145-
* // returns <Complex128>
146126
*
147127
* var out = muladd( z1, z2, z3 );
148-
* // returns <Complex128>
149-
*
150-
* var re = real( out );
151-
* // returns -6.0
152-
*
153-
* var im = imag( out );
154-
* // returns -9.0
128+
* // returns <Complex128>[ -6.0, -9.0 ]
155129
*
156130
* @example
157131
* var Float64Array = require( '@stdlib/array/float64' );

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,14 @@
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 muladd = require( '@stdlib/complex/float64/base/mul-add' );
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>
37-
*
3832
* var z3 = new Complex128( 7.0, -8.0 );
39-
* // returns <Complex128>
4033
*
4134
* var out = muladd( z1, z2, z3 );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( out );
45-
* // returns -6.0
46-
*
47-
* var im = imag( out );
48-
* // returns -9.0
35+
* // returns <Complex128>[ -6.0, -9.0 ]
4936
*/
5037

5138
// MODULES //

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,13 @@ var imag = require( '@stdlib/complex/float64/imag' );
3737
*
3838
* @example
3939
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
40-
* var real = require( '@stdlib/complex/float64/real' );
41-
* var imag = require( '@stdlib/complex/float64/imag' );
4240
*
4341
* var z1 = new Complex128( 5.0, 3.0 );
44-
* // returns <Complex128>
45-
*
4642
* var z2 = new Complex128( -2.0, 1.0 );
47-
* // returns <Complex128>
48-
*
4943
* var z3 = new Complex128( 7.0, -8.0 );
50-
* // returns <Complex128>
5144
*
5245
* var out = muladd( z1, z2, z3 );
53-
* // returns <Complex128>
54-
*
55-
* var re = real( out );
56-
* // returns -6.0
57-
*
58-
* var im = imag( out );
59-
* // returns -9.0
46+
* // returns <Complex128>[ -6.0, -9.0 ]
6047
*/
6148
function muladd( alpha, x, y ) {
6249
var re0 = real( alpha );

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,13 @@ var addon = require( './../src/addon.node' );
3737
*
3838
* @example
3939
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
40-
* var real = require( '@stdlib/complex/float64/real' );
41-
* var imag = require( '@stdlib/complex/float64/imag' );
4240
*
4341
* var z1 = new Complex128( 5.0, 3.0 );
44-
* // returns <Complex128>
45-
*
4642
* var z2 = new Complex128( -2.0, 1.0 );
47-
* // returns <Complex128>
48-
*
4943
* var z3 = new Complex128( 7.0, -8.0 );
50-
* // returns <Complex128>
5144
*
5245
* var out = muladd( z1, z2, z3 );
53-
* // returns <Complex128>
54-
*
55-
* var re = real( out );
56-
* // returns -6.0
57-
*
58-
* var im = imag( out );
59-
* // returns -9.0
46+
* // returns <Complex128>[ -6.0, -9.0 ]
6047
*/
6148
function muladd( alpha, x, y ) {
6249
var v = addon( alpha, x, y );

0 commit comments

Comments
 (0)