122 lines
2.6 KiB
Markdown
122 lines
2.6 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2020 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# gswap
|
||
|
|
|
||
|
|
> Interchange two vectors.
|
||
|
|
|
||
|
|
<section class="intro">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.intro -->
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var gswap = require( '@stdlib/blas/gswap' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### gswap( x, y )
|
||
|
|
|
||
|
|
Interchanges two vectors `x` and `y`.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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 ] ) );
|
||
|
|
|
||
|
|
gswap( 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 1-dimensional [`ndarray`][@stdlib/ndarray/array] or an array-like object.
|
||
|
|
- **y**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] or an array-like object.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- `gswap()` provides a higher-level interface to the [BLAS][blas] level 1 function [`gswap`][@stdlib/blas/base/gswap].
|
||
|
|
- In general, for best performance, especially for large vectors, provide 1-dimensional [`ndarrays`][@stdlib/ndarray/array] whose underlying data type is either `float64` or `float32`.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.notes -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
|
||
|
|
var gswap = require( '@stdlib/blas/gswap' );
|
||
|
|
|
||
|
|
var rand1 = discreteUniform.factory( 0, 100 );
|
||
|
|
var rand2 = discreteUniform.factory( 0, 10 );
|
||
|
|
|
||
|
|
var x = [];
|
||
|
|
var y = [];
|
||
|
|
var i;
|
||
|
|
for ( i = 0; i < 10; i++ ) {
|
||
|
|
x.push( rand1() );
|
||
|
|
y.push( rand2() );
|
||
|
|
}
|
||
|
|
console.log( x );
|
||
|
|
console.log( y );
|
||
|
|
|
||
|
|
gswap( x, y );
|
||
|
|
console.log( x );
|
||
|
|
console.log( y );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[blas]: http://www.netlib.org/blas
|
||
|
|
|
||
|
|
[@stdlib/blas/base/gswap]: https://www.npmjs.com/package/@stdlib/blas/tree/main/base/gswap
|
||
|
|
|
||
|
|
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray-array
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|