From 7954f000dd7d1c4d618d54cbddb0392c5d1b8dbf Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Mon, 3 Mar 2025 19:12:35 +0000 Subject: [PATCH] docs: update examples for `blas/base/wasm/zswap` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/blas/base/wasm/zswap/README.md | 110 ++---------------- .../blas/base/wasm/zswap/docs/repl.txt | 70 ++++------- .../base/wasm/zswap/docs/types/index.d.ts | 88 ++------------ .../@stdlib/blas/base/wasm/zswap/lib/index.js | 45 +------ .../@stdlib/blas/base/wasm/zswap/lib/main.js | 44 +------ .../blas/base/wasm/zswap/lib/routine.js | 88 ++------------ 6 files changed, 54 insertions(+), 391 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/README.md b/lib/node_modules/@stdlib/blas/base/wasm/zswap/README.md index aca8f1ab94d8..27771b29d647 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/README.md +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/README.md @@ -36,31 +36,13 @@ Interchanges two complex double-precision floating-point vectors. ```javascript var Complex128Array = require( '@stdlib/array/complex128' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); zswap.main( x.length, x, 1, y, 1 ); - -var z = y.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns 2.0 - -z = x.get( 0 ); -// returns - -re = real( z ); -// returns 0.0 - -im = imag( z ); -// returns 0.0 +// x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ``` The function has the following parameters: @@ -75,31 +57,13 @@ The `N` and stride parameters determine how values from `x` are interchanged wit ```javascript var Complex128Array = require( '@stdlib/array/complex128' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); zswap.main( 2, x, -2, y, 1 ); - -var z = y.get( 0 ); -// returns - -var re = real( z ); -// returns 5.0 - -var im = imag( z ); -// returns 6.0 - -z = x.get( 0 ); -// returns - -re = real( z ); -// returns 0.0 - -im = imag( z ); -// returns 0.0 +// x => [ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0 ] +// y => [ 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. @@ -108,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Complex128Array = require( '@stdlib/array/complex128' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); // Initial arrays... var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); @@ -121,24 +83,8 @@ var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3 // Interchange every other value from `x1` into `y1` in reverse order... zswap.main( 2, x1, -2, y1, 1 ); - -var z = y0.get( 2 ); -// returns - -var re = real( z ); -// returns 7.0 - -var im = imag( z ); -// returns 8.0 - -z = x0.get( 1 ); -// returns - -re = real( z ); -// returns 0.0 - -im = imag( z ); -// returns 0.0 +// x0 => [ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ] +// y0 => [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ``` #### zswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) @@ -147,31 +93,13 @@ Interchanges two complex double-precision floating-point vectors using alternati ```javascript var Complex128Array = require( '@stdlib/array/complex128' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); zswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); - -var z = y.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns 2.0 - -z = x.get( 0 ); -// returns - -re = real( z ); -// returns 0.0 - -im = imag( z ); -// returns 0.0 +// x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ``` The function has the following additional parameters: @@ -183,31 +111,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the ```javascript var Complex128Array = require( '@stdlib/array/complex128' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); zswap.ndarray( 2, x, 2, 1, y, -1, y.length-1 ); - -var z = y.get( y.length-1 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 4.0 - -z = x.get( x.length-1 ); -// returns - -re = real( z ); -// returns 0.0 - -im = imag( z ); -// returns 0.0 +// x => [ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ] +// y => [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ``` * * * diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/repl.txt index 80c97728bfc4..a4e697d48b83 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/repl.txt @@ -38,31 +38,19 @@ > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] ); > {{alias}}.main( x.length, x, 1, y, 1 ); - > var z = y.get( 0 ); - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 2.0 - > z = x.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 6.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 7.0 + > x + [ 6.0, 7.0, 8.0, 9.0 ] + > y + [ 1.0, 2.0, 3.0, 4.0 ] // Advanced indexing: > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); > y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); > {{alias}}.main( 2, x, -2, y, 1 ); - > z = y.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 5.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 6.0 - > z = x.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 0.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 0.0 + > x + [ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0 ] + > y + [ 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/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); @@ -70,16 +58,10 @@ > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); > {{alias}}.main( 2, x1, -1, y1, 1 ); - > z = y0.get( 2 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 4.0 - > z = x0.get( 1 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 0.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 0.0 + > x0 + [ 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ] + > y0 + [ 0.0, 0.0, 5.0, 6.0, 3.0, 4.0 ] {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) @@ -124,31 +106,19 @@ > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var y = new {{alias:@stdlib/array/complex128}}( [ 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/float64/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 2.0 - > z = x.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 6.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 7.0 + > x + [ 6.0, 7.0, 8.0, 9.0 ] + > y + [ 1.0, 2.0, 3.0, 4.0 ] // Advanced indexing: > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); > y = new {{alias:@stdlib/array/complex128}}( [ 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/float64/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 4.0 - > z = x.get( 1 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 0.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 0.0 + > x + [ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ] + > y + [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] {{alias}}.Module( memory ) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/types/index.d.ts index 3fa7328c225f..e7ed2a4c036a 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/types/index.d.ts @@ -327,32 +327,14 @@ interface Routine extends ModuleWrapper { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); * var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * * // Perform operation: * zswap.main( x.length, x, 1, y, 1 ); - * - * var v = x.get( 0 ); - * // returns - * - * var re = real( v ); - * // returns 1.0 - * - * var im = imag( v ); - * // returns 2.0 - * - * var v = y.get( 0 ); - * // returns - * - * var re = real( v ); - * // returns -1.0 - * - * var im = imag( v ); - * // returns -2.0 + * // x => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] + * // y => [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] */ main( N: number, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array; @@ -370,32 +352,14 @@ interface Routine extends ModuleWrapper { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); * var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * * // Perform operation: * zswap.ndarray( x.length, x, -1, 2, y, 1, 0 ); - * - * var v = x.get( 2 ); - * // returns - * - * var re = real( v ); - * // returns 1.0 - * - * var im = imag( v ); - * // returns 2.0 - * - * var v = y.get( 2 ); - * // returns - * - * var re = real( v ); - * // returns -1.0 - * - * var im = imag( v ); - * // returns -2.0 + * // x => [ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ] + * // y => [ -5.0, -6.0, -3.0, -4.0, -1.0, -2.0 ] */ ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128Array; @@ -480,61 +444,25 @@ interface Routine extends ModuleWrapper { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); * * // Perform operation: * zswap.main( x.length, x, -1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 11.0 -* -* var im = imag( v ); -* // returns 12.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 5.0 -* -* var im = imag( v ); -* // returns 6.0 +* // x => [ 11.0, 12.0, 9.0, 10.0, 7.0, 8.0 ] +* // y => [ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); * * // Perform operation: * zswap.ndarray( x.length, x, 1, 0, y, -1, 2 ); -* -* var v = x.get( 2 ); -* // returns -* -* var re = real( v ); -* // returns 7.0 -* -* var im = imag( v ); -* // returns 8.0 -* -* var v = y.get( 2 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 +* // x => [ 11.0, 12.0, 9.0, 10.0, 7.0, 8.0 ] +* // y => [ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ] */ declare var zswap: Routine; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/index.js index 25d3f84c80f9..bff9fe8760be 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/index.js @@ -25,8 +25,6 @@ * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var zswap = require( '@stdlib/blas/base/wasm/zswap' ); * * // Define strided arrays... @@ -35,30 +33,11 @@ * * // Perform operation: * zswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 0.0 -* -* var im = imag( v ); -* // returns 0.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 +* // x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var zswap = require( '@stdlib/blas/base/wasm/zswap' ); * * // Define strided arrays... @@ -67,24 +46,8 @@ * * // Perform operation: * zswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 0.0 -* -* var im = imag( v ); -* // returns 0.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 +* // x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] * * @example * var Memory = require( '@stdlib/wasm/memory' ); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/main.js index bb6b0053f2ad..df1f1b15abc2 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/main.js @@ -33,8 +33,6 @@ var Routine = require( './routine.js' ); * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Define strided arrays... * var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); @@ -42,29 +40,11 @@ var Routine = require( './routine.js' ); * * // Perform operation: * zswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns -2.0 +* // x => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +* // y => [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Define a strided arrays... * var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); @@ -72,24 +52,8 @@ var Routine = require( './routine.js' ); * * // Perform operation: * zswap.ndarray( x.length, x, 1, 0, y, -1, 2 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 5.0 -* -* var im = imag( v ); -* // returns 6.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -5.0 -* -* var im = imag( v ); -* // returns -6.0 +* // x => [ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ] +* // y => [ -5.0, -6.0, -3.0, -4.0, -1.0, -2.0 ] */ var zswap = new Routine(); zswap.initializeSync(); // eslint-disable-line node/no-sync diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/routine.js index 245dc36e7e16..7a33023c6866 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/zswap/lib/routine.js @@ -43,8 +43,6 @@ var Module = require( './module.js' ); * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Create a new routine: * var zswap = new Routine(); @@ -58,29 +56,11 @@ var Module = require( './module.js' ); * * // Perform operation: * zswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns -2.0 +* // x => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +* // y => [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Create a new routine: * var zswap = new Routine(); @@ -94,24 +74,8 @@ var Module = require( './module.js' ); * * // Perform operation: * zswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns -2.0 +* // x => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +* // y => [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] */ function Routine() { if ( !( this instanceof Routine ) ) { @@ -142,8 +106,6 @@ inherits( Routine, Module ); * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Create a new routine: * var zswap = new Routine(); @@ -157,24 +119,8 @@ inherits( Routine, Module ); * * // Perform operation: * zswap.main( x.length, x, 1, y, -1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 5.0 -* -* var im = imag( v ); -* // returns 6.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -5.0 -* -* var im = imag( v ); -* // returns -6.0 +* // x => [ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ] +* // y => [ -5.0, -6.0, -3.0, -4.0, -1.0, -2.0 ] */ setReadOnly( Routine.prototype, 'main', function zswap( N, x, strideX, y, strideY ) { return this.ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ) ); // eslint-disable-line max-len @@ -198,8 +144,6 @@ setReadOnly( Routine.prototype, 'main', function zswap( N, x, strideX, y, stride * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * // Create a new routine: * var zswap = new Routine(); @@ -213,24 +157,8 @@ setReadOnly( Routine.prototype, 'main', function zswap( N, x, strideX, y, stride * * // Perform operation: * zswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns -2.0 +* // x => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +* // y => [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] */ setReadOnly( Routine.prototype, 'ndarray', function zswap( N, x, strideX, offsetX, y, strideY, offsetY ) { var ptrs;