Apply a plane rotation.
npm install @stdlib/blas-base-zdrotWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Apply a plane rotation.
``bash`
npm install @stdlib/blas-base-zdrot
`javascript`
var zdrot = require( '@stdlib/blas-base-zdrot' );
#### zdrot( N, x, strideX, y, strideY, c, s )
Applies a plane rotation.
`javascript
var Complex128Array = require( '@stdlib/array-complex128' );
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( x.length, x, 1, y, 1, 0.8, 0.6 );
// x =>
// y =>
`
The function has the following parameters:
- N: number of indexed elements.
- x: first input [Complex128Array][@stdlib/array/complex128].x
- strideX: index increment for .Complex128Array
- y: second input [][@stdlib/array/complex128].y
- strideY: index increment for .
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 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, x, 2, y, 2, 0.8, 0.6 );
// x =>
// y =>
`
Note that indexing is relative to the first index. To introduce an offset, use [typed array][mdn-typed-array] views.
`javascript
var Complex128Array = require( '@stdlib/array-complex128' );
// Initial arrays...
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 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, x1, -2, y1, 1, 0.8, 0.6 );
// x0 =>
// y0 =>
`
#### 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 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( x.length, x, 1, 0, y, 1, 0, 0.8, 0.6 );
// x =>
// y =>
`
The function has the following additional parameters:
- offsetX: starting index for x.y
- offsetY: starting index for .
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 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, x, 2, 1, y, 2, 1, 0.8, 0.6 );
// x =>
// y =>
`
- If N <= 0, both functions leave x and y unchanged.zdrot()
- corresponds to the [BLAS][blas] level 1 function [zdrot][zdrot].
`javascript
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var zcopy = require( '@stdlib/blas-base-zcopy' );
var zeros = require( '@stdlib/array-zeros' );
var logEach = require( '@stdlib/console-log-each' );
var zdrot = require( '@stdlib/blas-base-zdrot' );
function rand() {
return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
}
// Generate random input arrays:
var x = filledarrayBy( 10, 'complex128', rand );
var xc = zcopy( x.length, x, 1, zeros( x.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( x.length, x, 1, y, 1, 0.8, 0.6 );
// Print the results:
logEach( '(%s,%s) => (%s,%s)', xc, yc, x, y );
`
*
`c`
#include "stdlib/blas/base/zdrot.h"
#### c_zdrot( N, \X, strideX, \Y, strideY, c, s )
Applies a plane rotation.
`c
double x[] = { 1.0, 2.0, 3.0, 4.0 }; // interleaved real and imaginary components
double y[] = { 5.0, 6.0, 7.0, 8.0 };
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.[inout] void*
- X: first input array.[in] CBLAS_INT
- strideX: index increment for X.[inout] void*
- Y: second input array.[in] CBLAS_INT
- strideY: index increment for Y.[in] double
- c: cosine of the angle of rotation.[in] double
- s: sine of the angle of rotation.
`c`
void c_zdrot( const CBLAS_INT N, void X, const CBLAS_INT strideX, void Y, const CBLAS_INT strideY, const double c, const double s );
#### c_zdrot_ndarray( N, \X, strideX, offsetX, \Y, strideY, offsetY, c, s )
Applies a plane rotation using alternative indexing semantics.
`c
double x[] = { 1.0, 2.0, 3.0, 4.0 }; // interleaved real and imaginary components
double y[] = { 5.0, 6.0, 7.0, 8.0 };
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.[inout] void*
- X: first input array.[in] CBLAS_INT
- strideX: index increment for X.[in] CBLAS_INT
- offsetX: starting index for X.[inout] void*
- Y: second input array.[in] CBLAS_INT
- strideY: index increment for Y.[in] CBLAS_INT
- offsetY: starting index for Y.[in] double
- c: cosine of the angle of rotation.[in] double
- s: sine of the angle of rotation.
`c`
void c_zdrot_ndarray( const CBLAS_INT N, void X, const CBLAS_INT strideX, const CBLAS_INT offsetX, void Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, const double c, const double s );
`c
#include "stdlib/blas/base/zdrot.h"
#include
int main( void ) {
// Create strided arrays:
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;
// Specify stride lengths:
const int strideX = 1;
const int strideY = -1;
// Copy elements:
c_zdrot( N, (void )x, strideX, (void )y, strideY, 0.8, 0.6 );
// Print the result:
for ( int i = 0; i < N; i++ ) {
printf( "x[ %i ] = %lf + %lfj\n", i, x[ i2 ], x[ (i2)+1 ] );
printf( "y[ %i ] = %lf + %lfj\n", i, y[ i2 ], y[ (i2)+1 ] );
}
}
`
*
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-base-zdrot.svg
[npm-url]: https://npmjs.org/package/@stdlib/blas-base-zdrot
[test-image]: https://github.com/stdlib-js/blas-base-zdrot/actions/workflows/test.yml/badge.svg?branch=v0.2.1
[test-url]: https://github.com/stdlib-js/blas-base-zdrot/actions/workflows/test.yml?query=branch:v0.2.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-zdrot/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-zdrot?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/blas-base-zdrot/tree/deno
[deno-readme]: https://github.com/stdlib-js/blas-base-zdrot/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/blas-base-zdrot/tree/umd
[umd-readme]: https://github.com/stdlib-js/blas-base-zdrot/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/blas-base-zdrot/tree/esm
[esm-readme]: https://github.com/stdlib-js/blas-base-zdrot/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/blas-base-zdrot/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-zdrot/main/LICENSE
[blas]: http://www.netlib.org/blas
[zdrot]: http://www.netlib.org/lapack/explore-html/da/df6/group__complex__blas__level1.html
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/array-complex128