Skip to content

docs: improve doctests for complex number instances in lapack/base/zrot #8697

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
merged 1 commit into from
Dec 2, 2025
Merged

docs: improve doctests for complex number instances in lapack/base/zrot #8697

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
90 changes: 10 additions & 80 deletions lib/node_modules/@stdlib/lapack/base/zrot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ Applies a plane rotation with real cosine and complex sine.
```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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
Expand All @@ -47,22 +45,10 @@ var s = new Complex128( 0.0, 0.75 );
zrot( zx.length, zx, 1, zy, 1, 1.25, s );

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

var re = real( z );
// returns ~-1.5

var im = imag( z );
// returns ~0.75
// returns <Complex128>[ ~-1.5, ~0.75 ]

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

re = real( z );
// returns ~1.25

im = imag( z );
// returns ~2.5
// returns <Complex128>[ ~1.25, ~2.5 ]
```

The function has the following parameters:
Expand All @@ -78,8 +64,6 @@ The `N` and stride parameters determine how values from `zx` and `zy` are access
```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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
Expand All @@ -88,22 +72,10 @@ var s = new Complex128( 0.0, 0.75 );
zrot( 2, zx, 2, zy, 2, 1.25, s );

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

var re = real( z );
// returns ~-1.5

var im = imag( z );
// returns ~0.75
// returns <Complex128>[ ~-1.5, ~0.75 ]

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

re = real( z );
// returns ~1.25

im = imag( z );
// returns ~2.5
// returns <Complex128>[ ~1.25, ~2.5 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
Expand All @@ -113,8 +85,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 arrays...
var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
Expand All @@ -129,22 +99,10 @@ var s = new Complex128( 0.0, 0.75 );
zrot( 2, zx1, -2, zy1, 1, 1.25, s );

var z = zy0.get( 2 );
// returns <Complex128>

var re = real( z );
// returns ~-6

var im = imag( z );
// returns ~5.25
// returns <Complex128>[ ~-6.0, ~5.25 ]

z = zx0.get( 3 );
// returns <Complex128>

re = real( z );
// returns ~8.75

im = imag( z );
// returns ~10
// returns <Complex128>[ ~8.75, ~10.0 ]
```

#### zrot.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
Expand All @@ -154,8 +112,6 @@ Applies a plane rotation with real cosine and complex sine using alternative ind
```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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
Expand All @@ -164,22 +120,10 @@ var s = new Complex128( 0.0, 0.75 );
zrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 1.25, s );

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

var re = real( z );
// returns ~-1.5

var im = imag( z );
// returns ~0.75
// returns <Complex128>[ ~-1.5, ~0.75 ]

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

re = real( z );
// returns ~1.25

im = imag( z );
// returns ~2.5
// returns <Complex128>[ ~1.25, ~2.5 ]
```

The function has the following additional parameters:
Expand All @@ -192,8 +136,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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
Expand All @@ -202,22 +144,10 @@ var s = new Complex128( 0.0, 0.75 );
zrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 1.25, s );

var z = zy.get( 3 );
// returns <Complex128>

var re = real( z );
// returns ~-6.0

var im = imag( z );
// returns ~5.25
// returns <Complex128>[ ~-6.0, ~5.25 ]

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

re = real( z );
// returns ~3.75

im = imag( z );
// returns ~5.0
// returns <Complex128>[ ~3.75, ~5.0 ]
```

</section>
Expand Down
70 changes: 20 additions & 50 deletions lib/node_modules/@stdlib/lapack/base/zrot/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,32 +45,20 @@
> var zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
> {{alias}}( zx.length, zx, 1, zy, 1, 0.8, s );
> var z = zy.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( z )
~-1.1
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
~-0.2
> z = zx.get( 0 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~0.8
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~1.6
> var z = zy.get( 0 )
<Complex128>[ ~-1.1, ~-0.2 ]
> z = zx.get( 0 )
<Complex128>[ ~0.8, ~1.6 ]

// Advanced indexing:
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
> {{alias}}( 2, zx, -2, zy, 1, 0.8, s );
> z = zy.get( 0 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~-3.9
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~0.2
> z = zx.get( 2 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~4.0
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~4.8
> z = zy.get( 0 )
<Complex128>[ ~-3.9, ~0.2 ]
> z = zx.get( 2 )
<Complex128>[ ~4.0, ~4.8 ]

// Using typed array views:
> var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
Expand All @@ -79,16 +67,10 @@
> var zy1 = new {{alias:@stdlib/array/complex128}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 );
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
> {{alias}}( 1, zx1, 1, zy1, 1, 0.8, s );
> z = zy0.get( 2 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~-2.5
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~0.0
> z = zx0.get( 1 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~2.4
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~3.2
> z = zy0.get( 2 )
<Complex128>[ ~-2.5, ~0.0 ]
> z = zx0.get( 1 )
<Complex128>[ ~2.4, ~3.2 ]


{{alias}}.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
Expand Down Expand Up @@ -140,32 +122,20 @@
> var zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
> {{alias}}.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
> var z = zy.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( z )
~-1.1
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
~-0.2
> z = zx.get( 0 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~0.8
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~1.6
> var z = zy.get( 0 )
<Complex128>[ ~-1.1, ~-0.2 ]
> z = zx.get( 0 )
<Complex128>[ ~0.8, ~1.6 ]

// Advanced indexing:
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
> {{alias}}.ndarray( 1, zx, 2, 1, zy, 2, 1, 0.8, s );
> z = zy.get( 1 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~-2.5
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~0.0
> z = zx.get( 1 );
> re = {{alias:@stdlib/complex/float64/real}}( z )
~2.4
> im = {{alias:@stdlib/complex/float64/imag}}( z )
~3.2
> z = zy.get( 1 )
<Complex128>[ ~-2.5, ~0.0 ]
> z = zx.get( 1 )
<Complex128>[ ~2.4, ~3.2 ]

See Also
--------
Expand Down
Loading
Loading