Skip to content

Commit 8449e0b

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/zswap
PR-URL: #5218 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent 8d34c0c commit 8449e0b

File tree

8 files changed

+60
-358
lines changed

8 files changed

+60
-358
lines changed

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

Lines changed: 10 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,13 @@ Interchanges two complex double-precision floating-point vectors.
4444

4545
```javascript
4646
var Complex128Array = require( '@stdlib/array/complex128' );
47-
var real = require( '@stdlib/complex/float64/real' );
48-
var imag = require( '@stdlib/complex/float64/imag' );
4947

5048
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5149
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
5250

5351
zswap( x.length, x, 1, y, 1 );
54-
55-
var z = y.get( 0 );
56-
// returns <Complex128>
57-
58-
var re = real( z );
59-
// returns 1.0
60-
61-
var im = imag( z );
62-
// returns 2.0
63-
64-
z = x.get( 0 );
65-
// returns <Complex128>
66-
67-
re = real( z );
68-
// returns 0.0
69-
70-
im = imag( z );
71-
// returns 0.0
52+
// x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
53+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
7254
```
7355

7456
The function has the following parameters:
@@ -83,31 +65,13 @@ The `N` and stride parameters determine how values from `x` are interchanged wit
8365

8466
```javascript
8567
var Complex128Array = require( '@stdlib/array/complex128' );
86-
var real = require( '@stdlib/complex/float64/real' );
87-
var imag = require( '@stdlib/complex/float64/imag' );
8868

8969
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
9070
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
9171

9272
zswap( 2, x, -2, y, 1 );
93-
94-
var z = y.get( 0 );
95-
// returns <Complex128>
96-
97-
var re = real( z );
98-
// returns 5.0
99-
100-
var im = imag( z );
101-
// returns 6.0
102-
103-
z = x.get( 0 );
104-
// returns <Complex128>
105-
106-
re = real( z );
107-
// returns 0.0
108-
109-
im = imag( z );
110-
// returns 0.0
73+
// x => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0 ]
74+
// y => <Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
11175
```
11276

11377
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -116,8 +80,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
11680

11781
```javascript
11882
var Complex128Array = require( '@stdlib/array/complex128' );
119-
var real = require( '@stdlib/complex/float64/real' );
120-
var imag = require( '@stdlib/complex/float64/imag' );
12183

12284
// Initial arrays...
12385
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -129,24 +91,8 @@ var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3
12991

13092
// Interchange in reverse order every other value from `x1` into `y1`...
13193
zswap( 2, x1, -2, y1, 1 );
132-
133-
var z = y0.get( 2 );
134-
// returns <Complex128>
135-
136-
var re = real( z );
137-
// returns 7.0
138-
139-
var im = imag( z );
140-
// returns 8.0
141-
142-
z = x0.get( 1 );
143-
// returns <Complex128>
144-
145-
re = real( z );
146-
// returns 0.0
147-
148-
im = imag( z );
149-
// returns 0.0
94+
// x0 => <Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ]
95+
// y0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
15096
```
15197

15298
#### zswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -155,31 +101,13 @@ Interchanges two complex double-precision floating-point vectors using alternati
155101

156102
```javascript
157103
var Complex128Array = require( '@stdlib/array/complex128' );
158-
var real = require( '@stdlib/complex/float64/real' );
159-
var imag = require( '@stdlib/complex/float64/imag' );
160104

161105
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
162106
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
163107

164108
zswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
165-
166-
var z = y.get( 0 );
167-
// returns <Complex128>
168-
169-
var re = real( z );
170-
// returns 1.0
171-
172-
var im = imag( z );
173-
// returns 2.0
174-
175-
z = x.get( 0 );
176-
// returns <Complex128>
177-
178-
re = real( z );
179-
// returns 0.0
180-
181-
im = imag( z );
182-
// returns 0.0
109+
// x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
110+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
183111
```
184112

185113
The function has the following additional parameters:
@@ -191,31 +119,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
191119

192120
```javascript
193121
var Complex128Array = require( '@stdlib/array/complex128' );
194-
var real = require( '@stdlib/complex/float64/real' );
195-
var imag = require( '@stdlib/complex/float64/imag' );
196122

197123
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
198124
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
199125

200126
zswap.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
201-
202-
var z = y.get( y.length-1 );
203-
// returns <Complex128>
204-
205-
var re = real( z );
206-
// returns 3.0
207-
208-
var im = imag( z );
209-
// returns 4.0
210-
211-
z = x.get( x.length-1 );
212-
// returns <Complex128>
213-
214-
re = real( z );
215-
// returns 0.0
216-
217-
im = imag( z );
218-
// returns 0.0
127+
// x => <Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ]
128+
// y => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
219129
```
220130

221131
</section>

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

Lines changed: 20 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -38,48 +38,30 @@
3838
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
3939
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
4040
> {{alias}}( x.length, x, 1, y, 1 );
41-
> var z = y.get( 0 );
42-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
43-
1.0
44-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
45-
2.0
46-
> z = x.get( 0 );
47-
> re = {{alias:@stdlib/complex/float64/real}}( z )
48-
6.0
49-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
50-
7.0
41+
> x
42+
<Complex128Array>[ 6.0, 7.0, 8.0, 9.0 ]
43+
> y
44+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
5145

5246
// Advanced indexing:
5347
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5448
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
5549
> {{alias}}( 2, x, -2, y, 1 );
56-
> z = y.get( 0 );
57-
> re = {{alias:@stdlib/complex/float64/real}}( z )
58-
5.0
59-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
60-
6.0
61-
> z = x.get( 0 );
62-
> re = {{alias:@stdlib/complex/float64/real}}( z )
63-
0.0
64-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
65-
0.0
50+
> x
51+
<Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ]
52+
> y
53+
<Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0 ]
6654

6755
// Using typed array views:
6856
> var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
6957
> var y0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] );
7058
> var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
7159
> var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 );
7260
> {{alias}}( 1, x1, -1, y1, 1 );
73-
> z = y0.get( 1 );
74-
> re = {{alias:@stdlib/complex/float64/real}}( z )
75-
3.0
76-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
77-
4.0
78-
> z = x0.get( 1 );
79-
> re = {{alias:@stdlib/complex/float64/real}}( z )
80-
0.0
81-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
82-
0.0
61+
> x0
62+
<Complex128Array>[ 1.0, 2.0, 0.0, 0.0 ]
63+
> y0
64+
<Complex128Array>[ 0.0, 0.0, 3.0, 4.0 ]
8365

8466

8567
{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -124,31 +106,19 @@
124106
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
125107
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
126108
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 );
127-
> var z = y.get( 0 );
128-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
129-
1.0
130-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
131-
2.0
132-
> z = x.get( 0 );
133-
> re = {{alias:@stdlib/complex/float64/real}}( z )
134-
6.0
135-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
136-
7.0
109+
> x
110+
<Complex128Array>[ 6.0, 7.0, 8.0, 9.0 ]
111+
> y
112+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
137113

138114
// Advanced indexing:
139115
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
140116
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
141117
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
142-
> z = y.get( y.length-1 );
143-
> re = {{alias:@stdlib/complex/float64/real}}( z )
144-
3.0
145-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
146-
4.0
147-
> z = x.get( 1 );
148-
> re = {{alias:@stdlib/complex/float64/real}}( z )
149-
0.0
150-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
151-
0.0
118+
> x
119+
<Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ]
120+
> y
121+
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
152122

153123
See Also
154124
--------

0 commit comments

Comments
 (0)