Skip to content

stdlib-js/blas-ext-base-ndarray-cxsy

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!

cxsy

NPM version Build Status Coverage Status

Subtract the elements of an output one-dimensional single-precision complex floating-point ndarray from the corresponding elements in an input one-dimensional single-precision complex floating-point ndarray and assign the results to the output ndarray.

This BLAS extension implements the operation

$$\mathbf{y} = \mathbf{x} - \mathbf{y}$$

This API is a specialized version of the package @stdlib/blas-ext/base/ndarray/caxpby with α = 1 and β = -1 and performs element-wise subtraction between two complex vectors.

Installation

npm install @stdlib/blas-ext-base-ndarray-cxsy

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var cxsy = require( '@stdlib/blas-ext-base-ndarray-cxsy' );

cxsy( arrays )

Subtracts the elements of an output one-dimensional single-precision complex floating-point ndarray from the corresponding elements in an input one-dimensional single-precision complex floating-point ndarray and assigns the results to the output ndarray.

var Complex64Vector = require( '@stdlib/ndarray-vector-complex64' );

var x = new Complex64Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
var y = new Complex64Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );

cxsy( [ x, y ] );
// y => <ndarray>[ <Complex64>[ -1.0, 1.0 ], <Complex64>[ 4.0, -4.0 ], <Complex64>[ -4.0, 1.0 ] ]

The function has the following parameters:

  • arrays: array-like object containing the following ndarrays:

    • a one-dimensional input ndarray.
    • a one-dimensional output ndarray.

Notes

  • The output ndarray is modified in-place (i.e., the output ndarray is mutated).

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var Complex64Vector = require( '@stdlib/ndarray-vector-complex64' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var cxsy = require( '@stdlib/blas-ext-base-ndarray-cxsy' );

var opts = {
    'dtype': 'float32'
};

var x = new Complex64Vector( discreteUniform( 20, -100, 100, opts ) );
console.log( ndarray2array( x ) );

var y = new Complex64Vector( discreteUniform( 20, -100, 100, opts ) );
console.log( ndarray2array( y ) );

cxsy( [ x, y ] );
console.log( ndarray2array( y ) );

Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

About

Subtract the elements of an output one-dimensional single-precision complex floating-point ndarray from the corresponding elements in an input one-dimensional single-precision complex floating-point ndarray and assign the results to the output ndarray.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors