Skip to content

Commit 5997441

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/zcopy
PR-URL: #5121 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent bb3efff commit 5997441

File tree

8 files changed

+37
-205
lines changed

8 files changed

+37
-205
lines changed

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

+5-55
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,12 @@ Copies values from `x` into `y`.
3636

3737
```javascript
3838
var Complex128Array = require( '@stdlib/array/complex128' );
39-
var real = require( '@stdlib/complex/float64/real' );
40-
var imag = require( '@stdlib/complex/float64/imag' );
4139

4240
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4341
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4442

4543
zcopy( x.length, x, 1, y, 1 );
46-
47-
var z = y.get( 0 );
48-
// returns <Complex128>
49-
50-
var re = real( z );
51-
// returns 1.0
52-
53-
var im = imag( z );
54-
// returns 2.0
44+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
5545
```
5646

5747
The function has the following parameters:
@@ -66,22 +56,12 @@ The `N` and stride parameters determine how values from `x` are copied into `y`.
6656

6757
```javascript
6858
var Complex128Array = require( '@stdlib/array/complex128' );
69-
var real = require( '@stdlib/complex/float64/real' );
70-
var imag = require( '@stdlib/complex/float64/imag' );
7159

7260
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7361
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7462

7563
zcopy( 2, x, -2, y, 1 );
76-
77-
var z = y.get( 0 );
78-
// returns <Complex128>
79-
80-
var re = real( z );
81-
// returns 5.0
82-
83-
var im = imag( z );
84-
// returns 6.0
64+
// y => <Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
8565
```
8666

8767
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -90,8 +70,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9070

9171
```javascript
9272
var Complex128Array = require( '@stdlib/array/complex128' );
93-
var real = require( '@stdlib/complex/float64/real' );
94-
var imag = require( '@stdlib/complex/float64/imag' );
9573

9674
// Initial arrays...
9775
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -103,15 +81,7 @@ var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3
10381

10482
// Copy in reverse order every other value from `x1` into `y1`...
10583
zcopy( 2, x1, -2, y1, 1 );
106-
107-
var z = y0.get( 2 );
108-
// returns <Complex128>
109-
110-
var re = real( z );
111-
// returns 7.0
112-
113-
var im = imag( z );
114-
// returns 8.0
84+
// y0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
11585
```
11686

11787
#### zcopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -120,22 +90,12 @@ Copies values from `x` into `y` using alternative indexing semantics.
12090

12191
```javascript
12292
var Complex128Array = require( '@stdlib/array/complex128' );
123-
var real = require( '@stdlib/complex/float64/real' );
124-
var imag = require( '@stdlib/complex/float64/imag' );
12593

12694
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
12795
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
12896

12997
zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
130-
131-
var z = y.get( 0 );
132-
// returns <Complex128>
133-
134-
var re = real( z );
135-
// returns 1.0
136-
137-
var im = imag( z );
138-
// returns 2.0
98+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
13999
```
140100

141101
The function has the following additional parameters:
@@ -147,22 +107,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
147107

148108
```javascript
149109
var Complex128Array = require( '@stdlib/array/complex128' );
150-
var real = require( '@stdlib/complex/float64/real' );
151-
var imag = require( '@stdlib/complex/float64/imag' );
152110

153111
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
154112
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
155113

156114
zcopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
157-
158-
var z = y.get( y.length-1 );
159-
// returns <Complex128>
160-
161-
var re = real( z );
162-
// returns 3.0
163-
164-
var im = imag( z );
165-
// returns 4.0
115+
// y => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
166116
```
167117

168118
</section>

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

+12-30
Original file line numberDiff line numberDiff line change
@@ -38,34 +38,24 @@
3838
// Standard usage:
3939
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
4040
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
41-
> {{alias}}( x.length, x, 1, y, 1 );
42-
> var z = y.get( 0 );
43-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
44-
1.0
45-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
46-
2.0
41+
> {{alias}}( x.length, x, 1, y, 1 )
42+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
4743

4844
// Advanced indexing:
4945
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5046
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
51-
> {{alias}}( 2, x, -2, y, 1 );
52-
> z = y.get( 0 );
53-
> re = {{alias:@stdlib/complex/float64/real}}( z )
54-
5.0
55-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
56-
6.0
47+
> {{alias}}( 2, x, -2, y, 1 )
48+
<Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0 ]
5749

5850
// Using typed array views:
5951
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6052
> var y0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
6153
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
6254
> var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
63-
> {{alias}}( 1, x1, -2, y1, 1 );
64-
> z = y0.get( 2 );
65-
> re = {{alias:@stdlib/complex/float64/real}}( z )
66-
3.0
67-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
68-
4.0
55+
> {{alias}}( 1, x1, -2, y1, 1 )
56+
<Complex128Array>[ 3.0, 4.0 ]
57+
> y0
58+
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 3.0, 4.0 ]
6959

7060

7161
{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -110,22 +100,14 @@
110100
// Standard usage:
111101
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
112102
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
113-
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 );
114-
> var z = y.get( 0 );
115-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
116-
1.0
117-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
118-
2.0
103+
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 )
104+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
119105

120106
// Advanced indexing:
121107
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
122108
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
123-
> {{alias}}.ndarray( 1, x, 2, 1, y, -1, y.length-1 );
124-
> z = y.get( y.length-1 );
125-
> re = {{alias:@stdlib/complex/float64/real}}( z )
126-
3.0
127-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
128-
4.0
109+
> {{alias}}.ndarray( 1, x, 2, 1, y, -1, y.length-1 )
110+
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 3.0, 4.0 ]
129111

130112
See Also
131113
--------

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

+8-48
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,12 @@ interface Routine {
3838
*
3939
* @example
4040
* var Complex128Array = require( '@stdlib/array/complex128' );
41-
* var real = require( '@stdlib/complex/float64/real' );
42-
* var imag = require( '@stdlib/complex/float64/imag' );
4341
*
4442
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
45-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
43+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4644
*
4745
* zcopy( x.length, x, 1, y, 1 );
48-
*
49-
* var z = y.get( 0 );
50-
* // returns <Complex128>
51-
*
52-
* var re = real( z );
53-
* // returns 1.0
54-
*
55-
* var im = imag( z );
56-
* // returns 2.0
46+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
5747
*/
5848
( N: number, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array;
5949

@@ -71,22 +61,12 @@ interface Routine {
7161
*
7262
* @example
7363
* var Complex128Array = require( '@stdlib/array/complex128' );
74-
* var real = require( '@stdlib/complex/float64/real' );
75-
* var imag = require( '@stdlib/complex/float64/imag' );
7664
*
7765
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
78-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
66+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7967
*
8068
* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
81-
*
82-
* var z = y.get( 0 );
83-
* // returns <Complex128>
84-
*
85-
* var re = real( z );
86-
* // returns 1.0
87-
*
88-
* var im = imag( z );
89-
* // returns 2.0
69+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
9070
*/
9171
ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128Array;
9272
}
@@ -103,41 +83,21 @@ interface Routine {
10383
*
10484
* @example
10585
* var Complex128Array = require( '@stdlib/array/complex128' );
106-
* var real = require( '@stdlib/complex/float64/real' );
107-
* var imag = require( '@stdlib/complex/float64/imag' );
10886
*
10987
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
110-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
88+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
11189
*
11290
* zcopy( x.length, x, 1, y, 1 );
113-
*
114-
* var z = y.get( 0 );
115-
* // returns <Complex128>
116-
*
117-
* var re = real( z );
118-
* // returns 1.0
119-
*
120-
* var im = imag( z );
121-
* // returns 2.0
91+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
12292
*
12393
* @example
12494
* var Complex128Array = require( '@stdlib/array/complex128' );
125-
* var real = require( '@stdlib/complex/float64/real' );
126-
* var imag = require( '@stdlib/complex/float64/imag' );
12795
*
12896
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
129-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
97+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
13098
*
13199
* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
132-
*
133-
* var z = y.get( 0 );
134-
* // returns <Complex128>
135-
*
136-
* var re = real( z );
137-
* // returns 1.0
138-
*
139-
* var im = imag( z );
140-
* // returns 2.0
100+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
141101
*/
142102
declare var zcopy: Routine;
143103

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

+4-24
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,23 @@
2525
*
2626
* @example
2727
* var Complex128Array = require( '@stdlib/array/complex128' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var zcopy = require( '@stdlib/blas/base/zcopy' );
3129
*
3230
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
33-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
31+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
3432
*
3533
* zcopy( x.length, x, 1, y, 1 );
36-
*
37-
* var z = y.get( 0 );
38-
* // returns <Complex128>
39-
*
40-
* var re = real( z );
41-
* // returns 1.0
42-
*
43-
* var im = imag( z );
44-
* // returns 2.0
34+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
4535
*
4636
* @example
4737
* var Complex128Array = require( '@stdlib/array/complex128' );
48-
* var real = require( '@stdlib/complex/float64/real' );
49-
* var imag = require( '@stdlib/complex/float64/imag' );
5038
* var zcopy = require( '@stdlib/blas/base/zcopy' );
5139
*
5240
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
53-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
41+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
5442
*
5543
* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
56-
*
57-
* var z = y.get( 0 );
58-
* // returns <Complex128>
59-
*
60-
* var re = real( z );
61-
* // returns 1.0
62-
*
63-
* var im = imag( z );
64-
* // returns 2.0
44+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
6545
*/
6646

6747
// MODULES //

‎lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.js

+2-12
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,12 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
3939
*
4040
* @example
4141
* var Complex128Array = require( '@stdlib/array/complex128' );
42-
* var real = require( '@stdlib/complex/float64/real' );
43-
* var imag = require( '@stdlib/complex/float64/imag' );
4442
*
4543
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
46-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
44+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4745
*
4846
* zcopy( x.length, x, 1, 0, y, 1, 0 );
49-
*
50-
* var z = y.get( 0 );
51-
* // returns <Complex128>
52-
*
53-
* var re = real( z );
54-
* // returns 1.0
55-
*
56-
* var im = imag( z );
57-
* // returns 2.0
47+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
5848
*/
5949
function zcopy( N, x, strideX, offsetX, y, strideY, offsetY ) {
6050
var viewX;

‎lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.native.js

+2-12
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,12 @@ var addon = require( './../src/addon.node' );
4040
*
4141
* @example
4242
* var Complex128Array = require( '@stdlib/array/complex128' );
43-
* var real = require( '@stdlib/complex/float64/real' );
44-
* var imag = require( '@stdlib/complex/float64/imag' );
4543
*
4644
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
47-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
45+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4846
*
4947
* zcopy( x.length, x, 1, 0, y, 1, 0 );
50-
*
51-
* var z = y.get( 0 );
52-
* // returns <Complex128>
53-
*
54-
* var re = real( z );
55-
* // returns 1.0
56-
*
57-
* var im = imag( z );
58-
* // returns 2.0
48+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
5949
*/
6050
function zcopy( N, x, strideX, offsetX, y, strideY, offsetY ) {
6151
var viewX = reinterpret( x, 0 );

0 commit comments

Comments
 (0)