@stdlib/blas-dswap
v0.3.1
Published
Interchange two double-precision floating-point vectors.
Readme
dswap
Interchange two double-precision floating-point vectors.
Installation
npm install @stdlib/blas-dswapUsage
var dswap = require( '@stdlib/blas-dswap' );dswap( x, y[, dim] )
Interchanges two double-precision floating-point vectors x and y.
var Float64Array = require( '@stdlib/array-float64' );
var array = require( '@stdlib/ndarray-array' );
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 ] ) );
dswap( x, y );
var xbuf = x.data;
// returns <Float64Array>[ 2.0, 6.0, -1.0, -4.0, 8.0 ]
var ybuf = y.data;
// returns <Float64Array>[ 4.0, 2.0, -3.0, 5.0, -1.0 ]The function has the following parameters:
- x: a non-zero-dimensional
ndarraywhose underlying data type isfloat64. Must have the same shape asy. - y: a non-zero-dimensional
ndarraywhose underlying data type isfloat64. Must have the same shape asx. - 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, the function performs batched computation, such that the function interchanges each pair of vectors in x and y according to the specified dimension index.
var Float64Array = require( '@stdlib/array-float64' );
var array = require( '@stdlib/ndarray-array' );
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
dswap( x, y );
v1 = x.get( 0, 0 );
// returns 2.0
v2 = y.get( 0, 0 );
// returns 4.0Notes
- Both input
ndarraysmust have the same shape. - Negative indices are resolved relative to the last
ndarraydimension, with the last dimension corresponding to-1. - For multi-dimensional
ndarrays, batched computation effectively means swapping all ofxwith all ofy; however, the choice ofdimwill significantly affect performance. For best performance, specify adimwhich best aligns with the memory layout of providedndarrays. dswap()provides a higher-level interface to the BLAS level 1 functiondswap.
Examples
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-dswap' );
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 ) );
dswap( x, y );
console.log( ndarray2array( x ) );
console.log( ndarray2array( y ) );See Also
@stdlib/blas-base/dswap: interchange two double-precision floating-point vectors.@stdlib/blas-gswap: interchange two vectors.@stdlib/blas-sswap: interchange two single-precision floating-point vectors.
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
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
