@@ -37,8 +37,6 @@ Scales values from `cx` by `ca`.
3737``` javascript
3838var Complex64Array = require ( ' @stdlib/array/complex64' );
3939var Complex64 = require ( ' @stdlib/complex/float32/ctor' );
40- var realf = require ( ' @stdlib/complex/float32/real' );
41- var imagf = require ( ' @stdlib/complex/float32/imag' );
4240
4341// Define a strided array:
4442var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 ] );
@@ -48,15 +46,7 @@ var ca = new Complex64( 2.0, 2.0 );
4846
4947// Perform operation:
5048cscal .main ( cx .length , ca, cx, 1 );
51-
52- var v = cx .get ( 0 );
53- // returns <Complex64>
54-
55- var re = realf ( v );
56- // returns -2.0
57-
58- var im = imagf ( v );
59- // returns 6.0
49+ // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
6050```
6151
6252The function has the following parameters:
@@ -71,26 +61,16 @@ The `N` and stride parameters determine which elements in the input strided arra
7161``` javascript
7262var Complex64Array = require ( ' @stdlib/array/complex64' );
7363var Complex64 = require ( ' @stdlib/complex/float32/ctor' );
74- var realf = require ( ' @stdlib/complex/float32/real' );
75- var imagf = require ( ' @stdlib/complex/float32/imag' );
7664
7765// Define a strided array:
7866var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 ] );
7967
8068// Define a scalar constant:
81- var ca = new Complex64 ( 2.0 , 0 .0 );
69+ var ca = new Complex64 ( 2.0 , 2 .0 );
8270
8371// Perform operation:
8472cscal .main ( 2 , ca, cx, 2 );
85-
86- var v = cx .get ( 2 );
87- // returns <Complex64>
88-
89- var re = realf ( v );
90- // returns 10.0
91-
92- var im = imagf ( v );
93- // returns 12.0
73+ // cx => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ]
9474```
9575
9676Note that indexing is relative to the first index. To introduce an offset, use [ ` typed array ` ] [ mdn-typed-array ] views.
@@ -100,8 +80,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
10080``` javascript
10181var Complex64Array = require ( ' @stdlib/array/complex64' );
10282var Complex64 = require ( ' @stdlib/complex/float32/ctor' );
103- var realf = require ( ' @stdlib/complex/float32/real' );
104- var imagf = require ( ' @stdlib/complex/float32/imag' );
10583
10684// Initial array:
10785var cx0 = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 , 7.0 , 8.0 ] );
@@ -114,26 +92,16 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
11492
11593// Scales every other value from `cx1` by `ca`...
11694cscal .main ( 3 , ca, cx1, 1 );
117-
118- var z = cx0 .get ( 1 );
119- // returns <Complex64>
120-
121- var re = realf ( z );
122- // returns -2.0
123-
124- var im = imagf ( z );
125- // returns 14.0
95+ // cx0 => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
12696```
12797
128- #### dscal .ndarray( N, ca, cx, strideX, offsetX )
98+ #### cscal .ndarray( N, ca, cx, strideX, offsetX )
12999
130100Scales values from ` cx ` by ` ca ` using alternative indexing semantics.
131101
132102``` javascript
133103var Complex64Array = require ( ' @stdlib/array/complex64' );
134104var Complex64 = require ( ' @stdlib/complex/float32/ctor' );
135- var realf = require ( ' @stdlib/complex/float32/real' );
136- var imagf = require ( ' @stdlib/complex/float32/imag' );
137105
138106// Define a strided array:
139107var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 ] );
@@ -142,16 +110,8 @@ var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
142110var ca = new Complex64 ( 2.0 , 2.0 );
143111
144112// Perform operation:
145- cscal .main ( cx .length , ca, cx, 1 );
146-
147- var v = cx .get ( 0 );
148- // returns <Complex64>
149-
150- var re = realf ( v );
151- // returns -2.0
152-
153- var im = imagf ( v );
154- // returns 6.0
113+ cscal .ndarray ( cx .length , ca, cx, 1 );
114+ // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
155115```
156116
157117The function has the following additional parameters:
@@ -163,22 +123,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
163123``` javascript
164124var Complex64Array = require ( ' @stdlib/array/complex64' );
165125var Complex64 = require ( ' @stdlib/complex/float32/ctor' );
166- var realf = require ( ' @stdlib/complex/float32/real' );
167- var imagf = require ( ' @stdlib/complex/float32/imag' );
168126
169127var cx = new Complex64Array ( [ 1.0 , 2.0 , 3.0 , 4.0 , 5.0 , 6.0 , 7.0 , 8.0 ] );
170128var ca = new Complex64 ( 2.0 , 2.0 );
171129
172130cscal .ndarray ( 2 , ca, cx, 2 , 1 );
173-
174- var z = cx .get ( 3 );
175- // returns <Complex64>
176-
177- var re = realf ( z );
178- // returns -2.0
179-
180- var im = imagf ( z );
181- // returns 30.0
131+ // cx => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ]
182132```
183133
184134* * *
0 commit comments