Skip to content

docs: improve doctests for complex number instances in lapack/base/claset #8950

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

Open
sagar7162 wants to merge 1 commit into
base: develop
Choose a base branch
from
+36 −280
Open

docs: improve doctests for complex number instances in lapack/base/claset #8950

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/claset/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 single-precision c
```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var A = new Complex64Array( 4 );

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

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

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

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

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

re = realf( z );
// returns 1.0

im = imagf( z );
// returns 2.0
// returns <Complex64>[ 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 Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

// Initial array:
var A0 = new Complex64Array( 5 );
Expand All @@ -99,13 +83,7 @@ var beta = new Complex64( 3.0, 4.0 );
claset( 'row-major', 'all', 2, 2, alpha, beta, A1, 2 );

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

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

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

#### claset.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 single-precision c
```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var A = new Complex64Array( 4 );

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

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

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

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

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

re = realf( z );
// returns 1.0

im = imagf( z );
// returns 2.0
// returns <Complex64>[ 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 Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var A = new Complex64Array( 5 );

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

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

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

var im = imagf( z );
// returns 0.0
// returns <Complex64>[ 0.0, 0.0 ]

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

re = realf( z );
// returns 3.0

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

</section>
Expand Down
78 changes: 9 additions & 69 deletions lib/node_modules/@stdlib/lapack/base/claset/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 Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -486,37 +484,17 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* claset( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -526,37 +504,17 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* claset( 'upper', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 0.0
*
* im = imagf( z );
* // returns 0.0
* // returns <Complex64>[ 0.0, 0.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -566,31 +524,13 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
* claset( 'lower', 2, 2, alpha, beta, A, 2, 1, 0 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 0.0
*
* im = imagf( z );
* // returns 0.0
* // returns <Complex64>[ 0.0, 0.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*/
function claset( uplo, M, N, alpha, beta, A, strideA1, strideA2, offsetA ) {
var viewA;
Expand Down
78 changes: 9 additions & 69 deletions lib/node_modules/@stdlib/lapack/base/claset/lib/claset.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ var base = require( './base.js' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -57,37 +55,17 @@ var base = require( './base.js' );
* claset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -97,37 +75,17 @@ var base = require( './base.js' );
* claset( 'row-major', 'upper', 2, 2, alpha, beta, A, 2 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 0.0
*
* im = imagf( z );
* // returns 0.0
* // returns <Complex64>[ 0.0, 0.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var A = new Complex64Array( 4 );
*
Expand All @@ -137,31 +95,13 @@ var base = require( './base.js' );
* claset( 'row-major', 'lower', 2, 2, alpha, beta, A, 2 );
*
* var z = A.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 3.0
*
* var im = imagf( z );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*
* z = A.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 0.0
*
* im = imagf( z );
* // returns 0.0
* // returns <Complex64>[ 0.0, 0.0 ]
*
* z = A.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 1.0
*
* im = imagf( z );
* // returns 2.0
* // returns <Complex64>[ 1.0, 2.0 ]
*/
function claset( order, uplo, M, N, alpha, beta, A, LDA ) {
var sa1;
Expand Down
Loading