@@ -36,31 +36,13 @@ Applies a plane rotation.
3636
3737``` javascript
3838var Complex64Array = require ( ' @stdlib/array/complex64' );
39- var realf = require ( ' @stdlib/complex/float32/real' );
40- var imagf = require ( ' @stdlib/complex/float32/imag' );
4139
4240var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 , 7.0 , 8.0 ] );
4341var cy = new Complex64Array ( [ 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 ] );
4442
4543csrot .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
6648The 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
7961var Complex64Array = require ( ' @stdlib/array/complex64' );
80- var realf = require ( ' @stdlib/complex/float32/real' );
81- var imagf = require ( ' @stdlib/complex/float32/imag' );
8262
8363var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 , 7.0 , 8.0 ] );
8464var cy = new Complex64Array ( [ 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 ] );
8565
8666csrot .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
10771Note 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
11276var 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...
11779var 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
12284var cy1 = new Complex64Array ( cy0 .buffer , cy0 .BYTES_PER_ELEMENT * 2 ); // start at 3rd element
12385
12486csrot .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
15096var Complex64Array = require ( ' @stdlib/array/complex64' );
151- var realf = require ( ' @stdlib/complex/float32/real' );
152- var imagf = require ( ' @stdlib/complex/float32/imag' );
15397
15498var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 ] );
15599var cy = new Complex64Array ( [ 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 ] );
156100
157101csrot .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
178106The 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
186114var Complex64Array = require ( ' @stdlib/array/complex64' );
187- var realf = require ( ' @stdlib/complex/float32/real' );
188- var imagf = require ( ' @stdlib/complex/float32/imag' );
189115
190116var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 , 7.0 , 8.0 ] );
191117var cy = new Complex64Array ( [ 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 , 0.0 ] );
192118
193119csrot .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* * *
0 commit comments