Skip to content

Commit bc03303

Browse files
committed
Auto-generated commit
1 parent c1f3333 commit bc03303

File tree

16 files changed

+445
-134
lines changed

16 files changed

+445
-134
lines changed

CHANGELOG.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,37 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2025-07-01)
7+
## Unreleased (2025-07-05)
8+
9+
<section class="features">
10+
11+
### Features
12+
13+
- [`c72df63`](https://github.com/stdlib-js/stdlib/commit/c72df63c4127781fd86c0fb3073b01b3db272223) - add support for accessor arrays and refactor `stats/base/stdevwd` [(#6527)](https://github.com/stdlib-js/stdlib/pull/6527)
14+
15+
</section>
16+
17+
<!-- /.features -->
18+
19+
<section class="issues">
20+
21+
### Closed Issues
22+
23+
This release closes the following issue:
24+
25+
[#5685](https://github.com/stdlib-js/stdlib/issues/5685)
26+
27+
</section>
28+
29+
<!-- /.issues -->
830

931
<section class="commits">
1032

1133
### Commits
1234

1335
<details>
1436

37+
- [`c72df63`](https://github.com/stdlib-js/stdlib/commit/c72df63c4127781fd86c0fb3073b01b3db272223) - **feat:** add support for accessor arrays and refactor `stats/base/stdevwd` [(#6527)](https://github.com/stdlib-js/stdlib/pull/6527) _(by Arihant Pal, Athan Reines, stdlib-bot, Gururaj Gurram)_
1538
- [`7088dfa`](https://github.com/stdlib-js/stdlib/commit/7088dfa1cab0860d25b5a0feb649ec572cbc1e98) - **refactor:** update paths _(by Gururaj Gurram)_
1639
- [`6ff81eb`](https://github.com/stdlib-js/stdlib/commit/6ff81eb876b628462c4a029a0392fcf8e2aff2bf) - **refactor:** update paths _(by Aayush Khanna)_
1740

@@ -25,9 +48,11 @@
2548

2649
### Contributors
2750

28-
A total of 2 people contributed to this release. Thank you to the following contributors:
51+
A total of 4 people contributed to this release. Thank you to the following contributors:
2952

3053
- Aayush Khanna
54+
- Arihant Pal
55+
- Athan Reines
3156
- Gururaj Gurram
3257

3358
</section>

README.md

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,9 @@ To view installation and usage instructions specific to each branch build, be su
131131
var stdevwd = require( '@stdlib/stats-base-stdevwd' );
132132
```
133133

134-
#### stdevwd( N, correction, x, stride )
134+
#### stdevwd( N, correction, x, strideX )
135135

136-
Computes the [standard deviation][standard-deviation] of a strided array `x` using Welford's algorithm.
136+
Computes the [standard deviation][standard-deviation] of a strided array using Welford's algorithm.
137137

138138
```javascript
139139
var x = [ 1.0, -2.0, 2.0 ];
@@ -147,17 +147,14 @@ The function has the following parameters:
147147
- **N**: number of indexed elements.
148148
- **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction).
149149
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
150-
- **stride**: index increment for `x`.
150+
- **strideX**: stride length for `x`.
151151

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

154154
```javascript
155-
var floor = require( '@stdlib/math-base-special-floor' );
156-
157155
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
158-
var N = floor( x.length / 2 );
159156

160-
var v = stdevwd( N, 1, x, 2 );
157+
var v = stdevwd( 4, 1, x, 2 );
161158
// returns 2.5
162159
```
163160

@@ -167,18 +164,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [
167164

168165
```javascript
169166
var Float64Array = require( '@stdlib/array-float64' );
170-
var floor = require( '@stdlib/math-base-special-floor' );
171167

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

175-
var N = floor( x0.length / 2 );
176-
177-
var v = stdevwd( N, 1, x1, 2 );
171+
var v = stdevwd( 4, 1, x1, 2 );
178172
// returns 2.5
179173
```
180174

181-
#### stdevwd.ndarray( N, correction, x, stride, offset )
175+
#### stdevwd.ndarray( N, correction, x, strideX, offsetX )
182176

183177
Computes the [standard deviation][standard-deviation] of a strided array using Welford's algorithm and alternative indexing semantics.
184178

@@ -191,17 +185,14 @@ var v = stdevwd.ndarray( x.length, 1, x, 1, 0 );
191185

192186
The function has the following additional parameters:
193187

194-
- **offset**: starting index for `x`.
188+
- **offsetX**: starting index for `x`.
195189

196-
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 [standard deviation][standard-deviation] for every other value in `x` starting from the second value
190+
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 [standard deviation][standard-deviation] for every other element in the strided array starting from the second element
197191

198192
```javascript
199-
var floor = require( '@stdlib/math-base-special-floor' );
200-
201193
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
202-
var N = floor( x.length / 2 );
203194

204-
var v = stdevwd.ndarray( N, 1, x, 2, 1 );
195+
var v = stdevwd.ndarray( 4, 1, x, 2, 1 );
205196
// returns 2.5
206197
```
207198

@@ -215,6 +206,7 @@ var v = stdevwd.ndarray( N, 1, x, 2, 1 );
215206

216207
- If `N <= 0`, both functions return `NaN`.
217208
- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return `NaN`.
209+
- 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]).
218210
- Depending on the environment, the typed versions ([`dstdevwd`][@stdlib/stats/strided/dstdevwd], [`sstdevwd`][@stdlib/stats/base/sstdevwd], etc.) are likely to be significantly more performant.
219211

220212
</section>
@@ -228,18 +220,12 @@ var v = stdevwd.ndarray( N, 1, x, 2, 1 );
228220
<!-- eslint no-undef: "error" -->
229221

230222
```javascript
231-
var randu = require( '@stdlib/random-base-randu' );
232-
var round = require( '@stdlib/math-base-special-round' );
233-
var Float64Array = require( '@stdlib/array-float64' );
223+
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
234224
var stdevwd = require( '@stdlib/stats-base-stdevwd' );
235225

236-
var x;
237-
var i;
238-
239-
x = new Float64Array( 10 );
240-
for ( i = 0; i < x.length; i++ ) {
241-
x[ i ] = round( (randu()*100.0) - 50.0 );
242-
}
226+
var x = discreteUniform( 10, -50, 50, {
227+
'dtype': 'float64'
228+
});
243229
console.log( x );
244230

245231
var v = stdevwd( x.length, 1, x, 1 );
@@ -359,6 +345,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
359345

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

348+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor
349+
362350
[@welford:1962a]: https://doi.org/10.1080/00401706.1962.10490022
363351

364352
[@vanreeken:1968a]: https://doi.org/10.1145/362929.362961

benchmark/benchmark.js

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,18 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench-harness' );
24-
var randu = require( '@stdlib/random-base-randu' );
24+
var uniform = require( '@stdlib/random-array-uniform' );
2525
var isnan = require( '@stdlib/math-base-assert-is-nan' );
2626
var pow = require( '@stdlib/math-base-special-pow' );
2727
var pkg = require( './../package.json' ).name;
28-
var stdevwd = require( './../lib/stdevwd.js' );
28+
var stdevwd = require( './../lib/main.js' );
29+
30+
31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'generic'
35+
};
2936

3037

3138
// FUNCTIONS //
@@ -38,13 +45,7 @@ var stdevwd = require( './../lib/stdevwd.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
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-
}
48+
var x = uniform( len, -10, 10, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

benchmark/benchmark.ndarray.js

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

2323
var bench = require( '@stdlib/bench-harness' );
24-
var randu = require( '@stdlib/random-base-randu' );
24+
var uniform = require( '@stdlib/random-array-uniform' );
2525
var isnan = require( '@stdlib/math-base-assert-is-nan' );
2626
var pow = require( '@stdlib/math-base-special-pow' );
2727
var pkg = require( './../package.json' ).name;
2828
var stdevwd = require( './../lib/ndarray.js' );
2929

3030

31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'generic'
35+
};
36+
37+
3138
// FUNCTIONS //
3239

3340
/**
@@ -38,13 +45,7 @@ var stdevwd = require( './../lib/ndarray.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
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-
}
48+
var x = uniform( len, -10, 10, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

dist/index.js

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)