Skip to content

Commit 310473d

Browse files
kgrytekgryte
committed
Add ndarray interface to BLAS routine dswap 
1 parent 89d21b5 commit 310473d

11 files changed

Lines changed: 1043 additions & 1 deletion

File tree

‎lib/node_modules/@stdlib/blas/dswap/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2020 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# dswap
22+
23+
> Interchange two double-precision floating-point vectors.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var dswap = require( '@stdlib/blas/dswap' );
37+
```
38+
39+
#### dswap( x, y )
40+
41+
Interchanges two double-precision floating-point vectors `x` and `y`.
42+
43+
```javascript
44+
var Float64Array = require( '@stdlib/array/float64' );
45+
var array = require( '@stdlib/ndarray/array' );
46+
47+
var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
48+
var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
49+
50+
dswap( x, y );
51+
52+
var xbuf = x.data;
53+
// returns <Float64Array>[ 2.0, 6.0, -1.0, -4.0, 8.0 ]
54+
55+
var ybuf = y.data;
56+
// returns <Float64Array>[ 4.0, 2.0, -3.0, 5.0, -1.0 ]
57+
```
58+
59+
The function has the following parameters:
60+
61+
- **x**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float64`.
62+
- **y**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float64`.
63+
64+
</section>
65+
66+
<!-- /.usage -->
67+
68+
<section class="notes">
69+
70+
## Notes
71+
72+
- `dswap()` provides a higher-level interface to the [BLAS][blas] level 1 function [`dswap`][@stdlib/blas/base/dswap].
73+
74+
</section>
75+
76+
<!-- /.notes -->
77+
78+
<section class="examples">
79+
80+
## Examples
81+
82+
<!-- eslint no-undef: "error" -->
83+
84+
```javascript
85+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
86+
var Float64Array = require( '@stdlib/array/float64' );
87+
var array = require( '@stdlib/ndarray/array' );
88+
var dswap = require( '@stdlib/blas/dswap' );
89+
90+
var x = array( new Float64Array( 10 ) );
91+
var y = array( new Float64Array( 10 ) );
92+
93+
var rand1 = discreteUniform.factory( 0, 100 );
94+
var rand2 = discreteUniform.factory( 0, 10 );
95+
96+
var i;
97+
for ( i = 0; i < x.length; i++ ) {
98+
x.set( i, rand1() );
99+
y.set( i, rand2() );
100+
}
101+
console.log( x.data );
102+
console.log( y.data );
103+
104+
dswap( x, y );
105+
console.log( x.data );
106+
console.log( y.data );
107+
```
108+
109+
</section>
110+
111+
<!-- /.examples -->
112+
113+
<section class="links">
114+
115+
[blas]: http://www.netlib.org/blas
116+
117+
[@stdlib/blas/base/dswap]: https://github.com/stdlib-js/stdlib
118+
119+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib
120+
121+
</section>
122+
123+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/dswap/benchmark/benchmark.js‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/base/randu' );
25+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var pow = require( '@stdlib/math/base/special/pow' );
27+
var Float64Array = require( '@stdlib/array/float64' );
28+
var array = require( '@stdlib/ndarray/array' );
29+
var pkg = require( './../package.json' ).name;
30+
var dswap = require( './../lib/main.js' );
31+
32+
33+
// FUNCTIONS //
34+
35+
/**
36+
* Creates a benchmark function.
37+
*
38+
* @private
39+
* @param {PositiveInteger} len - array length
40+
* @returns {Function} benchmark function
41+
*/
42+
function createBenchmark( len ) {
43+
var x;
44+
var y;
45+
var i;
46+
47+
x = new Float64Array( len );
48+
y = new Float64Array( len );
49+
for ( i = 0; i < len; i++ ) {
50+
x[ i ] = ( randu()*10.0 ) - 20.0;
51+
y[ i ] = ( randu()*10.0 ) - 20.0;
52+
}
53+
x = array( x );
54+
y = array( y );
55+
56+
return benchmark;
57+
58+
function benchmark( b ) {
59+
var d;
60+
var i;
61+
62+
b.tic();
63+
for ( i = 0; i < b.iterations; i++ ) {
64+
d = dswap( x, y );
65+
if ( isnan( d[ i%x.length ] ) ) {
66+
b.fail( 'should not return NaN' );
67+
}
68+
}
69+
b.toc();
70+
if ( isnan( d ) ) {
71+
b.fail( 'should not return NaN' );
72+
}
73+
b.pass( 'benchmark finished' );
74+
b.end();
75+
}
76+
}
77+
78+
79+
// MAIN //
80+
81+
/**
82+
* Main execution sequence.
83+
*
84+
* @private
85+
*/
86+
function main() {
87+
var len;
88+
var min;
89+
var max;
90+
var f;
91+
var i;
92+
93+
min = 1; // 10^min
94+
max = 6; // 10^max
95+
96+
for ( i = min; i <= max; i++ ) {
97+
len = pow( 10, i );
98+
f = createBenchmark( len );
99+
bench( pkg+':len='+len, f );
100+
}
101+
}
102+
103+
main();

‎lib/node_modules/@stdlib/blas/dswap/docs/repl.txt‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
{{alias}}( x, y )
3+
Interchanges two double-precision floating-point vectors.
4+
5+
Parameters
6+
----------
7+
x: ndarray
8+
First input array whose underlying data type is 'float64'.
9+
10+
y: ndarray
11+
Second input array whose underlying data type is 'float64'.
12+
13+
Returns
14+
-------
15+
y: ndarray
16+
The second input array `y`.
17+
18+
Examples
19+
--------
20+
> var x = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
21+
> var y = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
22+
> {{alias}}( x, y );
23+
> x.data
24+
<Float64Array>[ 2.0, 6.0, -1.0, -4.0, 8.0 ]
25+
> y.data
26+
<Float64Array>[ 4.0, 2.0, -3.0, 5.0, -1.0 ]
27+
28+
See Also
29+
--------
30+

‎lib/node_modules/@stdlib/blas/dswap/docs/types/index.d.ts‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 2.0
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Interchanges two double-precision floating-point vectors.
27+
*
28+
* @param x - first input array
29+
* @param y - second input array
30+
* @throws first argument must be a 1-dimensional `ndarray` containing double-precision floating-point numbers
31+
* @throws second argument must be a 1-dimensional `ndarray` containing double-precision floating-point numbers
32+
* @throws input arrays must be the same length
33+
* @returns `y`
34+
*
35+
* @example
36+
* var Float64Array = require( `@stdlib/array/float64` );
37+
* var array = require( `@stdlib/ndarray/array` );
38+
*
39+
* var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
40+
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
41+
*
42+
* dswap( x, y );
43+
*
44+
* var xbuf = x.data;
45+
* // returns <Float64Array>[ 2.0, 6.0, -1.0, -4.0, 8.0 ]
46+
*
47+
* var ybuf = y.data;
48+
* // returns <Float64Array>[ 4.0, 2.0, -3.0, 5.0, -1.0 ]
49+
*/
50+
declare function dswap( x: ndarray, y: ndarray ): ndarray;
51+
52+
53+
// EXPORTS //
54+
55+
export = dswap;

0 commit comments

Comments
 (0)