Skip to content

docs: improve doctests for complex number instances in lapack/base/zlaset #8753

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 4, 2025
Merged

docs: improve doctests for complex number instances in lapack/base/zlaset #8753

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
64 changes: 7 additions & 57 deletions lib/node_modules/@stdlib/lapack/base/zlaset/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ Sets the off-diagonal elements and the diagonal elements of a double-precision c
```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 A = new Complex128Array( 4 );

Expand All @@ -48,22 +46,10 @@ var beta = new Complex128( 3.0, 4.0 );
zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );

var z = A.get( 0 );
// returns <Complex128>

var re = real( z );
// returns 3.0

var im = imag( z );
// returns 4.0
// returns <Complex128>[ 3.0, 4.0 ]

z = A.get( 1 );
// returns <Complex128>

re = real( z );
// returns 1.0

im = imag( z );
// returns 2.0
// returns <Complex128>[ 1.0, 2.0 ]
```

The function has the following parameters:
Expand All @@ -84,8 +70,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 A0 = new Complex128Array( 5 );
Expand All @@ -99,13 +83,7 @@ var beta = new Complex128( 3.0, 4.0 );
zlaset( 'row-major', 'all', 2, 2, alpha, beta, A1, 2 );

var z = A0.get( 1 );
// returns <Complex128>

var re = real( z );
// returns 3.0

var im = imag( z );
// returns 4.0
// returns <Complex128>[ 3.0, 4.0 ]
```

#### zlaset.ndarray( uplo, M, N, alpha, beta, A, sa1, sa2, oa )
Expand All @@ -115,8 +93,6 @@ Sets the off-diagonal elements and the diagonal elements of a double-precision c
```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 A = new Complex128Array( 4 );

Expand All @@ -126,22 +102,10 @@ var beta = new Complex128( 3.0, 4.0 );
zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );

var z = A.get( 0 );
// returns <Complex128>

var re = real( z );
// returns 3.0

var im = imag( z );
// returns 4.0
// returns <Complex128>[ 3.0, 4.0 ]

z = A.get( 1 );
// returns <Complex128>

re = real( z );
// returns 1.0

im = imag( z );
// returns 2.0
// returns <Complex128>[ 1.0, 2.0 ]
```

The function has the following parameters:
Expand All @@ -161,8 +125,6 @@ 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 A = new Complex128Array( 5 );

Expand All @@ -172,22 +134,10 @@ var beta = new Complex128( 3.0, 4.0 );
zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );

var z = A.get( 0 );
// returns <Complex128>

var re = real( z );
// returns 0.0

var im = imag( z );
// returns 0.0
// returns <Complex128>[ 0.0, 0.0 ]

z = A.get( 1 );
// returns <Complex128>

re = real( z );
// returns 3.0

im = imag( z );
// returns 4.0
// returns <Complex128>[ 3.0, 4.0 ]
```

</section>
Expand Down
14 changes: 4 additions & 10 deletions lib/node_modules/@stdlib/lapack/base/zlaset/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,8 @@
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 );
> var beta = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 4.0 );
> {{alias}}( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
> var z = A.get( 0 );
> {{alias:@stdlib/complex/float64/real}}( z )
3.0
> {{alias:@stdlib/complex/float64/imag}}( z )
4.0
> var z = A.get( 0 )
<Complex128>[ 3.0, 4.0 ]


{{alias}}.ndarray( uplo, M, N, alpha, beta, A, sa1, sa2, oa )
Expand Down Expand Up @@ -103,11 +100,8 @@
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 );
> var beta = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 4.0 );
> {{alias}}.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
> var z = A.get( 1 );
> {{alias:@stdlib/complex/float64/real}}( z )
3.0
> {{alias:@stdlib/complex/float64/imag}}( z )
4.0
> var z = A.get( 1 )
<Complex128>[ 3.0, 4.0 ]

See Also
--------
78 changes: 9 additions & 69 deletions lib/node_modules/@stdlib/lapack/base/zlaset/lib/base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,8 +475,6 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* @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 A = new Complex128Array( 4 );
*
Expand All @@ -486,37 +484,17 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* zlaset( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 3.0
*
* var im = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex128>
*
* re = real( z );
* // returns 1.0
*
* im = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex128>
*
* re = real( z );
* // returns 1.0
*
* im = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.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 A = new Complex128Array( 4 );
*
Expand All @@ -526,37 +504,17 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* zlaset( 'upper', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 3.0
*
* var im = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex128>
*
* re = real( z );
* // returns 1.0
*
* im = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex128>
*
* re = real( z );
* // returns 0.0
*
* im = imag( z );
* // returns 0.0
* // returns <Complex128>[ 0.0, 0.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 A = new Complex128Array( 4 );
*
Expand All @@ -566,31 +524,13 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* zlaset( 'lower', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 3.0
*
* var im = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex128>
*
* re = real( z );
* // returns 0.0
*
* im = imag( z );
* // returns 0.0
* // returns <Complex128>[ 0.0, 0.0 ]
*
* z = A.get( 2 );
* // returns <Complex128>
*
* re = real( z );
* // returns 1.0
*
* im = imag( z );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*/
function zlaset( uplo, M, N, alpha, beta, A, strideA1, strideA2, offsetA ) {
var viewA;
Expand Down
20 changes: 2 additions & 18 deletions lib/node_modules/@stdlib/lapack/base/zlaset/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 zlaset = require( '@stdlib/lapack/base/zlaset' );
*
* var A = new Complex128Array( 4 );
Expand All @@ -37,19 +35,11 @@
* zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
*
* var z = A.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 3.0
*
* var im = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.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 zlaset = require( '@stdlib/lapack/base/zlaset' );
*
* var A = new Complex128Array( 5 );
Expand All @@ -59,13 +49,7 @@
* zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
*
* var z = A.get( 1 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 3.0
*
* var im = imag( z );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/

// MODULES //
Expand Down
Loading