From b57994232661334ed642c1b35c90f7017301ea62 Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Thu, 4 Dec 2025 16:42:02 +0530 Subject: [PATCH] docs: improve doctests for complex number instances in lapack/base/zlacpy --- 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: passed - task: lint_license_headers status: passed --- --- .../lapack/base/zlacpy/docs/types/index.d.ts | 40 +------ .../@stdlib/lapack/base/zlacpy/lib/base.js | 102 +++--------------- .../@stdlib/lapack/base/zlacpy/lib/index.js | 18 +--- .../@stdlib/lapack/base/zlacpy/lib/ndarray.js | 46 +------- .../@stdlib/lapack/base/zlacpy/lib/zlacpy.js | 46 +------- 5 files changed, 28 insertions(+), 224 deletions(-) diff --git a/lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/index.d.ts index 44091c88601d..e7c58217d272 100644 --- a/lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/index.d.ts @@ -42,8 +42,6 @@ interface Routine { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -51,13 +49,7 @@ interface Routine { * zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); - * // returns - * - * var v = real( z ); - * // returns 1.0 - * - * v = imag( z ); - * // returns 2.0 + * // returns [ 1.0, 2.0 ] */ ( order: Layout, uplo: string, M: number, N: number, A: Complex128Array, LDA: number, B: Complex128Array, LDB: number ): Complex128Array; @@ -79,8 +71,6 @@ interface Routine { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); * var B = new Complex128Array( 12 ); @@ -88,13 +78,7 @@ interface Routine { * zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); - * // returns - * - * var v = real( z ); - * // returns 3.0 - * - * v = imag( z ); - * // returns 4.0 + * // returns [ 3.0, 4.0 ] */ ndarray( uplo: string, M: number, N: number, A: Complex128Array, strideA1: number, strideA2: number, offsetA: number, B: Complex128Array, strideB1: number, strideB2: number, offsetB: number ): Complex128Array; } @@ -114,8 +98,6 @@ interface Routine { * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var B = new Complex128Array( 4 ); @@ -123,18 +105,10 @@ interface Routine { * zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 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 A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); * var B = new Complex128Array( 12 ); @@ -142,13 +116,7 @@ interface Routine { * zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); -* // returns -* -* var v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ declare var zlacpy: Routine; diff --git a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js index d974bdeaa162..f61b67621019 100644 --- a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js +++ b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js @@ -444,8 +444,6 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -453,45 +451,19 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, * zlacpy( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 1.0, 2.0 ] * * z = B.get( 1 ); -* // returns -* -* v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] * * z = B.get( 2 ); -* // returns -* -* v = real( z ); -* // returns 5.0 -* -* v = imag( z ); -* // returns 6.0 +* // returns [ 5.0, 6.0 ] * * z = B.get( 3 ); -* // returns -* -* v = real( z ); -* // returns 7.0 -* -* v = imag( z ); -* // returns 8.0 +* // returns [ 7.0, 8.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -500,45 +472,19 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, * // B => * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 1.0, 2.0 ] * * z = B.get( 1 ); -* // returns -* -* v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] * * z = B.get( 2 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * z = B.get( 3 ); -* // returns -* -* v = real( z ); -* // returns 7.0 -* -* v = imag( z ); -* // returns 8.0 +* // returns [ 7.0, 8.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -546,40 +492,16 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, * zlacpy( 'lower', 2, 2, A, 2, 1, 0, B, 2, 1, 0 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 1.0, 2.0 ] * * z = B.get( 1 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * z = B.get( 2 ); -* // returns -* -* v = real( z ); -* // returns 5.0 -* -* v = imag( z ); -* // returns 6.0 +* // returns [ 5.0, 6.0 ] * * z = B.get( 3 ); -* // returns -* -* v = real( z ); -* // returns 7.0 -* -* v = imag( z ); -* // returns 8.0 +* // returns [ 7.0, 8.0 ] */ function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) { var viewA; diff --git a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js index 1b4e0a1b3328..df3a9c208076 100644 --- a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js +++ b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js @@ -35,18 +35,10 @@ * zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 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 zlacpy = require( '@stdlib/lapack/base/zlacpy' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); @@ -55,13 +47,7 @@ * zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); -* // returns -* -* var v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js index c0336a8f34bb..cbad74bd7ec4 100644 --- a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js +++ b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js @@ -43,8 +43,6 @@ var base = require( './base.js' ); * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); * var B = new Complex128Array( 12 ); @@ -52,18 +50,10 @@ var base = require( './base.js' ); * zlacpy( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); -* // returns -* -* var v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); * var B = new Complex128Array( 12 ); @@ -71,27 +61,13 @@ var base = require( './base.js' ); * zlacpy( 'upper', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); -* // returns -* -* var v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] * * z = B.get( 4 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); * var B = new Complex128Array( 12 ); @@ -99,22 +75,10 @@ var base = require( './base.js' ); * zlacpy( 'lower', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); * * var z = B.get( 2 ); -* // returns -* -* var v = real( z ); -* // returns 3.0 -* -* v = imag( z ); -* // returns 4.0 +* // returns [ 3.0, 4.0 ] * * z = B.get( 1 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] */ function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) { // eslint-disable-line max-len, max-params return base( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ); // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/zlacpy.js b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/zlacpy.js index 99bfbe35da06..45fafea25482 100644 --- a/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/zlacpy.js +++ b/lib/node_modules/@stdlib/lapack/base/zlacpy/lib/zlacpy.js @@ -46,8 +46,6 @@ var base = require( './base.js' ); * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -55,18 +53,10 @@ var base = require( './base.js' ); * zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 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 A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -74,27 +64,13 @@ var base = require( './base.js' ); * zlacpy( 'row-major', 'upper', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 1.0, 2.0 ] * * z = B.get( 2 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); * var B = new Complex128Array( 4 ); @@ -102,22 +78,10 @@ var base = require( './base.js' ); * zlacpy( 'row-major', 'lower', 2, 2, A, 2, B, 2 ); * * var z = B.get( 0 ); -* // returns -* -* var v = real( z ); -* // returns 1.0 -* -* v = imag( z ); -* // returns 2.0 +* // returns [ 1.0, 2.0 ] * * z = B.get( 1 ); -* // returns -* -* v = real( z ); -* // returns 0.0 -* -* v = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] */ function zlacpy( order, uplo, M, N, A, LDA, B, LDB ) { var sa1;