From ca3eaf50761017cc36128e8ff4907b1f3216f5c2 Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Mon, 28 Apr 2025 12:49:52 +0530 Subject: [PATCH] docs: update examples for blas/base/wasm/cswap --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - 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 --- --- .../base/wasm/cswap/docs/types/index.d.ts | 104 +++-------------- .../@stdlib/blas/base/wasm/cswap/lib/index.js | 45 +------- .../@stdlib/blas/base/wasm/cswap/lib/main.js | 54 ++------- .../blas/base/wasm/cswap/lib/routine.js | 106 +++--------------- 4 files changed, 46 insertions(+), 263 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/types/index.d.ts index 5ef2686cc735..f359231592f4 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/types/index.d.ts @@ -327,32 +327,14 @@ interface Routine extends ModuleWrapper { * * @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( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * 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 ] ); * * // Perform operation: * cswap.main( x.length, x, 1, y, 1 ); - * - * var v = x.get( 0 ); - * // returns - * - * var re = realf( v ); - * // returns 1.0 - * - * var im = imagf( v ); - * // returns 2.0 - * - * var v = y.get( 0 ); - * // returns - * - * var re = realf( v ); - * // returns -1.0 - * - * var im = imagf( 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 ]; */ main( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64Array; @@ -370,32 +352,14 @@ interface Routine extends ModuleWrapper { * * @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( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * 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 ] ); * * // Perform operation: - * cswap.ndarray( x.length, x, -1, 2, y, 1, 0 ); - * - * var v = x.get( 2 ); - * // returns - * - * var re = realf( v ); - * // returns 1.0 - * - * var im = imagf( v ); - * // returns 2.0 - * - * var v = y.get( 2 ); - * // returns - * - * var re = realf( v ); - * // returns -1.0 - * - * var im = imagf( v ); - * // returns -2.0 + * cswap.ndarray( x.length, x, 1, 0, y, 1, 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 ]; */ ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64Array; @@ -480,61 +444,25 @@ interface Routine extends ModuleWrapper { * * @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 ] ); * * // Perform operation: * cswap.main( x.length, x, -1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 11.0 -* -* var im = imagf( v ); -* // returns 12.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 5.0 -* -* var im = imagf( v ); -* // returns 6.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 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 ] ); * * // Perform operation: -* cswap.ndarray( x.length, x, 1, 0, y, -1, 2 ); -* -* var v = x.get( 2 ); -* // returns -* -* var re = realf( v ); -* // returns 7.0 -* -* var im = imagf( v ); -* // returns 8.0 -* -* var v = y.get( 2 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns 2.0 +* cswap.ndarray( x.length, x, 1, 0, y, 1, 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 ]; */ declare var cswap: Routine; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/index.js index 90562314090a..657c01ce25d5 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/index.js @@ -25,8 +25,6 @@ * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cswap = require( '@stdlib/blas/base/wasm/cswap' ); * * // Define strided arrays... @@ -35,30 +33,11 @@ * * // Perform operation: * cswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 0.0 -* -* var im = imagf( v ); -* // returns 0.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( 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 Complex64Array = require( '@stdlib/array/complex64' ); -* var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cswap = require( '@stdlib/blas/base/wasm/cswap' ); * * // Define strided arrays... @@ -67,24 +46,8 @@ * * // Perform operation: * cswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 0.0 -* -* var im = imagf( v ); -* // returns 0.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( 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/cswap/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/main.js index 828f1e84717e..997af2b4468b 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/main.js @@ -33,63 +33,27 @@ var Routine = require( './routine.js' ); * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Define strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: * cswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( 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 Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Define a strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: -* cswap.ndarray( x.length, x, 1, 0, y, -1, 2 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 5.0 -* -* var im = imagf( v ); -* // returns 6.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -5.0 -* -* var im = imagf( v ); -* // returns -6.0 +* cswap.ndarray( x.length, x, 1, 0, y, 1, 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 ]; */ var cswap = new Routine(); cswap.initializeSync(); // eslint-disable-line node/no-sync diff --git a/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/routine.js index e9c102d55dba..3f0b80c2983a 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/cswap/lib/routine.js @@ -43,8 +43,6 @@ var Module = require( './module.js' ); * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Create a new routine: * var cswap = new Routine(); @@ -53,34 +51,16 @@ var Module = require( './module.js' ); * cswap.initializeSync(); * * // Define strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: * cswap.main( x.length, x, 1, y, 1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( 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 Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Create a new routine: * var cswap = new Routine(); @@ -89,29 +69,13 @@ var Module = require( './module.js' ); * cswap.initializeSync(); * * // Define strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: * cswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( 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 ]; */ function Routine() { if ( !( this instanceof Routine ) ) { @@ -142,8 +106,6 @@ inherits( Routine, Module ); * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Create a new routine: * var cswap = new Routine(); @@ -152,29 +114,13 @@ inherits( Routine, Module ); * cswap.initializeSync(); * * // Define strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: -* cswap.main( x.length, x, 1, y, -1 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 5.0 -* -* var im = imagf( v ); -* // returns 6.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -5.0 -* -* var im = imagf( v ); -* // returns -6.0 +* cswap.main( x.length, x, 1, y, 1 ); +* // 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 ]; */ setReadOnly( Routine.prototype, 'main', function cswap( 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 cswap( N, x, strideX, y, stride * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * // Create a new routine: * var cswap = new Routine(); @@ -208,29 +152,13 @@ setReadOnly( Routine.prototype, 'main', function cswap( N, x, strideX, y, stride * cswap.initializeSync(); * * // Define strided arrays... -* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] ); -* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* 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 ] ); * * // Perform operation: * cswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* -* var v = x.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns 2.0 -* -* var v = y.get( 0 ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( 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 ]; */ setReadOnly( Routine.prototype, 'ndarray', function cswap( N, x, strideX, offsetX, y, strideY, offsetY ) { var ptrs;