From f4a4f8e6950727055098a2d660a230a971842ee6 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sat, 15 Feb 2025 21:11:30 +0000 Subject: [PATCH] docs: update examples for blas/base/zscal --- 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: na - 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/zscal/README.md | 62 ++----------------- .../@stdlib/blas/base/zscal/docs/repl.txt | 42 ++++--------- .../blas/base/zscal/docs/types/index.d.ts | 48 ++------------ 3 files changed, 22 insertions(+), 130 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/zscal/README.md b/lib/node_modules/@stdlib/blas/base/zscal/README.md index 79e88ad10d34..eb70f3fbf13e 100644 --- a/lib/node_modules/@stdlib/blas/base/zscal/README.md +++ b/lib/node_modules/@stdlib/blas/base/zscal/README.md @@ -37,28 +37,18 @@ Scales values from `zx` 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, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var za = new Complex128( 2.0, 0.0 ); zscal( 3, za, zx, 1 ); - -var z = zx.get( 0 ); -// returns - -var re = real( z ); -// returns 2.0 - -var im = imag( z ); -// returns 2.0 +// zx => [ 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. -- **za**: scalar [`Complex128`][@stdlib/complex/float64/ctor] constant. +- **za**: scalar [`Complex128`][@stdlib/complex/float64/ctor] constant. - **zx**: input [`Complex128Array`][@stdlib/array/complex128]. - **strideX**: index increment for `zx`. @@ -67,22 +57,12 @@ 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 za = new Complex128( 2.0, 0.0 ); zscal( 2, za, zx, 2 ); - -var z = zx.get( 2 ); -// returns - -var re = real( z ); -// returns 10.0 - -var im = imag( z ); -// returns 12.0 +// zx => [ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0, 7.0, 8.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. @@ -92,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 Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); // Initial array: var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); @@ -106,15 +84,7 @@ var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start a // Scales every other value from `zx1` by `za`... zscal( 3, za, zx1, 1 ); - -var z = zx0.get( 1 ); -// returns - -var re = real( z ); -// returns -2.0 - -var im = imag( z ); -// returns 14.0 +// zx0 => [ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ] ``` #### zscal.ndarray( N, za, zx, strideX, offsetX ) @@ -124,22 +94,12 @@ Scales values from `zx` by `za` using alternative indexing semantics. ```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 za = new Complex128( 2.0, 2.0 ); zscal.ndarray( 3, za, zx, 1, 0 ); - -var z = zx.get( 0 ); -// returns - -var re = real( z ); -// returns -2.0 - -var im = imag( z ); -// returns 6.0 +// zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] ``` The function has the following additional parameters: @@ -151,22 +111,12 @@ 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 za = new Complex128( 2.0, 2.0 ); zscal.ndarray( 2, za, zx, 2, 1 ); - -var z = zx.get( 3 ); -// returns - -var re = real( z ); -// returns -2.0 - -var im = imag( z ); -// returns 30.0 +// zx => [ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ] ``` diff --git a/lib/node_modules/@stdlib/blas/base/zscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/zscal/docs/repl.txt index b8d985781ef5..8bac937e8183 100644 --- a/lib/node_modules/@stdlib/blas/base/zscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/zscal/docs/repl.txt @@ -37,33 +37,23 @@ // Standard usage: > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var za = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 ); - > {{alias}}( 2, za, zx, 1 ); - > var z = zx.get( 0 ); - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - -3.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 4.0 + > {{alias}}( 2, za, zx, 1 ) + [ -3.0, 4.0, -5.0, 10.0 ] // Advanced indexing: > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > za = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 1.0 ); - > {{alias}}( 2, za, zx, 2 ); - > z = zx.get( 0 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -1.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 3.0 + > {{alias}}( 2, za, zx, 2 ) + [ -1.0, 3.0, 3.0, 4.0, -1.0, 11.0 ] // Using typed array views: > var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); > var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 ); - > {{alias}}( 2, za, zx1, 1 ); - > z = zx0.get( 1 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -2.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 14.0 + > {{alias}}( 2, za, zx1, 1 ) + [ -2.0, 14.0, -2.0, 22.0 ] + > zx0 + [ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0 ] {{alias}}.ndarray( N, za, zx, strideX, offsetX ) @@ -102,22 +92,14 @@ // Standard usage: > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 ); - > {{alias}}.ndarray( 2, za, zx, 1, 0 ); - > var z = zx.get( 0 ); - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - -2.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 6.0 + > {{alias}}.ndarray( 2, za, zx, 1, 0 ) + [ -2.0, 6.0, -2.0, 14.0 ] // Advanced indexing: > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); > za = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 ); - > {{alias}}.ndarray( 2, za, zx, 1, 2 ); - > z = zx.get( 2 ); - > re = {{alias:@stdlib/complex/float64/real}}( z ) - -7.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 16.0 + > {{alias}}.ndarray( 2, za, zx, 1, 2 ) + [ 1.0, 2.0, 3.0, 4.0, -7.0, 16.0, -9.0, 22.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/zscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/zscal/docs/types/index.d.ts index 4f6619bcb0ef..c0d469193fa3 100644 --- a/lib/node_modules/@stdlib/blas/base/zscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/zscal/docs/types/index.d.ts @@ -39,22 +39,12 @@ 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 za = new Complex128( 2.0, 2.0 ); * * zscal( 3, za, zx, 1 ); - * - * var z = zx.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns -2.0 - * - * var im = imag( z ); - * // returns 6.0 + * // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] */ ( N: number, za: Complex128, zx: Complex128Array, strideX: number ): Complex128Array; @@ -71,22 +61,12 @@ 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 za = new Complex128( 2.0, 2.0 ); * * zscal.ndarray( 3, za, zx, 1, 0 ); - * - * var z = zx.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns -2.0 - * - * var im = imag( z ); - * // returns 6.0 + * // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] */ ndarray( N: number, za: Complex128, zx: Complex128Array, strideX: number, offsetX: number ): Complex128Array; } @@ -103,42 +83,22 @@ 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 za = new Complex128( 2.0, 2.0 ); * * zscal( 3, za, zx, 1 ); -* -* var z = zx.get( 1 ); -* // returns -* -* var re = real( z ); -* // returns -2.0 -* -* var im = imag( z ); -* // returns 14.0 +* // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.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 ] ); * var za = new Complex128( 2.0, 2.0 ); * * zscal.ndarray( 2, za, zx, 1, 1 ); -* -* var z = zx.get( 1 ); -* // returns -* -* var re = real( z ); -* // returns -2.0 -* -* var im = imag( z ); -* // returns 14.0 +* // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] */ declare var zscal: Routine;