From be0fa67f1b13e4bf52d34b0700351de5874bddbe Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sat, 9 May 2026 12:36:21 -0700 Subject: [PATCH] docs: improve doctests for complex number typed arrays in `lapack/base/crot` --- 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: passed - task: lint_license_headers status: passed --- --- .../@stdlib/lapack/base/crot/README.md | 40 +++++------------ .../@stdlib/lapack/base/crot/docs/repl.txt | 45 +++++++++---------- .../lapack/base/crot/docs/types/index.d.ts | 32 ++++--------- .../@stdlib/lapack/base/crot/lib/crot.js | 8 +--- .../@stdlib/lapack/base/crot/lib/index.js | 16 ++----- .../@stdlib/lapack/base/crot/lib/ndarray.js | 8 +--- 6 files changed, 46 insertions(+), 103 deletions(-) diff --git a/lib/node_modules/@stdlib/lapack/base/crot/README.md b/lib/node_modules/@stdlib/lapack/base/crot/README.md index ed52f3b7d737..727ce2d0c933 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/README.md +++ b/lib/node_modules/@stdlib/lapack/base/crot/README.md @@ -43,12 +43,8 @@ var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); var s = new Complex64( 0.0, 0.75 ); crot( cx.length, cx, 1, cy, 1, 1.25, s ); - -var z = cy.get( 0 ); -// returns [ ~-1.5, ~0.75 ] - -z = cx.get( 0 ); -// returns [ ~1.25, ~2.5 ] +// cy => [ ~-1.5, ~0.75, ~-3.0, ~2.25, ~-4.5, ~3.75, ~-6.0, ~5.25 ] +// cx => [ ~1.25, ~2.5, ~3.75, ~5.0, ~6.25, ~7.5, ~8.75, ~10.0 ] ``` The function has the following parameters: @@ -70,12 +66,8 @@ var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); var s = new Complex64( 0.0, 0.75 ); crot( 2, cx, 2, cy, 2, 1.25, s ); - -var z = cy.get( 0 ); -// returns [ ~-1.5, ~0.75 ] - -z = cx.get( 0 ); -// returns [ ~1.25, ~2.5 ] +// cy => [ ~-1.5, ~0.75, 0.0, 0.0, ~-4.5, ~3.75, 0.0, 0.0 ] +// cx => [ ~1.25, ~2.5, 3.0, 4.0, ~6.25, ~7.5, 7.0, 8.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. @@ -97,12 +89,8 @@ var cy1 = new Complex64Array( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); // start at var s = new Complex64( 0.0, 0.75 ); crot( 2, cx1, -2, cy1, 1, 1.25, s ); - -var z = cy0.get( 2 ); -// returns [ ~-6.0, ~5.25 ] - -z = cx0.get( 3 ); -// returns [ ~8.75, ~10.0 ] +// cy0 => [ 0.0, 0.0, 0.0, 0.0, ~-6.0, ~5.25, ~-3.0, ~2.25 ] +// cx0 => [ 1.0, 2.0, ~3.75, ~5.0, 5.0, 6.0, ~8.75, ~10.0 ] ``` #### crot.ndarray( N, cx, strideCX, offsetCX, cy, strideCY, offsetCY, c, s ) @@ -118,12 +106,8 @@ var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); var s = new Complex64( 0.0, 0.75 ); crot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 1.25, s ); - -var z = cy.get( 0 ); -// returns [ ~-1.5, ~0.75 ] - -z = cx.get( 0 ); -// returns [ ~1.25, ~2.5 ] +// cy => [ ~-1.5, ~0.75, ~-3.0, ~2.25, ~-4.5, ~3.75 ] +// cx => [ ~1.25, ~2.5, ~3.75, ~5.0, ~6.25, ~7.5 ] ``` The function has the following additional parameters: @@ -142,12 +126,8 @@ var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); var s = new Complex64( 0.0, 0.75 ); crot.ndarray( 2, cx, 2, 1, cy, 2, 1, 1.25, s ); - -var z = cy.get( 3 ); -// returns [ ~-6.0, ~5.25 ] - -z = cx.get( 1 ); -// returns [ ~3.75, ~5.0 ] +// cy => [ 0.0, 0.0, ~-3.0, ~2.25, 0.0, 0.0, ~-6.0, ~5.25 ] +// cx => [ 1.0, 2.0, ~3.75, ~5.0, 5.0, 6.0, ~8.75, ~10.0 ] ``` diff --git a/lib/node_modules/@stdlib/lapack/base/crot/docs/repl.txt b/lib/node_modules/@stdlib/lapack/base/crot/docs/repl.txt index 5979452b4448..d61df1bf072d 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/docs/repl.txt +++ b/lib/node_modules/@stdlib/lapack/base/crot/docs/repl.txt @@ -44,21 +44,19 @@ > var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] ); > var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 ); - > {{alias}}( cx.length, cx, 1, cy, 1, 0.8, s ); - > var z = cy.get( 0 ) - [ ~-1.1, ~-0.2 ] - > z = cx.get( 0 ) - [ ~0.8, ~1.6 ] + > {{alias}}( cx.length, cx, 1, cy, 1, 0.8, s ) + [ ~-1.1, ~-0.2, ~-2.5, ~0.0 ] + > cx + [ ~0.8, ~1.6, ~2.4, ~3.2 ] // Advanced indexing: > cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); > cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); > var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 ); - > {{alias}}( 2, cx, -2, cy, 1, 0.8, s ); - > z = cy.get( 0 ) - [ ~-3.9, ~0.2 ] - > z = cx.get( 2 ) - [ ~4.0, ~4.8 ] + > {{alias}}( 2, cx, -2, cy, 1, 0.8, s ) + [ ~-3.9, ~0.2, ~-1.1, ~-0.2, 0.0, 0.0, 0.0, 0.0 ] + > cx + [ ~0.8, ~1.6, 3.0, 4.0, ~4.0, ~4.8, 7.0, 8.0 ] // Using typed array views: > var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); @@ -66,11 +64,10 @@ > var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); > var cy1 = new {{alias:@stdlib/array/complex64}}( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); > var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 ); - > {{alias}}( 1, cx1, 1, cy1, 1, 0.8, s ); - > z = cy0.get( 2 ) - [ ~-2.5, 0.0 ] - > z = cx0.get( 1 ) - [ ~2.4, ~3.2 ] + > {{alias}}( 1, cx1, 1, cy1, 1, 0.8, s ) + [ ~-2.5, ~0.0 ] + > cx0 + [ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ] {{alias}}.ndarray( N, cx, strideCX, offsetCX, cy, strideCY, offsetCY, c, s ) @@ -121,21 +118,19 @@ > var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] ); > var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 ); - > {{alias}}.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s ); - > var z = cy.get( 0 ) - [ ~-1.1, ~-0.2 ] - > z = cx.get( 0 ) - [ ~0.8, ~1.6 ] + > {{alias}}.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s ) + [ ~-1.1, ~-0.2, ~-2.5, ~0.0 ] + > cx + [ ~0.8, ~1.6, ~2.4, ~3.2 ] // Advanced indexing: > cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); > var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 ); - > {{alias}}.ndarray( 1, cx, 2, 1, cy, 2, 1, 0.8, s ); - > z = cy.get( 1 ) - [ ~-2.5, 0.0 ] - > z = cx.get( 1 ) - [ ~2.4, ~3.2 ] + > {{alias}}.ndarray( 1, cx, 2, 1, cy, 2, 1, 0.8, s ) + [ 0.0, 0.0, ~-2.5, ~0.0, 0.0, 0.0 ] + > cx + [ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts index db3936f44300..0efba87af525 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts @@ -48,12 +48,8 @@ interface Routine { * var s = new Complex64( 0.3, 0.4 ); * * crot( cx.length, cx, 1, cy, 1, 0.8, s ); - * - * var z = cy.get( 0 ); - * // returns [ ~-1.1, ~-0.2 ] - * - * z = cx.get( 0 ); - * // returns [ ~0.8, ~1.6 ] + * // cy => [ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ] + * // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] */ ( N: number, cx: Complex64Array, strideCX: number, cy: Complex64Array, strideCY: number, c: number, s: Complex64 ): Complex64Array; @@ -80,12 +76,8 @@ interface Routine { * var s = new Complex64( 0.3, 0.4 ); * * crot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s ); - * - * var z = cy.get( 0 ); - * // returns [ ~-1.1, ~-0.2 ] - * - * z = cx.get( 0 ); - * // returns [ ~0.8, ~1.6 ] + * // cy => [ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ] + * // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] */ ndarray( N: number, cx: Complex64Array, strideCX: number, offsetCX: number, cy: Complex64Array, strideCY: number, offsetCY: number, c: number, s: Complex64 ): Complex64Array; } @@ -111,12 +103,8 @@ interface Routine { * var s = new Complex64( 0.3, 0.4 ); * * crot( 2, cx, 2, cy, 1, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-1.1, ~-0.2 ] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-1.1, ~-0.2, ~-3.9, ~0.2, 0.0, 0.0, 0.0, 0.0 ] +* // cx => [ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ] * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); @@ -127,12 +115,8 @@ interface Routine { * var s = new Complex64( 0.3, 0.4 ); * * crot.ndarray( 2, cx, 2, 0, cy, 1, 0, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-1.1, ~-0.2 ] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-1.1, ~-0.2, ~-3.9, ~0.2, 0.0, 0.0, 0.0, 0.0 ] +* // cx => [ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ] */ declare var crot: Routine; diff --git a/lib/node_modules/@stdlib/lapack/base/crot/lib/crot.js b/lib/node_modules/@stdlib/lapack/base/crot/lib/crot.js index c922376c8776..81b9e6aae3d4 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/lib/crot.js +++ b/lib/node_modules/@stdlib/lapack/base/crot/lib/crot.js @@ -47,12 +47,8 @@ var ndarray = require( './ndarray.js' ); * var s = new Complex64( 0.3, 0.4 ); * * crot( cx.length, cx, 1, cy, 1, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-1.1, ~-0.2 ] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ] +* // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] */ function crot( N, cx, strideCX, cy, strideCY, c, s ) { var ix = stride2offset( N, strideCX ); diff --git a/lib/node_modules/@stdlib/lapack/base/crot/lib/index.js b/lib/node_modules/@stdlib/lapack/base/crot/lib/index.js index c6c26f68e261..8933e24562fa 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/lib/index.js +++ b/lib/node_modules/@stdlib/lapack/base/crot/lib/index.js @@ -33,12 +33,8 @@ * var s = new Complex64( 0.6, 0 ); * * crot( cx.length, cx, 1, cy, 1, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-0.6, ~-1.2] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-0.6, ~-1.2, ~-1.8, ~-2.4, ~-3.0, ~-3.6, ~-4.2, ~-4.8 ] +* // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); @@ -50,12 +46,8 @@ * var s = new Complex64( 0.6, 0 ); * * crot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-0.6, ~-1.2 ] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-0.6, ~-1.2, ~-1.8, ~-2.4, ~-3.0, ~-3.6, ~-4.2, ~-4.8 ] +* // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/lapack/base/crot/lib/ndarray.js b/lib/node_modules/@stdlib/lapack/base/crot/lib/ndarray.js index de195d4b1d46..b93b00a917d8 100644 --- a/lib/node_modules/@stdlib/lapack/base/crot/lib/ndarray.js +++ b/lib/node_modules/@stdlib/lapack/base/crot/lib/ndarray.js @@ -51,12 +51,8 @@ var imagf = require( '@stdlib/complex/float32/imag' ); * var s = new Complex64( 0.3, 0.4 ); * * crot( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s ); -* -* var z = cy.get( 0 ); -* // returns [ ~-1.1, ~-0.2 ] -* -* z = cx.get( 0 ); -* // returns [ ~0.8, ~1.6 ] +* // cy => [ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ] +* // cx => [ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ] */ function crot( N, cx, strideCX, offsetCX, cy, strideCY, offsetCY, c, s ) { var viewX;