Skip to content

Commit c2ce045

Browse files
committed
refactor benchmark
--- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: ---
1 parent aab2efb commit c2ce045

File tree

2 files changed

+17
-29
lines changed

2 files changed

+17
-29
lines changed

lib/node_modules/@stdlib/stats/base/range/README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The [**range**][range] is defined as the difference between the maximum and mini
3838
var range = require( '@stdlib/stats/base/range' );
3939
```
4040

41-
#### range( N, x, stride )
41+
#### range( N, x, strideX )
4242

4343
Computes the [range][range] of a strided array `x`.
4444

@@ -54,17 +54,15 @@ The function has the following parameters:
5454

5555
- **N**: number of indexed elements.
5656
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
57-
- **stride**: index increment for `x`.
57+
- **strideX**: stride length for `x`.
5858

59-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
59+
The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
6060

6161
```javascript
62-
var floor = require( '@stdlib/math/base/special/floor' );
6362

6463
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
65-
var N = floor( x.length / 2 );
6664

67-
var v = range( N, x, 2 );
65+
var v = range( 4, x, 2 );
6866
// returns 6.0
6967
```
7068

@@ -74,18 +72,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7472

7573
```javascript
7674
var Float64Array = require( '@stdlib/array/float64' );
77-
var floor = require( '@stdlib/math/base/special/floor' );
7875

7976
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
8077
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8178

82-
var N = floor( x0.length / 2 );
83-
84-
var v = range( N, x1, 2 );
79+
var v = range( 4, x1, 2 );
8580
// returns 6.0
8681
```
8782

88-
#### range.ndarray( N, x, stride, offset )
83+
#### range.ndarray( N, x, strideX, offsetX )
8984

9085
Computes the [range][range] of a strided array using alternative indexing semantics.
9186

@@ -99,17 +94,15 @@ var v = range.ndarray( N, x, 1, 0 );
9994

10095
The function has the following additional parameters:
10196

102-
- **offset**: starting index for `x`.
97+
- **offsetX**: starting index for `x`.
10398

104-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the [range][range] for every other value in `x` starting from the second value
99+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [range][range] for every other value in `x` starting from the second value
105100

106101
```javascript
107-
var floor = require( '@stdlib/math/base/special/floor' );
108102

109103
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
110-
var N = floor( x.length / 2 );
111104

112-
var v = range.ndarray( N, x, 2, 1 );
105+
var v = range.ndarray( 4, x, 2, 1 );
113106
// returns 6.0
114107
```
115108

@@ -123,6 +116,7 @@ var v = range.ndarray( N, x, 2, 1 );
123116

124117
- If `N <= 0`, both functions return `NaN`.
125118
- Depending on the environment, the typed versions ([`drange`][@stdlib/stats/base/drange], [`srange`][@stdlib/stats/base/srange], etc.) are likely to be significantly more performant.
119+
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
126120

127121
</section>
128122

@@ -137,16 +131,14 @@ var v = range.ndarray( N, x, 2, 1 );
137131
```javascript
138132
var randu = require( '@stdlib/random/base/randu' );
139133
var round = require( '@stdlib/math/base/special/round' );
140-
var Float64Array = require( '@stdlib/array/float64' );
134+
var linspace = require( '@stdlib/array/base/linspace' );
141135
var range = require( '@stdlib/stats/base/range' );
142136

143137
var x;
144138
var i;
145139

146-
x = new Float64Array( 10 );
147-
for ( i = 0; i < x.length; i++ ) {
148-
x[ i ] = round( (randu()*100.0) - 50.0 );
149-
}
140+
x = linspace(-50, 50, 10);
141+
x = x.map(round);
150142
console.log( x );
151143

152144
var v = range( x.length, x, 1 );
@@ -185,6 +177,8 @@ console.log( v );
185177

186178
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
187179

180+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
181+
188182
<!-- <related-links> -->
189183

190184
[@stdlib/stats/base/drange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/drange

lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
2524
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25+
var linspace = require( '@stdlib/array/linspace/docs/types/index' );
2626
var pow = require( '@stdlib/math/base/special/pow' );
2727
var pkg = require( './../package.json' ).name;
2828
var range = require( './../lib/range.js' );
@@ -38,13 +38,7 @@ var range = require( './../lib/range.js' );
3838
* @returns {Function} benchmark function
3939
*/
4040
function createBenchmark( len ) {
41-
var x;
42-
var i;
43-
44-
x = [];
45-
for ( i = 0; i < len; i++ ) {
46-
x.push( ( randu()*20.0 ) - 10.0 );
47-
}
41+
var x = linspace( 0.0, len, len );
4842
return benchmark;
4943

5044
function benchmark( b ) {

0 commit comments

Comments
 (0)