Skip to content
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

docs: update examples for blas/base/csrot #4963

Merged
merged 1 commit into from
Jan 31, 2025
Merged

docs: update examples for blas/base/csrot #4963

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
110 changes: 10 additions & 100 deletions lib/node_modules/@stdlib/blas/base/csrot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,13 @@ Applies a plane rotation.

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

csrot( cx.length, cx, 1, cy, 1, 0.8, 0.6 );

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

var re = realf( z );
// returns ~-0.6

var im = imagf( z );
// returns ~-1.2

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

re = realf( z );
// returns ~0.8

im = imagf( z );
// returns ~1.6
// cx => <Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8, ~5.6, ~6.4 ]
// cy => <Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6, ~-4.2, ~-4.8 ]
```

The function has the following parameters:
Expand All @@ -75,31 +57,13 @@ The `N` and stride parameters determine how values from `cx` and `cy` are access

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

csrot( 2, cx, 2, cy, 2, 0.8, 0.6 );

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

var re = realf( z );
// returns ~-0.6

var im = imagf( z );
// returns ~-1.2

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

re = realf( z );
// returns ~0.8

im = imagf( z );
// returns ~1.6
// cx => <Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
// cy => <Complex64Array>[ ~-0.6, ~-1.2, 0.0, 0.0, -3.0, ~-3.6, 0.0, 0.0 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
Expand All @@ -108,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

// Initial arrays...
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
Expand All @@ -120,24 +82,8 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
var cy1 = new Complex64Array( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 ); // start at 3rd element

csrot( 2, cx1, -2, cy1, 1, 0.8, 0.6 );

var z = cy0.get( 2 );
// returns <Complex64>

var re = realf( z );
// returns ~-4.2

var im = imagf( z );
// returns ~-4.8

z = cx0.get( 3 );
// returns <Complex64>

re = realf( z );
// returns ~5.6

im = imagf( z );
// returns ~6.4
// cx0 => <Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// cy0 => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, ~-4.2, ~-4.8, ~-1.8, ~-2.4 ]
```

#### csrot.ndarray( N, cx, strideX, offsetX, cy, strideY, offsetY, c, s )
Expand All @@ -146,31 +92,13 @@ Applies a plane rotation using alternative indexing semantics.

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

csrot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, 0.6 );

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

var re = realf( z );
// returns ~-0.6

var im = imagf( z );
// returns ~-1.2

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

re = realf( z );
// returns ~0.8

im = imagf( z );
// returns ~1.6
// cx => <Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8 ]
// cy => <Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6 ]
```

The function has the following additional parameters:
Expand All @@ -182,31 +110,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

csrot.ndarray( 2, cx, 2, 1, cy, 2, 1, 0.8, 0.6 );

var z = cy.get( 3 );
// returns <Complex64>

var re = realf( z );
// returns ~-4.2

var im = imagf( z );
// returns ~-4.8

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

re = realf( z );
// returns ~2.4

im = imagf( z );
// returns ~3.2
// cx => <Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// cy => <Complex64Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0, ~-4.2, ~-4.8 ]
```

</section>
Expand Down
70 changes: 20 additions & 50 deletions lib/node_modules/@stdlib/blas/base/csrot/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,48 +44,30 @@
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}( cx.length, cx, 1, cy, 1, 0.8, 0.6 );
> var z = cy.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( z )
~-0.6
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
~-1.2
> z = cx.get( 0 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~0.8
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~1.6
> cx
<Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
> cy
<Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4 ]

// Advanced indexing:
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
> cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}( 2, cx, -2, cy, 1, 0.8, 0.6 );
> z = cy.get( 0 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~-3.0
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~-3.6
> z = cx.get( 2 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~4.0
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~4.8
> cx
<Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
> cy
<Complex64Array>[ -3.0, ~-3.6, ~-0.6, ~-1.2, 0.0, 0.0, 0.0, 0.0 ]

// Using typed array views:
> var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
> var cy0 = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
> var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
> var cy1 = new {{alias:@stdlib/array/complex64}}( cy0.buffer, cy0.BYTES_PER_ELEMENT*2 );
> {{alias}}( 1, cx1, 1, cy1, 1, 0.8, 0.6 );
> z = cy0.get( 2 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~-1.8
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~-2.4
> z = cx0.get( 1 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~2.4
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~3.2
> cx0
<Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
> cy0
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, ~-1.8, ~-2.4 ]


{{alias}}.ndarray( N, cx, strideX, offsetX, cy, strideY, offsetY, c, s )
Expand Down Expand Up @@ -135,31 +117,19 @@
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, 0.6 );
> var z = cy.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( z )
~-0.6
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
~-1.2
> z = cx.get( 0 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~0.8
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~1.6
> cx
<Complex64Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
> cy
<Complex64Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4 ]

// Advanced indexing:
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
> cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}.ndarray( 1, cx, 2, 1, cy, 2, 1, 0.8, 0.6 );
> z = cy.get( 1 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~-1.8
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~-2.4
> z = cx.get( 1 );
> re = {{alias:@stdlib/complex/float32/real}}( z )
~2.4
> im = {{alias:@stdlib/complex/float32/imag}}( z )
~3.2
> cx
<Complex64Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
> cy
<Complex64Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0 ]

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