Skip to content

Commit 9f88c8c

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/caxpy
PR-URL: stdlib-js#4925 Ref: stdlib-js#4833 Reviewed-by: Athan Reines <[email protected]>
1 parent 611fed3 commit 9f88c8c

File tree

8 files changed

+27
-195
lines changed

8 files changed

+27
-195
lines changed

‎lib/node_modules/@stdlib/blas/base/caxpy/README.md‎

Lines changed: 5 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,13 @@ Scales values from `cx` by `ca` and adds the result to `cy`.
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, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4442
var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4543
var ca = new Complex64( 2.0, 2.0 );
4644

4745
caxpy( 3, ca, cx, 1, cy, 1 );
48-
49-
var z = cy.get( 0 );
50-
// returns <Complex64>
51-
52-
var re = realf( z );
53-
// returns -1.0
54-
55-
var im = imagf( z );
56-
// returns 7.0
46+
// cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
5747
```
5848

5949
The function has the following parameters:
@@ -70,23 +60,13 @@ The `N` and stride parameters determine how values from `cx` are scaled by `ca`
7060
```javascript
7161
var Complex64Array = require( '@stdlib/array/complex64' );
7262
var Complex64 = require( '@stdlib/complex/float32/ctor' );
73-
var realf = require( '@stdlib/complex/float32/real' );
74-
var imagf = require( '@stdlib/complex/float32/imag' );
7563

7664
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7765
var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
7866
var ca = new Complex64( 2.0, 2.0 );
7967

8068
caxpy( 2, ca, cx, 2, cy, 2 );
81-
82-
var z = cy.get( 0 );
83-
// returns <Complex64>
84-
85-
var re = realf( z );
86-
// returns -1.0
87-
88-
var im = imagf( z );
89-
// returns 7.0
69+
// cy => <Complex64Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
9070
```
9171

9272
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -96,8 +76,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9676
```javascript
9777
var Complex64Array = require( '@stdlib/array/complex64' );
9878
var Complex64 = require( '@stdlib/complex/float32/ctor' );
99-
var realf = require( '@stdlib/complex/float32/real' );
100-
var imagf = require( '@stdlib/complex/float32/imag' );
10179

10280
// Initial arrays...
10381
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -112,15 +90,7 @@ var cy1 = new Complex64Array( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); // start at
11290

11391
// Scales values of `cx0` by `ca` starting from second index and add the result to `cy0` starting from third index...
11492
caxpy( 2, ca, cx1, 1, cy1, 1 );
115-
116-
var z = cy0.get( 2 );
117-
// returns <Complex64>
118-
119-
var re = realf( z );
120-
// returns -1.0
121-
122-
var im = imagf( z );
123-
// returns 15.0
93+
// cy0 => <Complex64Array>[ 1.0, 1.0, 1.0, 1.0, -1.0, 15.0, -1.0, 23.0 ]
12494
```
12595

12696
#### caxpy.ndarray( N, ca, cx, strideX, offsetX, cy, strideY, offsetY )
@@ -130,23 +100,13 @@ Scales values from `cx` by `ca` and adds the result to `cy` using alternative in
130100
```javascript
131101
var Complex64Array = require( '@stdlib/array/complex64' );
132102
var Complex64 = require( '@stdlib/complex/float32/ctor' );
133-
var realf = require( '@stdlib/complex/float32/real' );
134-
var imagf = require( '@stdlib/complex/float32/imag' );
135103

136104
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
137105
var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
138106
var ca = new Complex64( 2.0, 2.0 );
139107

140108
caxpy.ndarray( 3, ca, cx, 1, 0, cy, 1, 0 );
141-
142-
var z = cy.get( 0 );
143-
// returns <Complex64>
144-
145-
var re = realf( z );
146-
// returns -1.0
147-
148-
var im = imagf( z );
149-
// returns 7.0
109+
// cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
150110
```
151111

152112
The function has the following additional parameters:
@@ -159,23 +119,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
159119
```javascript
160120
var Complex64Array = require( '@stdlib/array/complex64' );
161121
var Complex64 = require( '@stdlib/complex/float32/ctor' );
162-
var realf = require( '@stdlib/complex/float32/real' );
163-
var imagf = require( '@stdlib/complex/float32/imag' );
164122

165123
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
166124
var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
167125
var ca = new Complex64( 2.0, 2.0 );
168126

169127
caxpy.ndarray( 3, ca, cx, 1, 1, cy, 1, 1 );
170-
171-
var z = cy.get( 3 );
172-
// returns <Complex64>
173-
174-
var re = realf( z );
175-
// returns -1.0
176-
177-
var im = imagf( z );
178-
// returns 31.0
128+
// cy => <Complex64Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
179129
```
180130

181131
</section>

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

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -43,34 +43,24 @@
4343
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
4444
> var cy = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0 ] );
4545
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
46-
> {{alias}}( 2, ca, cx, 1, cy, 1 );
47-
> var z = cy.get( 0 );
48-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
49-
-1.0
50-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
51-
7.0
46+
> {{alias}}( 2, ca, cx, 1, cy, 1 )
47+
<Complex64Array>[ -1.0, 7.0, -1.0, 15.0 ]
5248

5349
// Advanced indexing:
5450
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5551
> cy = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
56-
> {{alias}}( 2, ca, cx, -2, cy, 1 );
57-
> z = cy.get( 0 );
58-
> re = {{alias:@stdlib/complex/float32/real}}( z )
59-
-1.0
60-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
61-
23.0
52+
> {{alias}}( 2, ca, cx, -2, cy, 1 )
53+
<Complex64Array>[ -1.0, 23.0, -1.0, 7.0, 1.0, 1.0 ]
6254

6355
// Using typed array views:
6456
> var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
6557
> var cy0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0 ] );
6658
> var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
6759
> var cy1 = new {{alias:@stdlib/array/complex64}}( cy0.buffer, cy0.BYTES_PER_ELEMENT*1 );
68-
> {{alias}}( 1, ca, cx1, 1, cy1, 1 );
69-
> z = cy0.get( 1 );
70-
> re = {{alias:@stdlib/complex/float32/real}}( z )
71-
-1.0
72-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
73-
15.0
60+
> {{alias}}( 1, ca, cx1, 1, cy1, 1 )
61+
<Complex64Array>[ -1.0, 15.0 ]
62+
> cy0
63+
<Complex64Array>[ 1.0, 1.0, -1.0, 15.0 ]
7464

7565

7666
{{alias}}.ndarray( N, ca, cx, strideX, offsetX, cy, strideY, offsetY )
@@ -120,22 +110,14 @@
120110
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
121111
> var cy = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0 ] );
122112
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
123-
> {{alias}}.ndarray( cx.length, ca, cx, 1, 0, cy, 1, 0 );
124-
> var z = cy.get( 0 );
125-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
126-
-1.0
127-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
128-
7.0
113+
> {{alias}}.ndarray( cx.length, ca, cx, 1, 0, cy, 1, 0 )
114+
<Complex64Array>[ -1.0, 7.0, -1.0, 15.0 ]
129115

130116
// Advanced indexing:
131117
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
132118
> cy = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
133-
> {{alias}}.ndarray( 2, ca, cx, 1, 1, cy, 1, 1 );
134-
> z = cy.get( 2 );
135-
> re = {{alias:@stdlib/complex/float32/real}}( z )
136-
-1.0
137-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
138-
23.0
119+
> {{alias}}.ndarray( 2, ca, cx, 1, 1, cy, 1, 1 )
120+
<Complex64Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0 ]
139121

140122
See Also
141123
--------

‎lib/node_modules/@stdlib/blas/base/caxpy/docs/types/index.d.ts‎

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,13 @@ interface Routine {
4141
* @example
4242
* var Complex64Array = require( '@stdlib/array/complex64' );
4343
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
44-
* var realf = require( '@stdlib/complex/float32/real' );
45-
* var imagf = require( '@stdlib/complex/float32/imag' );
4644
*
4745
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4846
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4947
* var ca = new Complex64( 2.0, 2.0 );
5048
*
5149
* caxpy( cx.length, ca, cx, 1, cy, 1 );
52-
*
53-
* var z = cy.get( 0 );
54-
* // returns <Complex64>
55-
*
56-
* var re = realf( z );
57-
* // returns -1.0
58-
*
59-
* var im = imagf( z );
60-
* // returns 7.0
50+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6151
*/
6252
( N: number, ca: Complex64, cx: Complex64Array, strideX: number, cy: Complex64Array, strideY: number ): Complex64Array;
6353

@@ -77,23 +67,13 @@ interface Routine {
7767
* @example
7868
* var Complex64Array = require( '@stdlib/array/complex64' );
7969
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
80-
* var realf = require( '@stdlib/complex/float32/real' );
81-
* var imagf = require( '@stdlib/complex/float32/imag' );
8270
*
8371
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
8472
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
8573
* var ca = new Complex64( 2.0, 2.0 );
8674
*
8775
* caxpy.ndarray( cx.length, ca, cx, 1, 0, cy, 1, 0 );
88-
*
89-
* var z = cy.get( 0 );
90-
* // returns <Complex64>
91-
*
92-
* var re = realf( z );
93-
* // returns -1.0
94-
*
95-
* var im = imagf( z );
96-
* // returns 7.0
76+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
9777
*/
9878
ndarray( N: number, ca: Complex64, cx: Complex64Array, strideX: number, offsetX: number, cy: Complex64Array, strideY: number, offsetY: number ): Complex64Array;
9979
}
@@ -112,44 +92,24 @@ interface Routine {
11292
* @example
11393
* var Complex64Array = require( '@stdlib/array/complex64' );
11494
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
115-
* var realf = require( '@stdlib/complex/float32/real' );
116-
* var imagf = require( '@stdlib/complex/float32/imag' );
11795
*
11896
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
11997
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
12098
* var ca = new Complex64( 2.0, 2.0 );
12199
*
122100
* caxpy( 2, ca, cx, 2, cy, 2 );
123-
*
124-
* var z = cy.get( 0 );
125-
* // returns <Complex64>
126-
*
127-
* var re = realf( z );
128-
* // returns -1.0
129-
*
130-
* var im = imagf( z );
131-
* // returns 7.0
101+
* // cy => <Complex64Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
132102
*
133103
* @example
134104
* var Complex64Array = require( '@stdlib/array/complex64' );
135105
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
136-
* var realf = require( '@stdlib/complex/float32/real' );
137-
* var imagf = require( '@stdlib/complex/float32/imag' );
138106
*
139107
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
140108
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
141109
* var ca = new Complex64( 2.0, 2.0 );
142110
*
143111
* caxpy.ndarray( 3, ca, cx, 1, 1, cy, 1, 1 );
144-
*
145-
* var z = cy.get( 3 );
146-
* // returns <Complex64>
147-
*
148-
* var re = realf( z );
149-
* // returns -1.0
150-
*
151-
* var im = imagf( z );
152-
* // returns 31.0
112+
* // cy => <Complex64Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
153113
*/
154114
declare var caxpy: Routine;
155115

‎lib/node_modules/@stdlib/blas/base/caxpy/lib/caxpy.js‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,13 @@ var ndarray = require( './ndarray.js' );
4040
* @example
4141
* var Complex64Array = require( '@stdlib/array/complex64' );
4242
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
43-
* var realf = require( '@stdlib/complex/float32/real' );
44-
* var imagf = require( '@stdlib/complex/float32/imag' );
4543
*
4644
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4745
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4846
* var ca = new Complex64( 2.0, 2.0 );
4947
*
5048
* caxpy( 3, ca, cx, 1, cy, 1 );
51-
*
52-
* var z = cy.get( 0 );
53-
* // returns <Complex64>
54-
*
55-
* var re = realf( z );
56-
* // returns -1.0
57-
*
58-
* var im = imagf( z );
59-
* // returns 7.0
49+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6050
*/
6151
function caxpy( N, ca, cx, strideX, cy, strideY ) {
6252
var ix = stride2offset( N, strideX );

‎lib/node_modules/@stdlib/blas/base/caxpy/lib/caxpy.native.js‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,13 @@ var addon = require( './../src/addon.node' );
4040
* @example
4141
* var Complex64Array = require( '@stdlib/array/complex64' );
4242
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
43-
* var realf = require( '@stdlib/complex/float32/real' );
44-
* var imagf = require( '@stdlib/complex/float32/imag' );
4543
*
4644
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4745
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
4846
* var ca = new Complex64( 2.0, 2.0 );
4947
*
5048
* caxpy( 3, ca, cx, 1, cy, 1 );
51-
*
52-
* var z = cy.get( 0 );
53-
* // returns <Complex64>
54-
*
55-
* var re = realf( z );
56-
* // returns -1.0
57-
*
58-
* var im = imagf( z );
59-
* // returns 7.0
49+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6050
*/
6151
function caxpy( N, ca, cx, strideX, cy, strideY ) {
6252
var viewCX = reinterpret( cx, 0 );

‎lib/node_modules/@stdlib/blas/base/caxpy/lib/index.js‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,46 +26,26 @@
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 caxpy = require( '@stdlib/blas/base/caxpy' );
3230
*
3331
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
3432
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
3533
* var ca = new Complex64( 2.0, 2.0 );
3634
*
3735
* caxpy( 3, ca, cx, 1, cy, 1 );
38-
*
39-
* var z = cy.get( 0 );
40-
* // returns <Complex64>
41-
*
42-
* var re = realf( z );
43-
* // returns -1.0
44-
*
45-
* var im = imagf( z );
46-
* // returns 7.0
36+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
4737
*
4838
* @example
4939
* var Complex64Array = require( '@stdlib/array/complex64' );
5040
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
51-
* var realf = require( '@stdlib/complex/float32/real' );
52-
* var imagf = require( '@stdlib/complex/float32/imag' );
5341
* var caxpy = require( '@stdlib/blas/base/caxpy' );
5442
*
5543
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5644
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
5745
* var ca = new Complex64( 2.0, 2.0 );
5846
*
5947
* caxpy.ndarray( 3, ca cx, 1, 0, cy, 1, 0);
60-
*
61-
* var z = cy.get( 0 );
62-
* // returns <Complex64>
63-
*
64-
* var re = realf( z );
65-
* // returns -1.0
66-
*
67-
* var im = imagf( z );
68-
* // returns 7.0
48+
* // cy => <Complex64Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6949
*/
7050

7151
// MODULES //

0 commit comments

Comments
 (0)