Skip to content

Commit c9c5acc

Browse files
ShabiShett07ShabiShett07
authored
docs: update examples for blas/base/wasm/csrot
PR-URL: #5760 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent cd6e347 commit c9c5acc

File tree

6 files changed

+78
-415
lines changed

6 files changed

+78
-415
lines changed

‎lib/node_modules/@stdlib/blas/base/wasm/csrot/README.md

+10-100
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,13 @@ Applies a plane rotation.
3636

3737
```javascript
3838
var Complex64Array = require( '@stdlib/array/complex64' );
39-
var realf = require( '@stdlib/complex/float32/real' );
40-
var imagf = require( '@stdlib/complex/float32/imag' );
4139

4240
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4341
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4442

4543
csrot.main( cx.length, cx, 1, cy, 1, 0.8, 0.6 );
46-
47-
var z = cy.get( 0 );
48-
// returns <Complex64>
49-
50-
var re = realf( z );
51-
// returns ~-0.6
52-
53-
var im = imagf( z );
54-
// returns ~-1.2
55-
56-
z = cx.get( 0 );
57-
// returns <Complex64>
58-
59-
re = realf( z );
60-
// returns ~0.8
61-
62-
im = imagf( z );
63-
// returns ~1.6
44+
// cx => <Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8, ~5.6, ~6.4 ]
45+
// cy => <Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6, ~-4.2, ~-4.8 ]
6446
```
6547

6648
The function has the following parameters:
@@ -77,31 +59,13 @@ The `N` and stride parameters determine how values in the strided arrays are acc
7759

7860
```javascript
7961
var Complex64Array = require( '@stdlib/array/complex64' );
80-
var realf = require( '@stdlib/complex/float32/real' );
81-
var imagf = require( '@stdlib/complex/float32/imag' );
8262

8363
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
8464
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
8565

8666
csrot.main( 2, cx, 2, cy, 2, 0.8, 0.6 );
87-
88-
var z = cy.get( 0 );
89-
// returns <Complex64>
90-
91-
var re = realf( z );
92-
// returns ~-0.6
93-
94-
var im = imagf( z );
95-
// returns ~-1.2
96-
97-
z = cx.get( 0 );
98-
// returns <Complex64>
99-
100-
re = realf( z );
101-
// returns ~0.8
102-
103-
im = imagf( z );
104-
// returns ~1.6
67+
// cx => <Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
68+
// cy => <Complex64Array>[ ~-0.6, ~-1.2, 0.0, 0.0, -3.0, ~-3.6, 0.0, 0.0 ]
10569
```
10670

10771
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -110,8 +74,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
11074

11175
```javascript
11276
var Complex64Array = require( '@stdlib/array/complex64' );
113-
var realf = require( '@stdlib/complex/float32/real' );
114-
var imagf = require( '@stdlib/complex/float32/imag' );
11577

11678
// Initial arrays...
11779
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -122,24 +84,8 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
12284
var cy1 = new Complex64Array( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); // start at 3rd element
12385

12486
csrot.main( 2, cx1, -2, cy1, 1, 0.8, 0.6 );
125-
126-
var z = cy0.get( 2 );
127-
// returns <Complex64>
128-
129-
var re = realf( z );
130-
// returns ~-4.2
131-
132-
var im = imagf( z );
133-
// returns ~-4.8
134-
135-
z = cx0.get( 3 );
136-
// returns <Complex64>
137-
138-
re = realf( z );
139-
// returns ~5.6
140-
141-
im = imagf( z );
142-
// returns ~6.4
87+
// cx0 => <Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
88+
// cy0 => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, ~-4.2, ~-4.8, ~-1.8, ~-2.4 ]
14389
```
14490

14591
#### csrot.ndarray( N, cx, strideX, offsetX, cy, strideY, offsetY, c, s )
@@ -148,31 +94,13 @@ Applies a plane rotation using alternative indexing semantics.
14894

14995
```javascript
15096
var Complex64Array = require( '@stdlib/array/complex64' );
151-
var realf = require( '@stdlib/complex/float32/real' );
152-
var imagf = require( '@stdlib/complex/float32/imag' );
15397

15498
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
15599
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
156100

157101
csrot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, 0.6 );
158-
159-
var z = cy.get( 0 );
160-
// returns <Complex64>
161-
162-
var re = realf( z );
163-
// returns ~-0.6
164-
165-
var im = imagf( z );
166-
// returns ~-1.2
167-
168-
z = cx.get( 0 );
169-
// returns <Complex64>
170-
171-
re = realf( z );
172-
// returns ~0.8
173-
174-
im = imagf( z );
175-
// returns ~1.6
102+
// cx => <Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8 ]
103+
// cy => <Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6 ]
176104
```
177105

178106
The function has the following additional parameters:
@@ -184,31 +112,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
184112

185113
```javascript
186114
var Complex64Array = require( '@stdlib/array/complex64' );
187-
var realf = require( '@stdlib/complex/float32/real' );
188-
var imagf = require( '@stdlib/complex/float32/imag' );
189115

190116
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
191117
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
192118

193119
csrot.ndarray( 2, cx, 2, 1, cy, 2, 1, 0.8, 0.6 );
194-
195-
var z = cy.get( 3 );
196-
// returns <Complex64>
197-
198-
var re = realf( z );
199-
// returns ~-4.2
200-
201-
var im = imagf( z );
202-
// returns ~-4.8
203-
204-
z = cx.get( 1 );
205-
// returns <Complex64>
206-
207-
re = realf( z );
208-
// returns ~2.4
209-
210-
im = imagf( z );
211-
// returns ~3.2
120+
// cx => <Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
121+
// cy => <Complex64Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0, ~-4.2, ~-4.8 ]
212122
```
213123

214124
* * *

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

+20-50
Original file line numberDiff line numberDiff line change
@@ -44,48 +44,30 @@
4444
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
4545
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
4646
> {{alias}}.main( cx.length, cx, 1, cy, 1, 0.8, 0.6 );
47-
> var z = cy.get( 0 );
48-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
49-
~-0.6
50-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
51-
~-1.2
52-
> z = cx.get( 0 );
53-
> re = {{alias:@stdlib/complex/float32/real}}( z )
54-
~0.8
55-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
56-
~1.6
47+
> cx
48+
<Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
49+
> cy
50+
<Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4 ]
5751

5852
// Advanced indexing:
5953
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
6054
> cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
6155
> {{alias}}.main( 2, cx, -2, cy, 1, 0.8, 0.6 );
62-
> z = cy.get( 0 );
63-
> re = {{alias:@stdlib/complex/float32/real}}( z )
64-
~-3.0
65-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
66-
~-3.6
67-
> z = cx.get( 2 );
68-
> re = {{alias:@stdlib/complex/float32/real}}( z )
69-
~4.0
70-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
71-
~4.8
56+
> cx
57+
<Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
58+
> cy
59+
<Complex64Array>[ -3.0, ~-3.6, ~-0.6, ~-1.2, 0.0, 0.0, 0.0, 0.0 ]
7260

7361
// Using typed array views:
7462
> var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7563
> var cy0 = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7664
> var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
7765
> var cy1 = new {{alias:@stdlib/array/complex64}}( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 );
7866
> {{alias}}.main( 1, cx1, 1, cy1, 1, 0.8, 0.6 );
79-
> z = cy0.get( 2 );
80-
> re = {{alias:@stdlib/complex/float32/real}}( z )
81-
~-1.8
82-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
83-
~-2.4
84-
> z = cx0.get( 1 );
85-
> re = {{alias:@stdlib/complex/float32/real}}( z )
86-
~2.4
87-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
88-
~3.2
67+
> cx0
68+
<Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
69+
> cy0
70+
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, ~-1.8, ~-2.4 ]
8971

9072

9173
{{alias}}.ndarray( N, cx, strideX, offsetX, cy, strideY, offsetY, c, s )
@@ -135,31 +117,19 @@
135117
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
136118
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
137119
> {{alias}}.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, 0.6 );
138-
> var z = cy.get( 0 );
139-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
140-
~-0.6
141-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
142-
~-1.2
143-
> z = cx.get( 0 );
144-
> re = {{alias:@stdlib/complex/float32/real}}( z )
145-
~0.8
146-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
147-
~1.6
120+
> cx
121+
<Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
122+
> cy
123+
<Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4 ]
148124

149125
// Advanced indexing:
150126
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
151127
> cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
152128
> {{alias}}.ndarray( 1, cx, 2, 1, cy, 2, 1, 0.8, 0.6 );
153-
> z = cy.get( 1 );
154-
> re = {{alias:@stdlib/complex/float32/real}}( z )
155-
~-1.8
156-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
157-
~-2.4
158-
> z = cx.get( 1 );
159-
> re = {{alias:@stdlib/complex/float32/real}}( z )
160-
~2.4
161-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
162-
~3.2
129+
> cx
130+
<Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
131+
> cy
132+
<Complex64Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0 ]
163133

164134

165135
{{alias}}.Module( memory )

0 commit comments

Comments
 (0)