Data

Tools

Indexes

Applications

Experiments

Open Source Science

blas-base-wasm-srot

Apply a plane rotation.

https://github.com/stdlib-js/blas-base-wasm-srot

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 float float32 float32array javascript level-1 linear math mathematics ndarray node node-js nodejs rotation srot stdlib subroutines vector
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 float float32 float32array javascript level-1 linear math mathematics ndarray node node-js nodejs rotation srot stdlib subroutines vector
Created about 1 year ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security Notice

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!

srot

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

Apply a plane rotation.

## Installation ```bash npm install @stdlib/blas-base-wasm-srot ``` 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 srot = require( '@stdlib/blas-base-wasm-srot' ); ``` #### srot.main( N, x, strideX, y, strideY, c, s ) Applies a plane rotation. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); srot.main( x.length, x, 1, y, 1, 0.0, 1.0 ); // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] // y => [ -1.0, -2.0, -3.0, -4.0, -5.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. - **strideX**: index increment for `x`. - **y**: input [`Float32Array`][@stdlib/array/float32]. - **strideY**: index increment for `y`. - **c**: cosine of the angle of rotation. - **s**: sine of the angle of rotation. The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to apply a plane rotation to every other element, ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); srot.main( 3, x, 2, y, 2, 0.8, 0.6 ); // x => [ ~5.0, 2.0, ~7.8, 4.0, ~10.6, 6.0 ] // y => [ ~5.0, 8.0, ~5.4, 10.0, ~5.8, 12.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Float32Array = require( '@stdlib/array-float32' ); // Initial arrays... var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); // Create offset views... var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element srot.main( 3, x1, -2, y1, 1, 0.8, 0.6 ); // x0 => [ 1.0, ~8.8, 3.0, ~9.8, 5.0, ~10.8 ] // y0 => [ 7.0, 8.0, 9.0, 4.4, 6.4, ~8.4 ] ``` #### srot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, c, s ) Applies a plane rotation using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float32Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); srot.ndarray( 4, x, 1, 1, y, 1, 1, 0.8, 0.6 ); // x => [ 1.0, ~5.8, ~7.2, ~8.6, 10.0 ] // y => [ 6.0, 4.4, ~4.6, ~4.8, 5.0 ] ``` 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 Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); srot.ndarray( 3, x, 2, 1, y, 2, 1, 0.8, 0.6 ); // x => [ 1.0, ~6.4, 3.0, ~9.2, 5.0, 12.0 ] // y => [ 7.0, 5.2, 9.0, 5.6, 11.0, ~6.0 ] ``` * * * ### Module #### srot.Module( memory ) Returns a new WebAssembly [module wrapper][@stdlib/wasm/module-wrapper] instance which uses the provided WebAssembly [memory][@stdlib/wasm/memory] instance as its underlying memory. ```javascript var Memory = require( '@stdlib/wasm-memory' ); // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): var mem = new Memory({ 'initial': 10, 'maximum': 100 }); // Create a BLAS routine: var mod = new srot.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); ``` #### srot.Module.prototype.main( N, xp, sx, yp, sy, c, s ) Applies a plane rotation. ```javascript var Memory = require( '@stdlib/wasm-memory' ); var oneTo = require( '@stdlib/array-one-to' ); var ones = require( '@stdlib/array-ones' ); var zeros = require( '@stdlib/array-zeros' ); var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' ); // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): var mem = new Memory({ 'initial': 10, 'maximum': 100 }); // Create a BLAS routine: var mod = new srot.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); // Define a vector data type: var dtype = 'float32'; // Specify a vector length: var N = 5; // Define pointers (i.e., byte offsets) for storing two vectors: var xptr = 0; var yptr = N * bytesPerElement( dtype ); // Write vector values to module memory: mod.write( xptr, oneTo( N, dtype ) ); mod.write( yptr, ones( N, dtype ) ); // Perform computation: mod.main( N, xptr, 1, yptr, 1, 0.0, 1.0 ); // Read out the results: var viewX = zeros( N, dtype ); var viewY = zeros( N, dtype ); mod.read( xptr, viewX ); mod.read( yptr, viewY ); console.log( viewX ); // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] console.log( viewY ); // => [ -1.0, -2.0, -3.0, -4.0, -5.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **xp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). - **sx**: index increment for `x`. - **yp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). - **sy**: index increment for `y`. - **c**: cosine of the angle of rotation. - **s**: sine of the angle of rotation. #### srot.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy, c, s ) Applies a plane rotation using alternative indexing semantics. ```javascript var Memory = require( '@stdlib/wasm-memory' ); var oneTo = require( '@stdlib/array-one-to' ); var ones = require( '@stdlib/array-ones' ); var zeros = require( '@stdlib/array-zeros' ); var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' ); // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): var mem = new Memory({ 'initial': 10, 'maximum': 100 }); // Create a BLAS routine: var mod = new srot.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); // Define a vector data type: var dtype = 'float32'; // Specify a vector length: var N = 5; // Define pointers (i.e., byte offsets) for storing two vectors: var xptr = 0; var yptr = N * bytesPerElement( dtype ); // Write vector values to module memory: mod.write( xptr, oneTo( N, dtype ) ); mod.write( yptr, ones( N, dtype ) ); // Perform computation: mod.ndarray( N, xptr, 1, 0, yptr, 1, 0, 0.0, 1.0 ); // Read out the results: var viewX = zeros( N, dtype ); var viewY = zeros( N, dtype ); mod.read( xptr, viewX ); mod.read( yptr, viewY ); console.log( viewX ); // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] console.log( viewY ); // => [ -1.0, -2.0, -3.0, -4.0, -5.0 ] ``` The function has the following additional parameters: - **ox**: starting index for `x`. - **oy**: starting index for `y`.
* * * ## Notes - If `N <= 0`, both vectors are unchanged. - This package implements routines using WebAssembly. When provided arrays which are not allocated on a `srot` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/blas-base/srot`][@stdlib/blas/base/srot]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/blas/base/srot`][@stdlib/blas/base/srot]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other. - `srot()` corresponds to the [BLAS][blas] level 1 function [`srot`][srot].
* * * ## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var srot = require( '@stdlib/blas-base-wasm-srot' ); var opts = { 'dtype': 'float32' }; var x = discreteUniform( 10, 0, 100, opts ); console.log( x ); var y = discreteUniform( x.length, 0, 10, opts ); console.log( y ); srot.ndarray( x.length, x, 1, 0, y, -1, y.length-1, 0.8, 0.6 ); console.log( y ); ```
* * * ## 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: 30
  • Create event: 3
Last Year
  • Push event: 30
  • Create event: 3