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

Interchange two complex double-precision floating-point vectors.
https://github.com/stdlib-js/blas-base-wasm-zswap
algebra array blas complex complex128 javascript level-1 linear math mathematics ndarray node node-js nodejs stdlib subroutines swap typed vector zswap
Last synced: 2 months ago
JSON representation
Interchange two complex double-precision floating-point vectors.
Host: GitHub
URL: https://github.com/stdlib-js/blas-base-wasm-zswap
Owner: stdlib-js
License: apache-2.0
Created: 2025-03-04T00:20:42.000Z (3 months ago)
Default Branch: main
Last Pushed: 2025-03-17T02:32:06.000Z (2 months ago)
Last Synced: 2025-03-17T02:39:51.279Z (2 months ago)
Topics: algebra, array, blas, complex, complex128, javascript, level-1, linear, math, mathematics, ndarray, node, node-js, nodejs, stdlib, subroutines, swap, typed, vector, zswap
Language: JavaScript
Homepage: https://github.com/stdlib-js/stdlib
Size: 584 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project

README

        

  

    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!


# zswap

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Interchange two complex double-precision floating-point vectors.

## Installation

```bash

npm install @stdlib/blas-base-wasm-zswap

```

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 zswap = require( '@stdlib/blas-base-wasm-zswap' );

```

#### zswap.main( N, x, strideX, y, strideY )

Interchanges two complex double-precision floating-point vectors.

```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 ] );

zswap.main( x.length, x, 1, y, 1 );

// x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

// y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]

```

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` are interchanged with values from `y`. For example, to interchange every other value in `x` with the first `N` elements of `y` in reverse order,

```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 ] );

zswap.main( 2, x, -2, y, 1 );

// x => [ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0 ]

// y => [ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 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

// Interchange every other value from `x1` into `y1` in reverse order...

zswap.main( 2, x1, -2, y1, 1 );

// x0 => [ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ]

// y0 => [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]

```

#### zswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Interchanges two complex double-precision floating-point vectors 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 ] );

zswap.ndarray( x.length, x, 1, 0, y, 1, 0 );

// x => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

// y => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.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 interchange every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,...,

```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 ] );

zswap.ndarray( 2, x, 2, 1, y, -1, y.length-1 );

// x => [ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 0.0, 0.0 ]

// y => [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]

```

* * *

### Module

#### zswap.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 zswap.Module( mem );

// returns 

// Initialize the routine:

mod.initializeSync();

```

#### zswap.Module.prototype.main( N, xp, sx, yp, sy )

Interchanges two complex double-precision floating-point vectors.

```javascript

var Memory = require( '@stdlib/wasm-memory' );

var oneTo = require( '@stdlib/array-one-to' );

var zeros = require( '@stdlib/array-zeros' );

var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );

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

var reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );

var zswap = require( '@stdlib/blas-base-wasm-zswap' );

// Create a new memory instance with an initial size of 10 pages (320KiB) and a maximum size of 100 pages (6.4MiB):

var mem = new Memory({

    'initial': 10,

    'maximum': 100

});

// Create a BLAS routine:

var mod = new zswap.Module( mem );

// returns 

// Initialize the routine:

mod.initializeSync();

// Define a vector data type:

var dtype = 'complex128';

// Specify a vector length:

var N = 5;

// Define pointers (i.e., byte offsets) for storing input vectors:

var xptr = 0;

var yptr = N * bytesPerElement( dtype );

// Write vector values to module memory:

var xbuf = oneTo( N*2, 'float64' );

var x = new Complex128Array( xbuf.buffer );

mod.write( xptr, x );

var ybuf = zeros( N*2, 'float64' );

var y = new Complex128Array( ybuf.buffer );

mod.write( yptr, y );

// Perform computation:

mod.main( N, xptr, 1, yptr, 1 );

// Read out the results:

var viewX = zeros( N, dtype );

var viewY = zeros( N, dtype );

mod.read( xptr, viewX );

mod.read( yptr, viewY );

console.log( reinterpretComplex128( viewX, 0 ) );

// => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

console.log( reinterpretComplex128( viewY, 0 ) );

// => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]

```

The function has the following parameters:

-   **N**: number of indexed elements.

-   **xp**: first input [`Complex128Array`][@stdlib/array/complex128] pointer (i.e., byte offset).

-   **sx**: index increment for `x`.

-   **yp**: second input [`Complex128Array`][@stdlib/array/complex128] pointer (i.e., byte offset).

-   **sy**: index increment for `y`.

#### zswap.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )

Interchanges two complex double-precision floating-point vectors using alternative indexing semantics.

```javascript

var Memory = require( '@stdlib/wasm-memory' );

var oneTo = require( '@stdlib/array-one-to' );

var zeros = require( '@stdlib/array-zeros' );

var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );

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

var reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );

var zswap = require( '@stdlib/blas-base-wasm-zswap' );

// Create a new memory instance with an initial size of 10 pages (320KiB) and a maximum size of 100 pages (6.4MiB):

var mem = new Memory({

    'initial': 10,

    'maximum': 100

});

// Create a BLAS routine:

var mod = new zswap.Module( mem );

// returns 

// Initialize the routine:

mod.initializeSync();

// Define a vector data type:

var dtype = 'complex128';

// Specify a vector length:

var N = 5;

// Define pointers (i.e., byte offsets) for storing input vectors:

var xptr = 0;

var yptr = N * bytesPerElement( dtype );

// Write vector values to module memory:

var xbuf = oneTo( N*2, 'float64' );

var x = new Complex128Array( xbuf.buffer );

mod.write( xptr, x );

var ybuf = zeros( N*2, 'float64' );

var y = new Complex128Array( ybuf.buffer );

mod.write( yptr, y );

// Perform computation:

mod.ndarray( N, xptr, 1, 0, yptr, 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( reinterpretComplex128( viewX, 0 ) );

// => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

console.log( reinterpretComplex128( viewY, 0 ) );

// => [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]

```

The function has the following additional parameters:

-   **ox**: starting index for `x`.

-   **oy**: starting index for `y`.

* * *

## Notes

-   If `N <= 0`, both functions leave `x` and `y` unchanged.

-   This package implements routines using WebAssembly. When provided arrays which are not allocated on a `zswap` 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/zswap`][@stdlib/blas/base/zswap]. 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/zswap`][@stdlib/blas/base/zswap]. 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.

-   `zswap()` corresponds to the [BLAS][blas] level 1 function [`zswap`][zswap].

* * *

## Examples

```javascript

var hasWebAssemblySupport = require( '@stdlib/assert-has-wasm-support' );

var oneTo = require( '@stdlib/array-one-to' );

var zeros = require( '@stdlib/array-zeros' );

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

var reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );

var zswap = require( '@stdlib/blas-base-wasm-zswap' );

// Specify a vector length:

var N = 5;

var xbuf = oneTo( N*2, 'float64' );

var x = new Complex128Array( xbuf.buffer );

var ybuf = zeros( N*2, 'float64' );

var y = new Complex128Array( ybuf.buffer );

// Perform computation:

zswap.ndarray( N, x, 1, 0, y, -1, N-1 );

// Print the results:

console.log( reinterpretComplex128( x, 0 ) );

// => [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

console.log( reinterpretComplex128( y, 0 ) );

// => [ 9.0, 10.0, 7.0, 8.0, 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]

```

* * *

## 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].

[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-base-wasm-zswap.svg

[npm-url]: https://npmjs.org/package/@stdlib/blas-base-wasm-zswap

[test-image]: https://github.com/stdlib-js/blas-base-wasm-zswap/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/blas-base-wasm-zswap/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-wasm-zswap/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-wasm-zswap?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[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-wasm-zswap/tree/deno

[deno-readme]: https://github.com/stdlib-js/blas-base-wasm-zswap/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/blas-base-wasm-zswap/tree/umd

[umd-readme]: https://github.com/stdlib-js/blas-base-wasm-zswap/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/blas-base-wasm-zswap/tree/esm

[esm-readme]: https://github.com/stdlib-js/blas-base-wasm-zswap/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/blas-base-wasm-zswap/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-wasm-zswap/main/LICENSE

[blas]: http://www.netlib.org/blas

[zswap]: https://www.netlib.org/lapack/explore-html/d7/d51/group__swap_ga8e324819e4cd92b6fde3ae40c83a5cb3.html#ga8e324819e4cd92b6fde3ae40c83a5cb3

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

[@stdlib/array/complex128]: https://github.com/stdlib-js/array-complex128

[@stdlib/wasm/memory]: https://github.com/stdlib-js/wasm-memory

[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/wasm-module-wrapper

[@stdlib/blas/base/zswap]: https://github.com/stdlib-js/blas-base-zswap
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

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

Awesome Lists containing this project

README
