docs: update examples for blas/base/ccopy

PR-URL: #4836
Ref: #4833
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]>

Author: gururaj1512

lib/node_modules/@stdlib/blas/base/ccopy/README.md

@@ -36,22 +36,12 @@ Copies values from `x` into `y`.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy( x.length, x, 1, y, 1 );
-
-var z = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 1.0
-
-var im = imagf( z );
-// returns 2.0
+// y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 The function has the following parameters:
@@ -66,22 +56,12 @@ The `N` and stride parameters determine how values from `x` are copied into `y`.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy( 2, x, -2, y, 1 );
-
-var z = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 5.0
-
-var im = imagf( z );
-// returns 6.0
+// y => <Complex64Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
 ```
 
 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 [
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Initial arrays...
 var x0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -103,15 +81,7 @@ var y1 = new Complex64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3r
 
 // Copy in reverse order every other value from `x1` into `y1`...
 ccopy( 2, x1, -2, y1, 1 );
-
-var z = y0.get( 2 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 7.0
-
-var im = imagf( z );
-// returns 8.0
+// y0 => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 ```
 
 #### ccopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -120,22 +90,12 @@ Copies values from `x` into `y` using alternative indexing semantics.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-
-var z = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 1.0
-
-var im = imagf( z );
-// returns 2.0
+// y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 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
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
-
-var z = y.get( y.length-1 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 3.0
-
-var im = imagf( z );
-// returns 4.0
+// y => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 ```
 
 </section>

lib/node_modules/@stdlib/blas/base/ccopy/docs/repl.txt

@@ -38,34 +38,24 @@
     // Standard usage:
     > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, 7.0, 8.0, 9.0 ] );
-    > {{alias}}( x.length, x, 1, y, 1 );
-    > var z = y.get( 0 );
-    > var re = {{alias:@stdlib/complex/float32/real}}( z )
-    1.0
-    > var im = {{alias:@stdlib/complex/float32/imag}}( z )
-    2.0
+    > {{alias}}( x.length, x, 1, y, 1 )
+    <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
 
     // Advanced indexing:
     > x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
     > y = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
-    > {{alias}}( 2, x, -2, y, 1 );
-    > z = y.get( 0 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    5.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    6.0
+    > {{alias}}( 2, x, -2, y, 1 )
+    <Complex64Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
 
     // Using typed array views:
     > var x0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
     > var y0 = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
     > var x1 = new {{alias:@stdlib/array/complex64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     > var y1 = new {{alias:@stdlib/array/complex64}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
-    > {{alias}}( 2, x1, -2, y1, 1 );
-    > z = y0.get( 2 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    7.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    8.0
+    > {{alias}}( 2, x1, -2, y1, 1 )
+    <Complex64Array>[ 7.0, 8.0, 3.0, 4.0 ]
+    > y0
+    <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 
 
 {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -110,22 +100,14 @@
     // Standard usage:
     > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, 7.0, 8.0, 9.0 ] );
-    > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 );
-    > var z = y.get( 0 );
-    > var re = {{alias:@stdlib/complex/float32/real}}( z )
-    1.0
-    > var im = {{alias:@stdlib/complex/float32/imag}}( z )
-    2.0
+    > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 )
+    <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
 
     // Advanced indexing:
     > x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
     > y = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
-    > {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
-    > z = y.get( y.length-1 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    3.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    4.0
+    > {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1 )
+    <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 
     See Also
     --------

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

@@ -38,22 +38,12 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-	* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+	* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 	*
 	* ccopy( x.length, x, 1, y, 1 );
-	*
-	* var z = y.get( 0 );
-	* // returns <Complex64>
-	*
-	* var re = realf( z );
-	* // returns 1.0
-	*
-	* var im = imagf( z );
-	* // returns 2.0
+	* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 	*/
 	( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64Array;
 
@@ -71,22 +61,12 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-	* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+	* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 	*
 	* ccopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-	*
-	* var z = y.get( 0 );
-	* // returns <Complex64>
-	*
-	* var re = realf( z );
-	* // returns 1.0
-	*
-	* var im = imagf( z );
-	* // returns 2.0
+	* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 	*/
 	ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64Array;
 }
@@ -103,41 +83,21 @@ interface Routine {
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy( x.length, x, 1, y, 1 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 declare var ccopy: Routine;
 

lib/node_modules/@stdlib/blas/base/ccopy/lib/ccopy.js

@@ -38,22 +38,12 @@ var ndarray = require( './ndarray.js' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy( x.length, x, 1, y, 1 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 function ccopy( N, x, strideX, y, strideY ) {
 	var ox = stride2offset( N, strideX );

lib/node_modules/@stdlib/blas/base/ccopy/lib/ccopy.native.js

@@ -38,22 +38,12 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy( x.length, x, 1, y, 1 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 function ccopy( N, x, strideX, y, strideY ) {
 	var viewX = reinterpret( x, 0 );

lib/node_modules/@stdlib/blas/base/ccopy/lib/index.js

@@ -25,43 +25,23 @@
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var ccopy = require( '@stdlib/blas/base/ccopy' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy( x.length, x, 1, y, 1 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var ccopy = require( '@stdlib/blas/base/ccopy' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 *
 * ccopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-*
-* var z = y.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( z );
-* // returns 1.0
-*
-* var im = imagf( z );
-* // returns 2.0
+* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 
 // MODULES //