Skip to content

Commit bda44d4

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/zdscal
PR-URL: stdlib-js#5392 Ref: stdlib-js#4833 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e1c0bd2 commit bda44d4

6 files changed

Lines changed: 25 additions & 182 deletions

File tree

‎lib/node_modules/@stdlib/blas/base/zdscal/README.md‎

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,11 @@ Scales a double-precision complex floating-point vector by a double-precision fl
3636

3737
```javascript
3838
var Complex128Array = require( '@stdlib/array/complex128' );
39-
var real = require( '@stdlib/complex/float64/real' );
40-
var imag = require( '@stdlib/complex/float64/imag' );
4139

4240
var zx = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4341

4442
zdscal( 3, 2.0, zx, 1 );
45-
46-
var z = zx.get( 0 );
47-
// returns <Complex128>
48-
49-
var re = real( z );
50-
// returns 2.0
51-
52-
var im = imag( z );
53-
// returns 2.0
43+
// zx => <Complex128Array>[ 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ]
5444
```
5545

5646
The function has the following parameters:
@@ -64,21 +54,11 @@ The `N` and stride parameters determine which elements in `zx` are scaled by `da
6454

6555
```javascript
6656
var Complex128Array = require( '@stdlib/array/complex128' );
67-
var real = require( '@stdlib/complex/float64/real' );
68-
var imag = require( '@stdlib/complex/float64/imag' );
6957

7058
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7159

7260
zdscal( 2, 2.0, zx, 2 );
73-
74-
var z = zx.get( 2 );
75-
// returns <Complex128>
76-
77-
var re = real( z );
78-
// returns 10.0
79-
80-
var im = imag( z );
81-
// returns 12.0
61+
// zx => <Complex128Array>[ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0, 7.0, 8.0 ]
8262
```
8363

8464
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -87,8 +67,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
8767

8868
```javascript
8969
var Complex128Array = require( '@stdlib/array/complex128' );
90-
var real = require( '@stdlib/complex/float64/real' );
91-
var imag = require( '@stdlib/complex/float64/imag' );
9270

9371
// Initial array:
9472
var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -98,24 +76,7 @@ var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start a
9876

9977
// Scale every element in `zx1`:
10078
zdscal( 3, 2.0, zx1, 1 );
101-
102-
var z = zx0.get( 0 );
103-
// returns <Complex128>
104-
105-
var re = real( z );
106-
// returns 1.0
107-
108-
var im = imag( z );
109-
// returns 2.0
110-
111-
z = zx0.get( 1 );
112-
// returns <Complex128>
113-
114-
re = real( z );
115-
// returns 6.0
116-
117-
im = imag( z );
118-
// returns 8.0
79+
// zx0 => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0 ]
11980
```
12081

12182
#### zdscal.ndarray( N, da, zx, strideZX, offsetZX )
@@ -124,21 +85,11 @@ Scales a double-precision complex floating-point vector by a double-precision fl
12485

12586
```javascript
12687
var Complex128Array = require( '@stdlib/array/complex128' );
127-
var real = require( '@stdlib/complex/float64/real' );
128-
var imag = require( '@stdlib/complex/float64/imag' );
12988

13089
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
13190

13291
zdscal.ndarray( 3, 2.0, zx, 1, 0 );
133-
134-
var z = zx.get( 0 );
135-
// returns <Complex128>
136-
137-
var re = real( z );
138-
// returns 2.0
139-
140-
var im = imag( z );
141-
// returns 4.0
92+
// zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
14293
```
14394

14495
The function has the following additional parameters:
@@ -149,21 +100,11 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
149100

150101
```javascript
151102
var Complex128Array = require( '@stdlib/array/complex128' );
152-
var real = require( '@stdlib/complex/float64/real' );
153-
var imag = require( '@stdlib/complex/float64/imag' );
154103

155104
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
156105

157106
zdscal.ndarray( 2, 2.0, zx, 2, 1 );
158-
159-
var z = zx.get( 3 );
160-
// returns <Complex128>
161-
162-
var re = real( z );
163-
// returns 14.0
164-
165-
var im = imag( z );
166-
// returns 16.0
107+
// zx => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 5.0, 6.0, 14.0, 16.0 ]
167108
```
168109

169110
</section>

‎lib/node_modules/@stdlib/blas/base/zdscal/docs/repl.txt‎

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,21 @@
3535
--------
3636
// Standard usage:
3737
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
38-
> {{alias}}( 2, 2.0, zx, 1 );
39-
> var z = zx.get( 0 );
40-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
41-
2.0
42-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
43-
4.0
38+
> {{alias}}( 2, 2.0, zx, 1 )
39+
<Complex128Array>[ 2.0, 4.0, 6.0, 8.0 ]
4440

4541
// N and stride parameters:
4642
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
47-
> {{alias}}( 2, 2.0, zx, 2 );
48-
> z = zx.get( 2 );
49-
> re = {{alias:@stdlib/complex/float64/real}}( z )
50-
10.0
51-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
52-
12.0
43+
> {{alias}}( 2, 2.0, zx, 2 )
44+
<Complex128Array>[ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0 ]
5345

5446
// Using typed array views:
5547
> var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5648
> var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 );
57-
> {{alias}}( 2, 2.0, zx1, 1 );
58-
> z = zx0.get( 1 );
59-
> re = {{alias:@stdlib/complex/float64/real}}( z )
60-
6.0
61-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
62-
8.0
49+
> {{alias}}( 2, 2.0, zx1, 1 )
50+
<Complex128Array>[ 6.0, 8.0, 10.0, 12.0 ]
51+
> zx0
52+
<Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0 ]
6353

6454

6555
{{alias}}.ndarray( N, da, zx, strideZX, offsetZX )
@@ -96,21 +86,13 @@
9686
--------
9787
// Standard usage:
9888
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
99-
> {{alias}}.ndarray( 2, 2.0, zx, 1, 0 );
100-
> var z = zx.get( 0 );
101-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
102-
2.0
103-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
104-
4.0
89+
> {{alias}}.ndarray( 2, 2.0, zx, 1, 0 )
90+
<Complex128Array>[ 2.0, 4.0, 6.0, 8.0 ]
10591

10692
// Advanced indexing:
10793
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
108-
> {{alias}}.ndarray( 2, 2.0, zx, 1, 2 );
109-
> z = zx.get( 2 );
110-
> re = {{alias:@stdlib/complex/float64/real}}( z )
111-
10.0
112-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
113-
12.0
94+
> {{alias}}.ndarray( 2, 2.0, zx, 1, 2 )
95+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 10.0, 12.0, 14.0, 16.0 ]
11496

11597
See Also
11698
--------

‎lib/node_modules/@stdlib/blas/base/zdscal/docs/types/index.d.ts‎

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,11 @@ interface Routine {
3737
*
3838
* @example
3939
* var Complex128Array = require( '@stdlib/array/complex128' );
40-
* var real = require( '@stdlib/complex/float64/real' );
41-
* var imag = require( '@stdlib/complex/float64/imag' );
4240
*
4341
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4442
*
4543
* zdscal( 3, 2.0, zx, 1 );
46-
*
47-
* var z = zx.get( 0 );
48-
* // returns <Complex128>
49-
*
50-
* var re = real( z );
51-
* // returns 2.0
52-
*
53-
* var im = imag( z );
54-
* // returns 4.0
44+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
5545
*/
5646
( N: number, da: number, zx: Complex128Array, strideZX: number ): Complex128Array;
5747

@@ -67,21 +57,11 @@ interface Routine {
6757
*
6858
* @example
6959
* var Complex128Array = require( '@stdlib/array/complex128' );
70-
* var real = require( '@stdlib/complex/float64/real' );
71-
* var imag = require( '@stdlib/complex/float64/imag' );
7260
*
7361
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7462
*
7563
* zdscal.ndarray( 3, 2.0, zx, 1, 0 );
76-
*
77-
* var z = zx.get( 0 );
78-
* // returns <Complex128>
79-
*
80-
* var re = real( z );
81-
* // returns 2.0
82-
*
83-
* var im = imag( z );
84-
* // returns 4.0
64+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
8565
*/
8666
ndarray( N: number, da: number, zx: Complex128Array, strideZX: number, offsetZX: number ): Complex128Array;
8767
}
@@ -97,39 +77,19 @@ interface Routine {
9777
*
9878
* @example
9979
* var Complex128Array = require( '@stdlib/array/complex128' );
100-
* var real = require( '@stdlib/complex/float64/real' );
101-
* var imag = require( '@stdlib/complex/float64/imag' );
10280
*
10381
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
10482
*
10583
* zdscal( 3, 2.0, zx, 1 );
106-
*
107-
* var z = zx.get( 1 );
108-
* // returns <Complex128>
109-
*
110-
* var re = real( z );
111-
* // returns 6.0
112-
*
113-
* var im = imag( z );
114-
* // returns 8.0
84+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
11585
*
11686
* @example
11787
* var Complex128Array = require( '@stdlib/array/complex128' );
118-
* var real = require( '@stdlib/complex/float64/real' );
119-
* var imag = require( '@stdlib/complex/float64/imag' );
12088
*
12189
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
12290
*
12391
* zdscal.ndarray( 2, 2.0, zx, 1, 1 );
124-
*
125-
* var z = zx.get( 1 );
126-
* // returns <Complex128>
127-
*
128-
* var re = real( z );
129-
* // returns 10.0
130-
*
131-
* var im = imag( z );
132-
* // returns 12.0
92+
* // zx => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0 ]
13393
*/
13494
declare var zdscal: Routine;
13595

‎lib/node_modules/@stdlib/blas/base/zdscal/lib/index.js‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,41 +25,21 @@
2525
*
2626
* @example
2727
* var Complex128Array = require( '@stdlib/array/complex128' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var zdscal = require( '@stdlib/blas/base/zdscal' );
3129
*
3230
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
3331
*
3432
* zdscal( 3, 2.0, zx, 1 );
35-
*
36-
* var z = zx.get( 0 );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( z );
40-
* // returns -2.0
41-
*
42-
* var im = imag( z );
43-
* // returns 6.0
33+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
4434
*
4535
* @example
4636
* var Complex128Array = require( '@stdlib/array/complex128' );
47-
* var real = require( '@stdlib/complex/float64/real' );
48-
* var imag = require( '@stdlib/complex/float64/imag' );
4937
* var zdscal = require( '@stdlib/blas/base/zdscal' );
5038
*
5139
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5240
*
5341
* zdscal.ndarray( 3, 2.0, zx, 1, 0 );
54-
*
55-
* var z = zx.get( 0 );
56-
* // returns <Complex128>
57-
*
58-
* var re = real( z );
59-
* // returns -2.0
60-
*
61-
* var im = imag( z );
62-
* // returns 6.0
42+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
6343
*/
6444

6545
// MODULES //

‎lib/node_modules/@stdlib/blas/base/zdscal/lib/ndarray.js‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,11 @@ var scale = require( '@stdlib/complex/float64/base/scale' ).strided;
3939
* @example
4040
* var Complex128Array = require( '@stdlib/array/complex128' );
4141
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
42-
* var real = require( '@stdlib/complex/float64/real' );
43-
* var imag = require( '@stdlib/complex/float64/imag' );
4442
*
4543
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4644
*
4745
* zdscal( 3, 2.0, zx, 1, 0 );
48-
*
49-
* var z = zx.get( 0 );
50-
* // returns <Complex128>
51-
*
52-
* var re = real( z );
53-
* // returns 2.0
54-
*
55-
* var im = imag( z );
56-
* // returns 4.0
46+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
5747
*/
5848
function zdscal( N, da, zx, strideZX, offsetZX ) {
5949
var zx64;

‎lib/node_modules/@stdlib/blas/base/zdscal/lib/zdscal.js‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,11 @@ var ndarray = require( './ndarray.js' );
3737
*
3838
* @example
3939
* var Complex128Array = require( '@stdlib/array/complex128' );
40-
* var real = require( '@stdlib/complex/float64/real' );
41-
* var imag = require( '@stdlib/complex/float64/imag' );
4240
*
4341
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4442
*
4543
* zdscal( 3, 2.0, zx, 1 );
46-
*
47-
* var z = zx.get( 0 );
48-
* // returns <Complex128>
49-
*
50-
* var re = real( z );
51-
* // returns 2.0
52-
*
53-
* var im = imag( z );
54-
* // returns 4.0
44+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
5545
*/
5646
function zdscal( N, da, zx, strideZX ) {
5747
return ndarray( N, da, zx, strideZX, stride2offset( N, strideZX ) );

0 commit comments

Comments
 (0)