Skip to content

Commit b96003d

Browse files
kgrytekgryte
committed
Fix return values
1 parent 5f569ae commit b96003d

File tree

3 files changed

+15
-43
lines changed

3 files changed

+15
-43
lines changed

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

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,12 @@ The `N` and `stride` parameters determine how values from `x` and `y` are access
5757

5858
```javascript
5959
var Float64Array = require( '@stdlib/array/float64' );
60-
var floor = require( '@stdlib/math/base/special/floor' );
6160

6261
var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6362
var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
6463

65-
var N = floor( x.length / 2 );
66-
67-
dswap( N, x, -2, y, 1 );
68-
// x => <Float64Array>[ 1.0, 7.0, 3.0, 8.0, 5.0, 9.0 ]
64+
dswap( 3, x, -2, y, 1 );
65+
// x => <Float64Array>[ 9.0, 2.0, 8.0, 4.0, 7.0, 6.0 ]
6966
// y => <Float64Array>[ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ]
7067
```
7168

@@ -75,7 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7572

7673
```javascript
7774
var Float64Array = require( '@stdlib/array/float64' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

8076
// Initial arrays...
8177
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -85,10 +81,8 @@ var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
8581
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8682
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
8783

88-
var N = floor( x0.length / 2 );
89-
9084
// Swap in reverse order every other value from `x1` with `y1`...
91-
dswap( N, x1, -2, y1, 1 );
85+
dswap( 3, x1, -2, y1, 1 );
9286
// x0 => <Float64Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
9387
// y0 => <Float64Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
9488
```
@@ -117,15 +111,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
117111

118112
```javascript
119113
var Float64Array = require( '@stdlib/array/float64' );
120-
var floor = require( '@stdlib/math/base/special/floor' );
121114

122115
var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
123116
var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
124117

125-
var N = floor( x.length / 2 );
126-
127-
dswap.ndarray( N, x, 2, 1, y, -1, y.length-1 );
128-
// x => <Float64Array>[ 1.0, 12.0, 11.0, 10.0, 5.0, 6.0 ]
118+
dswap.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
119+
// x => <Float64Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
129120
// y => <Float64Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
130121
```
131122

‎lib/node_modules/@stdlib/blas/base/gswap/README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,11 @@ The function has the following parameters:
5454
The `N` and `stride` parameters determine how values from `x` and `y` are accessed at runtime. For example, to swap in reverse order every other value in `x` with the first `N` elements of `y`,
5555

5656
```javascript
57-
var floor = require( '@stdlib/math/base/special/floor' );
58-
5957
var x = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
6058
var y = [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ];
6159

62-
var N = floor( x.length / 2 );
63-
64-
gswap( N, x, -2, y, 1 );
65-
// x => [ 1.0, 7.0, 3.0, 8.0, 5.0, 9.0 ]
60+
gswap( 3, x, -2, y, 1 );
61+
// x => [ 9.0, 2.0, 8.0, 4.0, 7.0, 6.0 ]
6662
// y => [ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ]
6763
```
6864

@@ -72,7 +68,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7268

7369
```javascript
7470
var Float64Array = require( '@stdlib/array/float64' );
75-
var floor = require( '@stdlib/math/base/special/floor' );
7671

7772
// Initial arrays...
7873
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -82,10 +77,8 @@ var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
8277
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8378
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
8479

85-
var N = floor( x0.length / 2 );
86-
8780
// Swap in reverse order every other value from `x1` with `y1`...
88-
gswap( N, x1, -2, y1, 1 );
81+
gswap( 3, x1, -2, y1, 1 );
8982
// x0 => <Float64Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
9083
// y0 => <Float64Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
9184
```
@@ -112,15 +105,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
112105

113106
```javascript
114107
var Float64Array = require( '@stdlib/array/float64' );
115-
var floor = require( '@stdlib/math/base/special/floor' );
116108

117109
var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
118110
var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
119111

120-
var N = floor( x.length / 2 );
121-
122-
gswap.ndarray( N, x, 2, 1, y, -1, y.length-1 );
123-
// x => <Float64Array>[ 1.0, 12.0, 11.0, 10.0, 5.0, 6.0 ]
112+
gswap.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
113+
// x => <Float64Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
124114
// y => <Float64Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
125115
```
126116

‎lib/node_modules/@stdlib/blas/base/sswap/README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,12 @@ The `N` and `stride` parameters determine how values from `x` and `y` are access
5757

5858
```javascript
5959
var Float32Array = require( '@stdlib/array/float32' );
60-
var floor = require( '@stdlib/math/base/special/floor' );
6160

6261
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6362
var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
6463

65-
var N = floor( x.length / 2 );
66-
67-
sswap( N, x, -2, y, 1 );
68-
// x => <Float32Array>[ 1.0, 7.0, 3.0, 8.0, 5.0, 9.0 ]
64+
sswap( 3, x, -2, y, 1 );
65+
// x => <Float32Array>[ 9.0, 2.0, 8.0, 4.0, 7.0, 6.0 ]
6966
// y => <Float32Array>[ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ]
7067
```
7168

@@ -75,7 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7572

7673
```javascript
7774
var Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

8076
// Initial arrays...
8177
var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -85,10 +81,8 @@ var y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
8581
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8682
var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
8783

88-
var N = floor( x0.length / 2 );
89-
9084
// Swap in reverse order every other value from `x1` with `y1`...
91-
sswap( N, x1, -2, y1, 1 );
85+
sswap( 3, x1, -2, y1, 1 );
9286
// x0 => <Float32Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
9387
// y0 => <Float32Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
9488
```
@@ -117,15 +111,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
117111

118112
```javascript
119113
var Float32Array = require( '@stdlib/array/float32' );
120-
var floor = require( '@stdlib/math/base/special/floor' );
121114

122115
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
123116
var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
124117

125-
var N = floor( x.length / 2 );
126-
127-
sswap.ndarray( N, x, 2, 1, y, -1, y.length-1 );
128-
// x => <Float32Array>[ 1.0, 12.0, 11.0, 10.0, 5.0, 6.0 ]
118+
sswap.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
119+
// x => <Float32Array>[ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ]
129120
// y => <Float32Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
130121
```
131122

0 commit comments

Comments
 (0)