Skip to content

Commit 6f347cc

Browse files
iampratik13iampratik13
committed
chore: suggested changes
1 parent 19e6a35 commit 6f347cc

14 files changed

Lines changed: 246 additions & 271 deletions

File tree

‎lib/node_modules/@stdlib/stats/strided/selmax/README.md‎

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2020 The Stdlib Authors.
5+
Copyright (c) 2026 The Stdlib Authors.
66
77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ Computes the maximum value of a strided array by selecting elements according to
4242

4343
```javascript
4444
var x = [ 1.0, -2.0, 4.0, 2.0 ];
45-
var mask = [ 1, 1, 0, 1 ];
45+
var mask = [ true, true, false, true ];
4646

4747
var v = selmax( x.length, x, 1, mask, 1 );
4848
// returns 2.0
@@ -60,15 +60,15 @@ The `N` and stride parameters determine which elements in the strided arrays are
6060

6161
```javascript
6262
var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0 ];
63-
var mask = [ 1, 1, 1, 1, 1, 1, 0, 0 ];
63+
var mask = [ true, true, true, true, true, true, false, false ];
6464

6565
var v = selmax( 4, x, 2, mask, 2 );
6666
// returns 4.0
6767
```
6868

6969
Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views.
7070

71-
<!-- eslint-disable stdlib/capitalized-comments -->
71+
<!-- eslint-disable stdlib/capitalized-comments, max-len -->
7272

7373
```javascript
7474
var Float64Array = require( '@stdlib/array/float64' );
@@ -77,9 +77,7 @@ var BooleanArray = require( '@stdlib/array/bool' );
7777
var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
7878
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
7979

80-
var mask0 = new BooleanArray([
81-
true, true, true, true, true, true, false, false
82-
]);
80+
var mask0 = new BooleanArray( [ true, true, true, true, true, true, false, false ] );
8381
var mask1 = new BooleanArray( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );
8482

8583
var v = selmax( 4, x1, 2, mask1, 2 );
@@ -92,7 +90,7 @@ Computes the maximum value of a strided array by selecting elements according to
9290

9391
```javascript
9492
var x = [ 1.0, -2.0, 4.0, 2.0 ];
95-
var mask = [ 1, 1, 0, 1 ];
93+
var mask = [ true, true, false, true ];
9694

9795
var v = selmax.ndarray( x.length, x, 1, 0, mask, 1, 0 );
9896
// returns 2.0
@@ -107,7 +105,7 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
107105

108106
```javascript
109107
var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ];
110-
var mask = [ 1, 1, 1, 1, 1, 1, 0, 0 ];
108+
var mask = [ true, true, true, true, true, true, false, false ];
111109

112110
var v = selmax.ndarray( 4, x, 2, 1, mask, 2, 1 );
113111
// returns 4.0
@@ -137,16 +135,15 @@ var v = selmax.ndarray( 4, x, 2, 1, mask, 2, 1 );
137135
```javascript
138136
var uniform = require( '@stdlib/random/array/uniform' );
139137
var bernoulli = require( '@stdlib/random/array/bernoulli' );
138+
var BooleanArray = require( '@stdlib/array/bool' );
140139
var selmax = require( '@stdlib/stats/strided/selmax' );
141140

142141
var x = uniform( 10, -50.0, 50.0, {
143142
'dtype': 'float64'
144143
});
145144
console.log( x );
146145

147-
var mask = bernoulli( x.length, 0.8, {
148-
'dtype': 'generic'
149-
});
146+
var mask = new BooleanArray( bernoulli( x.length, 0.8 ) );
150147
console.log( mask );
151148

152149
var v = selmax( x.length, x, 1, mask, 1 );
@@ -161,14 +158,6 @@ console.log( v );
161158

162159
<section class="related">
163160

164-
* * *
165-
166-
## See Also
167-
168-
- <span class="package-name">[`@stdlib/stats/strided/max`][@stdlib/stats/strided/max]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array.</span>
169-
- <span class="package-name">[`@stdlib/stats/strided/mskmax`][@stdlib/stats/strided/mskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array according to a mask.</span>
170-
- <span class="package-name">[`@stdlib/stats/strided/nanmax`][@stdlib/stats/strided/nanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array, ignoring NaN values.</span>
171-
172161
</section>
173162

174163
<!-- /.related -->
@@ -185,12 +174,6 @@ console.log( v );
185174

186175
<!-- <related-links> -->
187176

188-
[@stdlib/stats/strided/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/max
189-
190-
[@stdlib/stats/strided/mskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmax
191-
192-
[@stdlib/stats/strided/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmax
193-
194177
<!-- </related-links> -->
195178

196179
</section>

‎lib/node_modules/@stdlib/stats/strided/selmax/benchmark/benchmark.js‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2026 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -24,19 +24,13 @@ var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var uniform = require( '@stdlib/random/array/uniform' );
2626
var bernoulli = require( '@stdlib/random/array/bernoulli' );
27+
var BooleanArray = require( '@stdlib/array/bool' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
2829
var format = require( '@stdlib/string/format' );
2930
var pkg = require( './../package.json' ).name;
3031
var selmax = require( './../lib' );
3132

3233

33-
// VARIABLES //
34-
35-
var options = {
36-
'dtype': 'generic'
37-
};
38-
39-
4034
// FUNCTIONS //
4135

4236
/**
@@ -47,8 +41,10 @@ var options = {
4741
* @returns {Function} benchmark function
4842
*/
4943
function createBenchmark( len ) {
50-
var mask = bernoulli( len, 0.8, options );
51-
var x = uniform( len, -10.0, 10.0, options );
44+
var mask = new BooleanArray( bernoulli( len, 0.8 ) );
45+
var x = uniform( len, -10.0, 10.0, {
46+
'dtype': 'generic'
47+
});
5248
return benchmark;
5349

5450
/**

‎lib/node_modules/@stdlib/stats/strided/selmax/benchmark/benchmark.ndarray.js‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2026 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -24,19 +24,13 @@ var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var uniform = require( '@stdlib/random/array/uniform' );
2626
var bernoulli = require( '@stdlib/random/array/bernoulli' );
27+
var BooleanArray = require( '@stdlib/array/bool' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
2829
var format = require( '@stdlib/string/format' );
2930
var pkg = require( './../package.json' ).name;
3031
var selmax = require( './../lib/ndarray.js' );
3132

3233

33-
// VARIABLES //
34-
35-
var options = {
36-
'dtype': 'generic'
37-
};
38-
39-
4034
// FUNCTIONS //
4135

4236
/**
@@ -47,8 +41,10 @@ var options = {
4741
* @returns {Function} benchmark function
4842
*/
4943
function createBenchmark( len ) {
50-
var mask = bernoulli( len, 0.8, options );
51-
var x = uniform( len, -10.0, 10.0, options );
44+
var mask = new BooleanArray( bernoulli( len, 0.8 ) );
45+
var x = uniform( len, -10.0, 10.0, {
46+
'dtype': 'generic'
47+
});
5248
return benchmark;
5349

5450
/**

‎lib/node_modules/@stdlib/stats/strided/selmax/docs/repl.txt‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
strideX: integer
2929
Stride length for `x`.
3030

31-
mask: Array<number>|TypedArray
31+
mask: Array|TypedArray
3232
Mask array.
3333

3434
strideMask: integer
@@ -43,22 +43,24 @@
4343
--------
4444
// Standard Usage:
4545
> var x = [ 1.0, -2.0, 4.0, 2.0 ];
46-
> var mask = [ 1, 1, 0, 1 ];
46+
> var mask = [ true, true, false, true ];
4747
> {{alias}}( x.length, x, 1, mask, 1 )
4848
2.0
4949

5050
// Using `N` and stride parameters:
5151
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ];
52-
> mask = [ 1, 1, 1, 1, 1, 1, 0 ];
52+
> mask = [ true, true, true, true, true, true, false ];
5353
> {{alias}}( 3, x, 2, mask, 2 )
5454
2.0
5555

5656
// Using view offsets:
57-
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] );
58-
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
59-
> var mask0 = new {{alias:@stdlib/array/uint8}}( [ 1, 1, 1, 1, 1, 1, 0 ] );
60-
> var mask1 = new {{alias:@stdlib/array/uint8}}( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );
61-
> {{alias}}( 3, x1, 2, mask1, 2 )
57+
> var Float64Array = {{alias:@stdlib/array/float64}};
58+
> var x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
59+
> var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
60+
> var BooleanArray = {{alias:@stdlib/array/bool}};
61+
> var m0 = new BooleanArray( [ true, true, true, true, true, false ] );
62+
> var m1 = new BooleanArray( m0.buffer, m0.BYTES_PER_ELEMENT*1 );
63+
> {{alias}}( 2, x1, 2, m1, 2 )
6264
2.0
6365

6466

@@ -84,7 +86,7 @@
8486
offsetX: integer
8587
Starting index for `x`.
8688

87-
mask: Array<number>|TypedArray
89+
mask: Array|TypedArray
8890
Mask array.
8991

9092
strideMask: integer
@@ -102,13 +104,13 @@
102104
--------
103105
// Standard Usage:
104106
> var x = [ 1.0, -2.0, 2.0, 4.0 ];
105-
> var mask = [ 1, 1, 1, 0 ];
107+
> var mask = [ true, true, true, false ];
106108
> {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 )
107109
2.0
108110

109111
// Using offset parameter:
110112
> x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ];
111-
> mask = [ 1, 1, 1, 1, 1, 1, 0 ];
113+
> mask = [ true, true, true, true, true, true, false ];
112114
> {{alias}}.ndarray( 3, x, 2, 1, mask, 2, 1 )
113115
2.0
114116

‎lib/node_modules/@stdlib/stats/strided/selmax/docs/types/index.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2026 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -30,7 +30,7 @@ type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
3030
/**
3131
* Mask array.
3232
*/
33-
type MaskArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
33+
type MaskArray = Collection<unknown> | AccessorArrayLike<unknown>;
3434

3535
/**
3636
* Interface describing `selmax`.
@@ -48,7 +48,7 @@ interface Routine {
4848
*
4949
* @example
5050
* var x = [ 1.0, -2.0, 4.0, 2.0 ];
51-
* var mask = [ 1, 1, 0, 1 ];
51+
* var mask = [ true, true, false, true ];
5252
*
5353
* var v = selmax( x.length, x, 1, mask, 1 );
5454
* // returns 2.0
@@ -69,7 +69,7 @@ interface Routine {
6969
*
7070
* @example
7171
* var x = [ 1.0, -2.0, 4.0, 2.0 ];
72-
* var mask = [ 1, 1, 0, 1 ];
72+
* var mask = [ true, true, false, true ];
7373
*
7474
* var v = selmax.ndarray( x.length, x, 1, 0, mask, 1, 0 );
7575
* // returns 2.0
@@ -89,14 +89,14 @@ interface Routine {
8989
*
9090
* @example
9191
* var x = [ 1.0, -2.0, 4.0, 2.0 ];
92-
* var mask = [ 1, 1, 0, 1 ];
92+
* var mask = [ true, true, false, true ];
9393
*
9494
* var v = selmax( x.length, x, 1, mask, 1 );
9595
* // returns 2.0
9696
*
9797
* @example
9898
* var x = [ 1.0, -2.0, 4.0, 2.0 ];
99-
* var mask = [ 1, 1, 0, 1 ];
99+
* var mask = [ true, true, false, true ];
100100
*
101101
* var v = selmax.ndarray( x.length, x, 1, 0, mask, 1, 0 );
102102
* // returns 2.0

0 commit comments

Comments
 (0)