Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/blas-base-zdrot

Apply a plane rotation.

https://github.com/stdlib-js/blas-base-zdrot

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary

Keywords

algebra array blas complex complex128 javascript level-1 linear math mathematics ndarray node node-js nodejs rotation stdlib subroutines typed vector zdrot
Last synced: 4 months ago · JSON representation ·

Repository

Apply a plane rotation.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
algebra array blas complex complex128 javascript level-1 linear math mathematics ndarray node node-js nodejs rotation stdlib subroutines typed vector zdrot
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We 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!

zdrot

NPM version Build Status Coverage Status <!-- dependencies -->

Apply a plane rotation.

## Installation ```bash npm install @stdlib/blas-base-zdrot ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```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 => [ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8, ~5.6, ~6.4 ] // y => [ ~-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. - **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 `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 => [ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ] // y => [ ~-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. ```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 => [ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ] // y0 => [ 0.0, 0.0, 0.0, 0.0, ~-4.2, ~-4.8, ~-1.8, ~-2.4 ] ``` #### 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 => [ ~0.8, ~1.6, ~2.4, ~3.2, 4.0, ~4.8 ] // y => [ ~-0.6, ~-1.2, ~-1.8, ~-2.4, -3.0, ~-3.6 ] ``` The function has the following additional parameters: - **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 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 => [ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0, ~5.6, ~6.4 ] // y => [ 0.0, 0.0, ~-1.8, ~-2.4, 0.0, 0.0, ~-4.2, ~-4.8 ] ```
## Notes - If `N <= 0`, both functions leave `x` and `y` unchanged. - `zdrot()` corresponds to the [BLAS][blas] level 1 function [`zdrot`][zdrot].
## Examples ```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 APIs
### Usage ```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. - **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. ```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. - **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. ```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 ); ```
### Examples ```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[ i*2 ], x[ (i*2)+1 ] ); printf( "y[ %i ] = %lf + %lfj\n", i, y[ i*2 ], y[ (i*2)+1 ] ); } } ```

* * * ## Notice 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] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 57
Last Year
  • Push event: 57

Packages

  • Total packages: 1
  • Total downloads:
    • npm 29 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 4
npmjs.org: @stdlib/blas-base-zdrot

Apply a plane rotation.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.1.0
    published over 1 year ago
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 29 Last month
Rankings
Dependent repos count: 26.2%
Average: 32.1%
Dependent packages count: 38.0%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 5 months ago

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite
.github/workflows/examples.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_bundles.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite
.github/workflows/test_coverage.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-complex128 ^0.2.1 development
  • @stdlib/array-filled-by ^0.2.1 development
  • @stdlib/array-float64 ^0.2.1 development
  • @stdlib/array-zeros ^0.2.1 development
  • @stdlib/assert-is-browser ^0.2.1 development
  • @stdlib/bench-harness ^0.2.1 development
  • @stdlib/blas-base-zcopy ^0.1.0 development
  • @stdlib/complex-float64-ctor ^0.0.1 development
  • @stdlib/console-log-each ^0.2.1 development
  • @stdlib/constants-float64-eps ^0.2.1 development
  • @stdlib/math-base-assert-is-nan ^0.2.1 development
  • @stdlib/math-base-special-abs ^0.2.1 development
  • @stdlib/math-base-special-pow ^0.2.1 development
  • @stdlib/random-array-uniform ^0.2.1 development
  • @stdlib/random-base-discrete-uniform ^0.2.1 development
  • @stdlib/strided-base-min-view-buffer-index ^0.2.1 development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-is-error ^0.2.1
  • @stdlib/blas-base-shared ^0.0.1
  • @stdlib/napi-argv ^0.2.1
  • @stdlib/napi-argv-double ^0.2.1
  • @stdlib/napi-argv-int64 ^0.2.1
  • @stdlib/napi-argv-strided-complex128array ^0.3.1
  • @stdlib/napi-export ^0.2.1
  • @stdlib/strided-base-reinterpret-complex128 ^0.2.1
  • @stdlib/strided-base-stride2offset github:stdlib-js/strided-base-stride2offset#main
  • @stdlib/types ^0.3.2
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.1
  • @stdlib/utils-library-manifest ^0.2.1
  • @stdlib/utils-try-require ^0.2.1