From 659eb311c5d4da4edce52c2117b10f7cbd0fab0f Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Mon, 10 Feb 2025 13:52:34 +0000 Subject: [PATCH] docs: update examples for blas/base/zaxpy --- 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/zaxpy/README.md | 60 ++----------------- .../@stdlib/blas/base/zaxpy/docs/repl.txt | 42 ++++--------- .../blas/base/zaxpy/docs/types/index.d.ts | 48 ++------------- .../@stdlib/blas/base/zaxpy/lib/index.js | 24 +------- .../@stdlib/blas/base/zaxpy/lib/ndarray.js | 12 +--- .../@stdlib/blas/base/zaxpy/lib/zaxpy.js | 12 +--- 6 files changed, 25 insertions(+), 173 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/README.md b/lib/node_modules/@stdlib/blas/base/zaxpy/README.md index a1dafcfe789c..5f3821466909 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/README.md +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/README.md @@ -37,23 +37,13 @@ Scales values from `zx` by `za` and adds the result to `zy`. ```javascript 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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var za = new Complex128( 2.0, 2.0 ); zaxpy( 3, za, zx, 1, zy, 1 ); - -var z = zy.get( 0 ); -// returns - -var re = real( z ); -// returns -1.0 - -var im = imag( z ); -// returns 7.0 +// zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] ``` The function has the following parameters: @@ -70,23 +60,13 @@ The `N` and stride parameters determine how values from `zx` are scaled by `za` ```javascript 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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var za = new Complex128( 2.0, 2.0 ); zaxpy( 2, za, zx, 2, zy, 2 ); - -var z = zy.get( 0 ); -// returns - -var re = real( z ); -// returns -1.0 - -var im = imag( z ); -// returns 7.0 +// zy => [ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ] ``` 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 [ ```javascript 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' ); // Initial arrays... var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); @@ -112,15 +90,7 @@ var zy1 = new Complex128Array( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 ); // start a // Scales values of `zx0` by `za` starting from second index and add the result to `zy0` starting from third index... zaxpy( 2, za, zx1, 1, zy1, 1 ); - -var z = zy0.get( 2 ); -// returns - -var re = real( z ); -// returns -1.0 - -var im = imag( z ); -// returns 15.0 +// zy0 => [ 1.0, 1.0, 1.0, 1.0, -1.0, 15.0, -1.0, 23.0 ] ``` #### zaxpy.ndarray( N, za, zx, strideX, offsetX, zy, strideY, offsetY ) @@ -130,23 +100,13 @@ Scales values from `zx` by `za` and adds the result to `zy` using alternative in ```javascript 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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var za = new Complex128( 2.0, 2.0 ); zaxpy.ndarray( 3, za, zx, 1, 0, zy, 1, 0 ); - -var z = zy.get( 0 ); -// returns - -var re = real( z ); -// returns -1.0 - -var im = imag( z ); -// returns 7.0 +// zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] ``` 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 ```javascript 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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var za = new Complex128( 2.0, 2.0 ); zaxpy.ndarray( 3, za, zx, 1, 1, zy, 1, 1 ); - -var z = zy.get( 3 ); -// returns - -var re = real( z ); -// returns -1.0 - -var im = imag( z ); -// returns 31.0 +// zy => [ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ] ``` diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/zaxpy/docs/repl.txt index b1eec343f1ad..1d1f9b412990 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/docs/repl.txt @@ -43,34 +43,24 @@ > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] ); > var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 ); - > {{alias}}( 2, za, zx, 1, zy, 1 ); - > var z = zy.get( 0 ); - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 7.0 + > {{alias}}( 2, za, zx, 1, zy, 1 ) + [ -1.0, 7.0, -1.0, 15.0 ] // Advanced indexing: > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); - > {{alias}}( 2, za, zx, -2, zy, 1 ); - > z = zy.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 23.0 + > {{alias}}( 2, za, zx, -2, zy, 1 ) + [ -1.0, 23.0, -1.0, 7.0, 1.0, 1.0 ] // Using typed array views: > var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var zy0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] ); > var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); > var zy1 = new {{alias:@stdlib/array/complex128}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*1 ); - > {{alias}}( 1, za, zx1, 1, zy1, 1 ); - > z = zy0.get( 1 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 15.0 + > {{alias}}( 1, za, zx1, 1, zy1, 1 ) + [ -1.0, 15.0 ] + > zy0 + [ 1.0, 1.0, -1.0, 15.0 ] {{alias}}.ndarray( N, za, zx, strideX, offsetX, zy, strideY, offsetY ) @@ -120,22 +110,14 @@ > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] ); > var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 ); - > {{alias}}.ndarray( zx.length, za, zx, 1, 0, zy, 1, 0 ); - > var z = zy.get( 0 ); - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 7.0 + > {{alias}}.ndarray( zx.length, za, zx, 1, 0, zy, 1, 0 ) + [ -1.0, 7.0, -1.0, 15.0 ] // Advanced indexing: > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); - > {{alias}}.ndarray( 2, za, zx, 1, 1, zy, 1, 1 ); - > z = zy.get( 2 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 23.0 + > {{alias}}.ndarray( 2, za, zx, 1, 1, zy, 1, 1 ) + [ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/zaxpy/docs/types/index.d.ts index ca85fb5d6198..9ea53af4357a 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/docs/types/index.d.ts @@ -41,23 +41,13 @@ interface Routine { * @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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy( zx.length, za, zx, 1, zy, 1 ); - * - * var z = zy.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns -1.0 - * - * var im = imag( z ); - * // returns 7.0 + * // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] */ ( N: number, za: Complex128, zx: Complex128Array, strideX: number, zy: Complex128Array, strideY: number ): Complex128Array; @@ -77,23 +67,13 @@ interface Routine { * @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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy.ndarray( zx.length, za, zx, 1, 0, zy, 1, 0 ); - * - * var z = zy.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns -1.0 - * - * var im = imag( z ); - * // returns 7.0 + * // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] */ ndarray( N: number, za: Complex128, zx: Complex128Array, strideX: number, offsetX: number, zy: Complex128Array, strideY: number, offsetY: number ): Complex128Array; } @@ -112,44 +92,24 @@ interface Routine { * @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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy( 2, za, zx, 2, zy, 2 ); -* -* var z = zy.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 7.0 +* // zy => [ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy.ndarray( 3, za, zx, 1, 1, zy, 1, 1 ); -* -* var z = zy.get( 3 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 31.0 +* // zy => [ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ] */ declare var zaxpy: Routine; diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/index.js b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/index.js index c9dec1910e30..f22e2a5ff337 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/index.js @@ -26,8 +26,6 @@ * @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 zaxpy = require( '@stdlib/blas/base/zaxpy' ); * * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); @@ -35,21 +33,11 @@ * var za = new Complex128( 2.0, 2.0 ); * * zaxpy( 3, za, zx, 1, zy, 1 ); -* -* var z = zy.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 7.0 +* // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.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 zaxpy = require( '@stdlib/blas/base/zaxpy' ); * * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); @@ -57,15 +45,7 @@ * var za = new Complex128( 2.0, 2.0 ); * * zaxpy.ndarray( 3, za, zx, 1, 0, zy, 1, 0 ); -* -* var z = zy.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 7.0 +* // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js index 1ba8973ea40e..cd7ac3d72994 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js @@ -45,23 +45,13 @@ var dcabs1 = require( '@stdlib/blas/base/dcabs1' ); * @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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy( 3, za, zx, 1, 0, zy, 1, 0 ); -* -* var z = zy.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 7.0 +* // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] */ function zaxpy( N, za, zx, strideX, offsetX, zy, strideY, offsetY ) { var viewX; diff --git a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.js b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.js index 62b51107cb4e..8442298cc800 100644 --- a/lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.js +++ b/lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.js @@ -40,23 +40,13 @@ var ndarray = require( './ndarray.js' ); * @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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zaxpy( 3, za, zx, 1, zy, 1 ); -* -* var z = zy.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns -1.0 -* -* var im = imag( z ); -* // returns 7.0 +* // zy => [ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ] */ function zaxpy( N, za, zx, strideX, zy, strideY ) { var ix = stride2offset( N, strideX );