Data

Tools

Indexes

Applications

Experiments

Open Source Science

blas-tools-swap-factory

Return a function which interchanges two vectors.

https://github.com/stdlib-js/blas-tools-swap-factory

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 (15.5%) to scientific vocabulary

Keywords

algebra array blas factory interchange javascript level-1 linear math mathematics ndarray node node-js nodejs stdlib subroutines swap tool tools vector
Last synced: 4 months ago · JSON representation ·

Repository

Return a function which interchanges two vectors.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
algebra array blas factory interchange javascript level-1 linear math mathematics ndarray node node-js nodejs stdlib subroutines swap tool tools vector
Created over 1 year ago · Last pushed 5 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!

factory

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

Return a function which interchanges two vectors.

## Installation ```bash npm install @stdlib/blas-tools-swap-factory ``` 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 factory = require( '@stdlib/blas-tools-swap-factory' ); ``` #### factory( base, dtype ) Returns a function which interchanges two vectors. ```javascript var dswap = require( '@stdlib/blas-base-dswap' ).ndarray; var swap = factory( dswap, 'float64' ); ``` The function has the following parameters: - **base**: "base" function which interchanges two vectors. Must have an `ndarray` function signature (i.e., must support index offsets). - **dtype**: array data type. The function assumes that the data type of all provided arrays is the same. #### swap( x, y\[, dim] ) Interchanges two vectors. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var array = require( '@stdlib/ndarray-array' ); var dswap = require( '@stdlib/blas-base-dswap' ).ndarray; var swap = factory( dswap, 'float64' ); var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) ); var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) ); swap( x, y ); var xbuf = x.data; // returns [ 2.0, 6.0, -1.0, -4.0, 8.0 ] var ybuf = y.data; // returns [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ``` The returned function has the following parameters: - **x**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor]. Must have the same shape as `y`. - **y**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor]. Must have the same shape as `x`. - **dim**: dimension along which to interchange vectors. Must be a negative integer. Negative indices are resolved relative to the last array dimension, with the last dimension corresponding to `-1`. Default: `-1`. For multi-dimensional input [`ndarrays`][@stdlib/ndarray/ctor], the function performs batched computation, such that the function interchanges each pair of vectors in `x` and `y` according to the specified dimension index. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var array = require( '@stdlib/ndarray-array' ); var dswap = require( '@stdlib/blas-base-dswap' ).ndarray; var swap = factory( dswap, 'float64' ); var opts = { 'shape': [ 2, 3 ] }; var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 3.0 ] ), opts ); var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 2.0 ] ), opts ); var v1 = x.get( 0, 0 ); // returns 4.0 var v2 = y.get( 0, 0 ); // returns 2.0 swap( x, y ); v1 = x.get( 0, 0 ); // returns 2.0 v2 = y.get( 0, 0 ); // returns 4.0 ```
## Notes For the returned function, - Both input [`ndarrays`][@stdlib/ndarray/ctor] must have the same shape. - Negative indices are resolved relative to the last [`ndarray`][@stdlib/ndarray/ctor] dimension, with the last dimension corresponding to `-1`. - For multi-dimensional [`ndarrays`][@stdlib/ndarray/ctor], batched computation effectively means swapping all of `x` with all of `y`; however, the choice of `dim` will significantly affect performance. For best performance, specify a `dim` which best aligns with the [memory layout][@stdlib/ndarray/orders] of provided [`ndarrays`][@stdlib/ndarray/ctor].
## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var array = require( '@stdlib/ndarray-array' ); var dswap = require( '@stdlib/blas-base-dswap' ).ndarray; var factory = require( '@stdlib/blas-tools-swap-factory' ); var swap = factory( dswap, 'float64' ); var opts = { 'dtype': 'float64' }; var x = array( discreteUniform( 10, 0, 100, opts ), { 'shape': [ 5, 2 ] }); console.log( ndarray2array( x ) ); var y = array( discreteUniform( 10, 0, 10, opts ), { 'shape': x.shape }); console.log( ndarray2array( y ) ); swap( x, y ); console.log( ndarray2array( x ) ); console.log( ndarray2array( 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: 14
Last Year
  • Push event: 14

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 19c28f1ef146469e409470805ea4279d47c3d35c 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
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-float64 ^0.2.2 development
  • @stdlib/array-int16 ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/blas-base-dcopy ^0.3.0 development
  • @stdlib/blas-base-dswap ^0.3.0 development
  • @stdlib/math-base-assert-is-nan ^0.2.2 development
  • @stdlib/math-base-special-pow ^0.3.0 development
  • @stdlib/ndarray-array ^0.2.1 development
  • @stdlib/ndarray-ctor ^0.2.2 development
  • @stdlib/ndarray-to-array ^0.2.1 development
  • @stdlib/ndarray-zeros ^0.3.0 development
  • @stdlib/random-array-discrete-uniform ^0.2.1 development
  • @stdlib/random-array-uniform ^0.2.1 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/array-base-assert-has-equal-values-indexed github:stdlib-js/array-base-assert-has-equal-values-indexed#main
  • @stdlib/array-base-without github:stdlib-js/array-base-without#main
  • @stdlib/assert-is-function ^0.2.2
  • @stdlib/assert-is-ndarray-like ^0.2.2
  • @stdlib/assert-is-ndarray-like-with-data-type github:stdlib-js/assert-is-ndarray-like-with-data-type#main
  • @stdlib/assert-is-negative-integer ^0.2.2
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/math-base-special-fast-min ^0.3.0
  • @stdlib/ndarray-base-assert-is-data-type ^0.2.2
  • @stdlib/ndarray-base-assert-is-read-only ^0.2.2
  • @stdlib/ndarray-base-ndarraylike2ndarray github:stdlib-js/ndarray-base-ndarraylike2ndarray#main
  • @stdlib/ndarray-base-normalize-index ^0.2.2
  • @stdlib/ndarray-base-numel ^0.2.2
  • @stdlib/ndarray-iter-stacks github:stdlib-js/ndarray-iter-stacks#main
  • @stdlib/string-format ^0.2.2
  • @stdlib/types ^0.4.3