Skip to content

docs: improve doctests for complex number instances in lapack/base/zlacpy #8776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Dec 5, 2025
Merged

docs: improve doctests for complex number instances in lapack/base/zlacpy #8776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 4 additions & 36 deletions lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,14 @@ 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 );
*
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*/
( order: Layout, uplo: string, M: number, N: number, A: Complex128Array, LDA: number, B: Complex128Array, LDB: number ): Complex128Array;

Expand All @@ -79,22 +71,14 @@ 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 );
*
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 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;
}
Expand All @@ -114,41 +98,25 @@ 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 );
*
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 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 );
*
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/
declare var zlacpy: Routine;

Expand Down
102 changes: 12 additions & 90 deletions lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,54 +444,26 @@ 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 );
*
* zlacpy( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*
* z = B.get( 1 );
* // returns <Complex128>
*
* v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = B.get( 2 );
* // returns <Complex128>
*
* v = real( z );
* // returns 5.0
*
* v = imag( z );
* // returns 6.0
* // returns <Complex128>[ 5.0, 6.0 ]
*
* z = B.get( 3 );
* // returns <Complex128>
*
* v = real( z );
* // returns 7.0
*
* v = imag( z );
* // returns 8.0
* // returns <Complex128>[ 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 );
Expand All @@ -500,86 +472,36 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2,
* // B => <Complex128Array>
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*
* z = B.get( 1 );
* // returns <Complex128>
*
* v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = B.get( 2 );
* // returns <Complex128>
*
* v = real( z );
* // returns 0.0
*
* v = imag( z );
* // returns 0.0
* // returns <Complex128>[ 0.0, 0.0 ]
*
* z = B.get( 3 );
* // returns <Complex128>
*
* v = real( z );
* // returns 7.0
*
* v = imag( z );
* // returns 8.0
* // returns <Complex128>[ 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 );
*
* zlacpy( 'lower', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*
* z = B.get( 1 );
* // returns <Complex128>
*
* v = real( z );
* // returns 0.0
*
* v = imag( z );
* // returns 0.0
* // returns <Complex128>[ 0.0, 0.0 ]
*
* z = B.get( 2 );
* // returns <Complex128>
*
* v = real( z );
* // returns 5.0
*
* v = imag( z );
* // returns 6.0
* // returns <Complex128>[ 5.0, 6.0 ]
*
* z = B.get( 3 );
* // returns <Complex128>
*
* v = real( z );
* // returns 7.0
*
* v = imag( z );
* // returns 8.0
* // returns <Complex128>[ 7.0, 8.0 ]
*/
function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) {
var viewA;
Expand Down
18 changes: 2 additions & 16 deletions lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,10 @@
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
*
* var z = B.get( 0 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 1.0
*
* v = imag( z );
* // returns 2.0
* // returns <Complex128>[ 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 ] );
Expand All @@ -55,13 +47,7 @@
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/

// MODULES //
Expand Down
46 changes: 5 additions & 41 deletions lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,78 +43,42 @@ 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 );
*
* zlacpy( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 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 );
*
* zlacpy( 'upper', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = B.get( 4 );
* // returns <Complex128>
*
* v = real( z );
* // returns 0.0
*
* v = imag( z );
* // returns 0.0
* // returns <Complex128>[ 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 );
*
* zlacpy( 'lower', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
*
* var z = B.get( 2 );
* // returns <Complex128>
*
* var v = real( z );
* // returns 3.0
*
* v = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = B.get( 1 );
* // returns <Complex128>
*
* v = real( z );
* // returns 0.0
*
* v = imag( z );
* // returns 0.0
* // returns <Complex128>[ 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
Expand Down
Loading