Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: change variable naming in blas/base/zdrot #6879

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
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: change variable naming in blas/base/zdrot #6879

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
116 changes: 58 additions & 58 deletions lib/node_modules/@stdlib/blas/base/zdrot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,40 +30,40 @@ limitations under the License.
var zdrot = require( '@stdlib/blas/base/zdrot' );
```

#### zdrot( N, zx, strideX, zy, strideY, c, s )
#### zdrot( N, x, strideX, y, strideY, c, s )

Applies a plane rotation.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

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 ] );
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

zdrot( zx.length, zx, 1, zy, 1, 0.8, 0.6 );
// zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8, ~5.6, ~6.4 ]
// zy => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6, ~-4.2, ~-4.8 ]
zdrot( x.length, x, 1, y, 1, 0.8, 0.6 );
// x => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8, ~5.6, ~6.4 ]
// y => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6, ~-4.2, ~-4.8 ]
```

The function has the following parameters:

- **N**: number of indexed elements.
- **zx**: first input [`Complex128Array`][@stdlib/array/complex128].
- **strideX**: index increment for `zx`.
- **zy**: second input [`Complex128Array`][@stdlib/array/complex128].
- **strideY**: index increment for `zy`.
- **x**: first input [`Complex128Array`][@stdlib/array/complex128].
- **strideX**: index increment for `x`.
- **y**: second input [`Complex128Array`][@stdlib/array/complex128].
- **strideY**: index increment for `y`.

The `N` and stride parameters determine how values from `zx` and `zy` are accessed at runtime. For example, to apply a plane rotation to every other element,
The `N` and stride parameters determine how values from `x` and `y` are accessed at runtime. For example, to apply a plane rotation to every other element,

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

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 ] );
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

zdrot( 2, zx, 2, zy, 2, 0.8, 0.6 );
// zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
// zy => <Complex128Array>[ ~-0.6, ~-1.2, 0.0, 0.0, -3.0, ~-3.6, 0.0, 0.0 ]
zdrot( 2, x, 2, y, 2, 0.8, 0.6 );
// x => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
// y => <Complex128Array>[ ~-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 @@ -74,49 +74,49 @@ Note that indexing is relative to the first index. To introduce an offset, use [
var Complex128Array = require( '@stdlib/array/complex128' );

// Initial arrays...
var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var zy0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create offset views...
var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var zy1 = new Complex128Array( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 ); // start at 3rd element
var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3rd element

zdrot( 2, zx1, -2, zy1, 1, 0.8, 0.6 );
// zx0 => <Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// zy0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, ~-4.2, ~-4.8, ~-1.8, ~-2.4 ]
zdrot( 2, x1, -2, y1, 1, 0.8, 0.6 );
// x0 => <Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// y0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, ~-4.2, ~-4.8, ~-1.8, ~-2.4 ]
```

#### zdrot.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
#### zdrot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, c, s )

Applies a plane rotation using alternative indexing semantics.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

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 ] );
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

zdrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, 0.6 );
// zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8 ]
// zy => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6 ]
zdrot.ndarray( x.length, x, 1, 0, y, 1, 0, 0.8, 0.6 );
// x => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8 ]
// y => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6 ]
```

The function has the following additional parameters:

- **offsetX**: starting index for `zx`.
- **offsetY**: starting index for `zy`.
- **offsetX**: starting index for `x`.
- **offsetY**: starting index for `y`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to apply a plane rotation to every other element starting from the second element,

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

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 ] );
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

zdrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 0.8, 0.6 );
// zx => <Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// zy => <Complex128Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0, ~-4.2, ~-4.8 ]
zdrot.ndarray( 2, x, 2, 1, y, 2, 1, 0.8, 0.6 );
// x => <Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ]
// y => <Complex128Array>[ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0, ~-4.2, ~-4.8 ]
```

</section>
Expand All @@ -127,7 +127,7 @@ zdrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 0.8, 0.6 );

## Notes

- If `N <= 0`, both functions leave `zx` and `zy` unchanged.
- If `N <= 0`, both functions leave `x` and `y` unchanged.
- `zdrot()` corresponds to the [BLAS][blas] level 1 function [`zdrot`][zdrot].

</section>
Expand All @@ -154,17 +154,17 @@ function rand() {
}

// Generate random input arrays:
var zx = filledarrayBy( 10, 'complex128', rand );
var zxc = zcopy( zx.length, zx, 1, zeros( zx.length, 'complex128' ), 1 );
var x = filledarrayBy( 10, 'complex128', rand );
var xc = zcopy( x.length, x, 1, zeros( x.length, 'complex128' ), 1 );

var zy = filledarrayBy( 10, 'complex128', rand );
var zyc = zcopy( zy.length, zy, 1, zeros( zy.length, 'complex128' ), 1 );
var y = filledarrayBy( 10, 'complex128', rand );
var yc = zcopy( y.length, y, 1, zeros( y.length, 'complex128' ), 1 );

// Apply a plane rotation:
zdrot( zx.length, zx, 1, zy, 1, 0.8, 0.6 );
zdrot( x.length, x, 1, y, 1, 0.8, 0.6 );

// Print the results:
logEach( '(%s,%s) => (%s,%s)', zxc, zyc, zx, zy );
logEach( '(%s,%s) => (%s,%s)', xc, yc, x, y );
```

</section>
Expand Down Expand Up @@ -211,10 +211,10 @@ c_zdrot( 2, (void *)x, 1, (void *)y, 1, 0.8, 0.6 );
The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **zx**: `[inout] void*` first input array.
- **strideX**: `[in] CBLAS_INT` index increment for `zx`.
- **zy**: `[inout] void*` second input array.
- **strideY**: `[in] CBLAS_INT` index increment for `zy`.
- **x**: `[inout] void*` first input array.
- **strideX**: `[in] CBLAS_INT` index increment for `x`.
- **y**: `[inout] void*` second input array.
- **strideY**: `[in] CBLAS_INT` index increment for `y`.
- **c**: `[in] double` cosine of the angle of rotation.
- **s**: `[in] double` sine of the angle of rotation.

Expand All @@ -236,12 +236,12 @@ c_zdrot_ndarray( 2, (void *)x, 1, 0, (void *)y, 1, 0, 0.8, 0.6 );
The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **zx**: `[inout] void*` first input array.
- **strideX**: `[in] CBLAS_INT` index increment for `zx`.
- **offsetX**: `[in] CBLAS_INT` starting index for `zx`.
- **zy**: `[inout] void*` second input array.
- **strideY**: `[in] CBLAS_INT` index increment for `zy`.
- **offsetY**: `[in] CBLAS_INT` starting index for `zy`.
- **x**: `[inout] void*` first input array.
- **strideX**: `[in] CBLAS_INT` index increment for `x`.
- **offsetX**: `[in] CBLAS_INT` starting index for `x`.
- **y**: `[inout] void*` second input array.
- **strideY**: `[in] CBLAS_INT` index increment for `y`.
- **offsetY**: `[in] CBLAS_INT` starting index for `y`.
- **c**: `[in] double` cosine of the angle of rotation.
- **s**: `[in] double` sine of the angle of rotation.

Expand Down Expand Up @@ -273,8 +273,8 @@ void c_zdrot_ndarray( const CBLAS_INT N, void *X, const CBLAS_INT strideX, const

int main( void ) {
// Create strided arrays:
double zx[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
double zy[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
double y[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };

// Specify the number of elements:
const int N = 4;
Expand All @@ -284,12 +284,12 @@ int main( void ) {
const int strideY = -1;

// Copy elements:
c_zdrot( N, (void *)zx, strideX, (void *)zy, strideY, 0.8, 0.6 );
c_zdrot( N, (void *)x, strideX, (void *)y, strideY, 0.8, 0.6 );

// Print the result:
for ( int i = 0; i < N; i++ ) {
printf( "zx[ %i ] = %lf + %lfj\n", i, zx[ i*2 ], zx[ (i*2)+1 ] );
printf( "zy[ %i ] = %lf + %lfj\n", i, zy[ i*2 ], zy[ (i*2)+1 ] );
printf( "x[ %i ] = %lf + %lfj\n", i, x[ i*2 ], x[ (i*2)+1 ] );
printf( "y[ %i ] = %lf + %lfj\n", i, y[ i*2 ], y[ (i*2)+1 ] );
}
}
```
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/blas/base/zdrot/benchmark/benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var zx;
var zy;
var x;
var y;

zx = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
zy = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
x = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
y = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );

return benchmark;

Expand All @@ -65,10 +65,10 @@ function createBenchmark( len ) {
var viewX;
var i;

viewX = reinterpret( zx, 0 );
viewX = reinterpret( x, 0 );
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
zdrot( zx.length, zx, 1, zy, 1, 0.8, 0.6 );
zdrot( x.length, x, 1, y, 1, 0.8, 0.6 );
if ( isnan( viewX[ i%(len*2) ] ) ) {
b.fail( 'should not return NaN' );
}
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/blas/base/zdrot/benchmark/benchmark.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var zx;
var zy;
var x;
var y;

zx = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
zy = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
x = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
y = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );

return benchmark;

Expand All @@ -70,10 +70,10 @@ function createBenchmark( len ) {
var viewX;
var i;

viewX = reinterpret( zx, 0 );
viewX = reinterpret( x, 0 );
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
zdrot( zx.length, zx, 1, zy, 1, 0.8, 0.6 );
zdrot( x.length, x, 1, y, 1, 0.8, 0.6 );
if ( isnan( viewX[ i%(len*2) ] ) ) {
b.fail( 'should not return NaN' );
}
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/blas/base/zdrot/benchmark/benchmark.ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var zx;
var zy;
var x;
var y;

zx = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
zy = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
x = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
y = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );

return benchmark;

Expand All @@ -65,10 +65,10 @@ function createBenchmark( len ) {
var viewX;
var i;

viewX = reinterpret( zx, 0 );
viewX = reinterpret( x, 0 );
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
zdrot( zx.length, zx, 1, 0, zy, 1, 0, 0.8, 0.6 );
zdrot( x.length, x, 1, 0, y, 1, 0, 0.8, 0.6 );
if ( isnan( viewX[ i%(len*2) ] ) ) {
b.fail( 'should not return NaN' );
}
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/blas/base/zdrot/benchmark/benchmark.ndarray.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var zx;
var zy;
var x;
var y;

zx = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
zy = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
x = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );
y = new Complex128Array( uniform( len*2, -100.0, 100.0, options ) );

return benchmark;

Expand All @@ -70,10 +70,10 @@ function createBenchmark( len ) {
var viewX;
var i;

viewX = reinterpret( zx, 0 );
viewX = reinterpret( x, 0 );
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
zdrot( zx.length, zx, 1, 0, zy, 1, 0, 0.8, 0.6 );
zdrot( x.length, x, 1, 0, y, 1, 0, 0.8, 0.6 );
if ( isnan( viewX[ i%(len*2) ] ) ) {
b.fail( 'should not return NaN' );
}
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/blas/base/zdrot/benchmark/fortran/benchmark.length.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ double precision function benchmark( iterations, len )
! ..
! External functions:
interface
subroutine zdrot( N, zx, strideX, zy, strideY, c, s )
complex(kind=kind(0.0d0)) :: zx(*), zy(*)
subroutine zdrot( N, x, strideX, y, strideY, c, s )
complex(kind=kind(0.0d0)) :: x(*), y(*)
integer :: strideX, strideY, N
double precision :: c, s
end subroutine zdrot
Expand Down Expand Up @@ -208,4 +208,4 @@ subroutine main()
end do
call print_summary( count, count )
end subroutine main
end program bench
end program bench
Loading