Skip to content

Commit 48f82a2

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/cscal
PR-URL: #4942 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent 9711748 commit 48f82a2

File tree

8 files changed

+29
-197
lines changed

8 files changed

+29
-197
lines changed

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/README.md

+6-56
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,18 @@ Scales values from `cx` by `ca`.
3737
```javascript
3838
var Complex64Array = require( '@stdlib/array/complex64' );
3939
var Complex64 = require( '@stdlib/complex/float32/ctor' );
40-
var realf = require( '@stdlib/complex/float32/real' );
41-
var imagf = require( '@stdlib/complex/float32/imag' );
4240

4341
var cx = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4442
var ca = new Complex64( 2.0, 0.0 );
4543

4644
cscal( 3, ca, cx, 1 );
47-
48-
var z = cx.get( 0 );
49-
// returns <Complex64>
50-
51-
var re = realf( z );
52-
// returns 2.0
53-
54-
var im = imagf( z );
55-
// returns 2.0
45+
// cx => <Complex64Array>[ 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ]
5646
```
5747

5848
The function has the following parameters:
5949

6050
- **N**: number of indexed elements.
61-
- **ca**: scalar [`Complex64`][@stdlib/complex/float32/ctor] constant.
51+
- **ca**: scalar [`Complex64`][@stdlib/complex/float32/ctor] constant.
6252
- **cx**: input [`Complex64Array`][@stdlib/array/complex64].
6353
- **strideX**: index increment for `cx`.
6454

@@ -67,22 +57,12 @@ The `N` and stride parameters determine how values from `cx` are scaled by `ca`.
6757
```javascript
6858
var Complex64Array = require( '@stdlib/array/complex64' );
6959
var Complex64 = require( '@stdlib/complex/float32/ctor' );
70-
var realf = require( '@stdlib/complex/float32/real' );
71-
var imagf = require( '@stdlib/complex/float32/imag' );
7260

7361
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7462
var ca = new Complex64( 2.0, 0.0 );
7563

7664
cscal( 2, ca, cx, 2 );
77-
78-
var z = cx.get( 2 );
79-
// returns <Complex64>
80-
81-
var re = realf( z );
82-
// returns 10.0
83-
84-
var im = imagf( z );
85-
// returns 12.0
65+
// cx => <Complex64Array>[ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0, 7.0, 8.0 ]
8666
```
8767

8868
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -92,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9272
```javascript
9373
var Complex64Array = require( '@stdlib/array/complex64' );
9474
var Complex64 = require( '@stdlib/complex/float32/ctor' );
95-
var realf = require( '@stdlib/complex/float32/real' );
96-
var imagf = require( '@stdlib/complex/float32/imag' );
9775

9876
// Initial array:
9977
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -106,15 +84,7 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
10684

10785
// Scales every other value from `cx1` by `ca`...
10886
cscal( 3, ca, cx1, 1 );
109-
110-
var z = cx0.get( 1 );
111-
// returns <Complex64>
112-
113-
var re = realf( z );
114-
// returns -2.0
115-
116-
var im = imagf( z );
117-
// returns 14.0
87+
// cx0 => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
11888
```
11989

12090
#### cscal.ndarray( N, ca, cx, strideX, offsetX )
@@ -124,22 +94,12 @@ Scales values from `cx` by `ca` using alternative indexing semantics.
12494
```javascript
12595
var Complex64Array = require( '@stdlib/array/complex64' );
12696
var Complex64 = require( '@stdlib/complex/float32/ctor' );
127-
var realf = require( '@stdlib/complex/float32/real' );
128-
var imagf = require( '@stdlib/complex/float32/imag' );
12997

13098
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
13199
var ca = new Complex64( 2.0, 2.0 );
132100

133101
cscal.ndarray( 3, ca, cx, 1, 0 );
134-
135-
var z = cx.get( 0 );
136-
// returns <Complex64>
137-
138-
var re = realf( z );
139-
// returns -2.0
140-
141-
var im = imagf( z );
142-
// returns 6.0
102+
// cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
143103
```
144104

145105
The function has the following additional parameters:
@@ -151,22 +111,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
151111
```javascript
152112
var Complex64Array = require( '@stdlib/array/complex64' );
153113
var Complex64 = require( '@stdlib/complex/float32/ctor' );
154-
var realf = require( '@stdlib/complex/float32/real' );
155-
var imagf = require( '@stdlib/complex/float32/imag' );
156114

157115
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
158116
var ca = new Complex64( 2.0, 2.0 );
159117

160118
cscal.ndarray( 2, ca, cx, 2, 1 );
161-
162-
var z = cx.get( 3 );
163-
// returns <Complex64>
164-
165-
var re = realf( z );
166-
// returns -2.0
167-
168-
var im = imagf( z );
169-
// returns 30.0
119+
// cx => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ]
170120
```
171121

172122
</section>

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/docs/repl.txt

+12-30
Original file line numberDiff line numberDiff line change
@@ -36,33 +36,23 @@
3636
// Standard usage:
3737
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
3838
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
39-
> {{alias}}( 2, ca, cx, 1 );
40-
> var z = cx.get( 0 );
41-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
42-
-3.0
43-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
44-
4.0
39+
> {{alias}}( 2, ca, cx, 1 )
40+
<Complex64Array>[ -3.0, 4.0, -5.0, 10.0 ]
4541

4642
// Advanced indexing:
4743
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4844
> ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 1.0 );
49-
> {{alias}}( 2, ca, cx, 2 );
50-
> z = cx.get( 0 );
51-
> re = {{alias:@stdlib/complex/float32/real}}( z )
52-
-1.0
53-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
54-
3.0
45+
> {{alias}}( 2, ca, cx, 2 )
46+
<Complex64Array>[ -1.0, 3.0, 3.0, 4.0, -1.0, 11.0 ]
5547

5648
// Using typed array views:
5749
> var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5850
> var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
5951
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
60-
> {{alias}}( 2, ca, cx1, 1 );
61-
> z = cx0.get( 1 );
62-
> re = {{alias:@stdlib/complex/float32/real}}( z )
63-
-2.0
64-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
65-
14.0
52+
> {{alias}}( 2, ca, cx1, 1 )
53+
<Complex64Array>[ -2.0, 14.0, -2.0, 22.0 ]
54+
> cx0
55+
<Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0 ]
6656

6757

6858
{{alias}}.ndarray( N, ca, cx, strideX, offsetX )
@@ -101,22 +91,14 @@
10191
// Standard usage:
10292
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
10393
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
104-
> {{alias}}.ndarray( 2, ca, cx, 1, 0 );
105-
> var z = cx.get( 0 );
106-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
107-
-2.0
108-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
109-
6.0
94+
> {{alias}}.ndarray( 2, ca, cx, 1, 0 )
95+
<Complex64Array>[ -2.0, 6.0, -2.0, 14.0 ]
11096

11197
// Advanced indexing:
11298
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
11399
> ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
114-
> {{alias}}.ndarray( 2, ca, cx, 1, 2 );
115-
> z = cx.get( 2 );
116-
> re = {{alias:@stdlib/complex/float32/real}}( z )
117-
-7.0
118-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
119-
16.0
100+
> {{alias}}.ndarray( 2, ca, cx, 1, 2 )
101+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, -7.0, 16.0, -9.0, 22.0 ]
120102

121103
See Also
122104
--------

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/docs/types/index.d.ts

+5-45
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,12 @@ interface Routine {
3939
* @example
4040
* var Complex64Array = require( '@stdlib/array/complex64' );
4141
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
42-
* var realf = require( '@stdlib/complex/float32/real' );
43-
* var imagf = require( '@stdlib/complex/float32/imag' );
4442
*
4543
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4644
* var ca = new Complex64( 2.0, 2.0 );
4745
*
4846
* cscal( 3, ca, cx, 1 );
49-
*
50-
* var z = cx.get( 0 );
51-
* // returns <Complex64>
52-
*
53-
* var re = realf( z );
54-
* // returns -2.0
55-
*
56-
* var im = imagf( z );
57-
* // returns 6.0
47+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5848
*/
5949
( N: number, ca: Complex64, cx: Complex64Array, strideX: number ): Complex64Array;
6050

@@ -71,22 +61,12 @@ interface Routine {
7161
* @example
7262
* var Complex64Array = require( '@stdlib/array/complex64' );
7363
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
74-
* var realf = require( '@stdlib/complex/float32/real' );
75-
* var imagf = require( '@stdlib/complex/float32/imag' );
7664
*
7765
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7866
* var ca = new Complex64( 2.0, 2.0 );
7967
*
8068
* cscal.ndarray( 3, ca, cx, 1, 0 );
81-
*
82-
* var z = cx.get( 0 );
83-
* // returns <Complex64>
84-
*
85-
* var re = realf( z );
86-
* // returns -2.0
87-
*
88-
* var im = imagf( z );
89-
* // returns 6.0
69+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
9070
*/
9171
ndarray( N: number, ca: Complex64, cx: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
9272
}
@@ -103,42 +83,22 @@ interface Routine {
10383
* @example
10484
* var Complex64Array = require( '@stdlib/array/complex64' );
10585
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
106-
* var realf = require( '@stdlib/complex/float32/real' );
107-
* var imagf = require( '@stdlib/complex/float32/imag' );
10886
*
10987
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
11088
* var ca = new Complex64( 2.0, 2.0 );
11189
*
11290
* cscal( 3, ca, cx, 1 );
113-
*
114-
* var z = cx.get( 0 );
115-
* // returns <Complex64>
116-
*
117-
* var re = realf( z );
118-
* // returns -2.0
119-
*
120-
* var im = imagf( z );
121-
* // returns 6.0
91+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
12292
*
12393
* @example
12494
* var Complex64Array = require( '@stdlib/array/complex64' );
12595
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
126-
* var realf = require( '@stdlib/complex/float32/real' );
127-
* var imagf = require( '@stdlib/complex/float32/imag' );
12896
*
12997
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
13098
* var ca = new Complex64( 2.0, 2.0 );
13199
*
132-
* cscal.ndarray( 2, ca, cx, 1, 0 );
133-
*
134-
* var z = cx.get( 0 );
135-
* // returns <Complex64>
136-
*
137-
* var re = realf( z );
138-
* // returns -2.0
139-
*
140-
* var im = imagf( z );
141-
* // returns 6.0
100+
* cscal.ndarray( 3, ca, cx, 1, 0 );
101+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
142102
*/
143103
declare var cscal: Routine;
144104

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/lib/cscal.js

+1-11
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,12 @@ var ndarray = require( './ndarray.js' );
3838
* @example
3939
* var Complex64Array = require( '@stdlib/array/complex64' );
4040
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
41-
* var realf = require( '@stdlib/complex/float32/real' );
42-
* var imagf = require( '@stdlib/complex/float32/imag' );
4341
*
4442
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4543
* var ca = new Complex64( 2.0, 2.0 );
4644
*
4745
* cscal( 3, ca, cx, 1 );
48-
*
49-
* var z = cx.get( 0 );
50-
* // returns <Complex64>
51-
*
52-
* var re = realf( z );
53-
* // returns -2.0
54-
*
55-
* var im = imagf( z );
56-
* // returns 6.0
46+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5747
*/
5848
function cscal( N, ca, cx, strideX ) {
5949
var ox = stride2offset( N, strideX );

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/lib/cscal.native.js

+1-11
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,12 @@ var addon = require( './../src/addon.node' );
3838
* @example
3939
* var Complex64Array = require( '@stdlib/array/complex64' );
4040
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
41-
* var realf = require( '@stdlib/complex/float32/real' );
42-
* var imagf = require( '@stdlib/complex/float32/imag' );
4341
*
4442
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4543
* var ca = new Complex64( 2.0, 2.0 );
4644
*
4745
* cscal( cx.length, ca, cx, 1 );
48-
*
49-
* var z = cx.get( 0 );
50-
* // returns <Complex64>
51-
*
52-
* var re = realf( z );
53-
* // returns -2.0
54-
*
55-
* var im = imagf( z );
56-
* // returns 6.0
46+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5747
*/
5848
function cscal( N, ca, cx, strideX ) {
5949
var viewCX = reinterpret( cx, 0 );

Diff for: ‎lib/node_modules/@stdlib/blas/base/cscal/lib/index.js

+2-22
Original file line numberDiff line numberDiff line change
@@ -26,44 +26,24 @@
2626
* @example
2727
* var Complex64Array = require( '@stdlib/array/complex64' );
2828
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
29-
* var realf = require( '@stdlib/complex/float32/real' );
30-
* var imagf = require( '@stdlib/complex/float32/imag' );
3129
* var cscal = require( '@stdlib/blas/base/cscal' );
3230
*
3331
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
3432
* var ca = new Complex64( 2.0, 2.0 );
3533
*
3634
* cscal( 3, ca, cx, 1 );
37-
*
38-
* var z = cx.get( 0 );
39-
* // returns <Complex64>
40-
*
41-
* var re = realf( z );
42-
* // returns -2.0
43-
*
44-
* var im = imagf( z );
45-
* // returns 6.0
35+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
4636
*
4737
* @example
4838
* var Complex64Array = require( '@stdlib/array/complex64' );
4939
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
50-
* var realf = require( '@stdlib/complex/float32/real' );
51-
* var imagf = require( '@stdlib/complex/float32/imag' );
5240
* var cscal = require( '@stdlib/blas/base/cscal' );
5341
*
5442
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5543
* var ca = new Complex64( 2.0, 2.0 );
5644
*
5745
* cscal.ndarray( 3, ca cx, 1, 0 );
58-
*
59-
* var z = cx.get( 0 );
60-
* // returns <Complex64>
61-
*
62-
* var re = realf( z );
63-
* // returns -2.0
64-
*
65-
* var im = imagf( z );
66-
* // returns 6.0
46+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
6747
*/
6848

6949
// MODULES //

0 commit comments

Comments
 (0)