Skip to content

Commit cf55886

Browse files
committed
added readme
1 parent 88d8d24 commit cf55886

File tree

1 file changed

+7
-20
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/sasumpw

1 file changed

+7
-20
lines changed

lib/node_modules/@stdlib/blas/ext/base/sasumpw/README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,14 @@ The function has the following parameters:
7171
- **x**: input [`Float32Array`][@stdlib/array/float32].
7272
- **stride**: index increment for `x`.
7373

74-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of absolute values of every other element in `x`,
74+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of absolute values of every other element in `x`,
7575

7676
```javascript
7777
var Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7978

8079
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
81-
var N = floor( x.length / 2 );
8280

83-
var v = sasumpw( N, x, 2 );
81+
var v = sasumpw( 4, x, 2 );
8482
// returns 9.0
8583
```
8684

@@ -90,14 +88,12 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9088

9189
```javascript
9290
var Float32Array = require( '@stdlib/array/float32' );
93-
var floor = require( '@stdlib/math/base/special/floor' );
9491

9592
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
9693
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9794

98-
var N = floor( x0.length / 2 );
9995

100-
var v = sasumpw( N, x1, 2 );
96+
var v = sasumpw( 4, x1, 2 );
10197
// returns 9.0
10298
```
10399

@@ -123,12 +119,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
123119

124120
```javascript
125121
var Float32Array = require( '@stdlib/array/float32' );
126-
var floor = require( '@stdlib/math/base/special/floor' );
127122

128123
var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
129-
var N = floor( x.length / 2 );
130124

131-
var v = sasumpw.ndarray( N, x, 2, 1 );
125+
var v = sasumpw.ndarray( 4, x, 2, 1 );
132126
// returns 9.0
133127
```
134128

@@ -154,18 +148,11 @@ var v = sasumpw.ndarray( N, x, 2, 1 );
154148
<!-- eslint no-undef: "error" -->
155149

156150
```javascript
157-
var randu = require( '@stdlib/random/base/randu' );
158-
var round = require( '@stdlib/math/base/special/round' );
159-
var Float32Array = require( '@stdlib/array/float32' );
151+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
152+
var filledarrayBy = require( '@stdlib/array/filled-by' );
160153
var sasumpw = require( '@stdlib/blas/ext/base/sasumpw' );
161154

162-
var x;
163-
var i;
164-
165-
x = new Float32Array( 10 );
166-
for ( i = 0; i < x.length; i++ ) {
167-
x[ i ] = round( randu()*100.0 );
168-
}
155+
var x = filledarrayBy(10, 'float32', discreteUniform(0, 100));
169156
console.log( x );
170157

171158
var v = sasumpw( x.length, x, 1 );

0 commit comments

Comments
 (0)