Skip to content

Commit 58485b9

Browse files
gururaj1512Vinit-Pandit
gururaj1512
authored and
Vinit-Pandit
committed
docs: update examples for blas/base/csrot
PR-URL: stdlib-js#4963 Ref: stdlib-js#4833 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 43205c2 commit 58485b9

File tree

8 files changed

+50
-350
lines changed

8 files changed

+50
-350
lines changed

‎lib/node_modules/@stdlib/blas/base/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( 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:
@@ -75,31 +57,13 @@ The `N` and stride parameters determine how values from `cx` and `cy` are access
7557

7658
```javascript
7759
var Complex64Array = require( '@stdlib/array/complex64' );
78-
var realf = require( '@stdlib/complex/float32/real' );
79-
var imagf = require( '@stdlib/complex/float32/imag' );
8060

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

8464
csrot( 2, cx, 2, cy, 2, 0.8, 0.6 );
85-
86-
var z = cy.get( 0 );
87-
// returns <Complex64>
88-
89-
var re = realf( z );
90-
// returns ~-0.6
91-
92-
var im = imagf( z );
93-
// returns ~-1.2
94-
95-
z = cx.get( 0 );
96-
// returns <Complex64>
97-
98-
re = realf( z );
99-
// returns ~0.8
100-
101-
im = imagf( z );
102-
// returns ~1.6
65+
// cx => <Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
66+
// cy => <Complex64Array>[ ~-0.6, ~-1.2, 0.0, 0.0, -3.0, ~-3.6, 0.0, 0.0 ]
10367
```
10468

10569
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -108,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
10872

10973
```javascript
11074
var Complex64Array = require( '@stdlib/array/complex64' );
111-
var realf = require( '@stdlib/complex/float32/real' );
112-
var imagf = require( '@stdlib/complex/float32/imag' );
11375

11476
// Initial arrays...
11577
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -120,24 +82,8 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
12082
var cy1 = new Complex64Array( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); // start at 3rd element
12183

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

14389
#### csrot.ndarray( N, cx, strideX, offsetX, cy, strideY, offsetY, c, s )
@@ -146,31 +92,13 @@ Applies a plane rotation using alternative indexing semantics.
14692

14793
```javascript
14894
var Complex64Array = require( '@stdlib/array/complex64' );
149-
var realf = require( '@stdlib/complex/float32/real' );
150-
var imagf = require( '@stdlib/complex/float32/imag' );
15195

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

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

176104
The function has the following additional parameters:
@@ -182,31 +110,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
182110

183111
```javascript
184112
var Complex64Array = require( '@stdlib/array/complex64' );
185-
var realf = require( '@stdlib/complex/float32/real' );
186-
var imagf = require( '@stdlib/complex/float32/imag' );
187113

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

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

212122
</section>

‎lib/node_modules/@stdlib/blas/base/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}}( 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}}( 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}}( 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
See Also
165135
--------

0 commit comments

Comments
 (0)