Skip to content

Commit 8018140

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 0f0860e commit 8018140

14 files changed

Lines changed: 63 additions & 61 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<section class="release" id="unreleased">
66

7-
## Unreleased (2025-01-12)
7+
## Unreleased (2025-01-13)
88

99
<section class="packages">
1010

@@ -1094,6 +1094,8 @@ A total of 12 people contributed to this release. Thank you to the following con
10941094

10951095
<details>
10961096

1097+
- [`fd622e8`](https://github.com/stdlib-js/stdlib/commit/fd622e8948ffdf6a9a8d2809ed789a1fac20a79f) - **docs:** update examples _(by Athan Reines)_
1098+
- [`55f8f64`](https://github.com/stdlib-js/stdlib/commit/55f8f640e1001e7189b85406482b748ae7bc6a50) - **docs:** update examples _(by Athan Reines)_
10971099
- [`d9f8189`](https://github.com/stdlib-js/stdlib/commit/d9f8189f537a107f8247d2071bac26926ad60ca2) - **chore:** fix indentation _(by Philipp Burckhardt)_
10981100
- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - **feat:** update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706) _(by stdlib-bot)_
10991101
- [`cff470f`](https://github.com/stdlib-js/stdlib/commit/cff470f9608165100c8c122fce70c40b1af864ec) - **docs:** update namespace table of contents (#4708) _(by stdlib-bot, Planeshifter)_

‎base/mskfilter2/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Returns new arrays by applying a mask to two provided input arrays in a single p
3636

3737
```javascript
3838
var x = [ 1, 2, 3, 4 ];
39-
var idx = [ 0, 1, 2, 3 ];
39+
var y = [ 0, 1, 2, 3 ];
4040

41-
var out = mskfilter2( x, idx, [ 0, 1, 0, 1 ] );
41+
var out = mskfilter2( x, y, [ 0, 1, 0, 1 ] );
4242
// returns [ [ 2, 4 ], [ 1, 3 ] ]
4343
```
4444

@@ -79,8 +79,8 @@ var mskfilter2 = require( '@stdlib/array/base/mskfilter2' );
7979
var x = zeroTo( 20 );
8080
console.log( x );
8181

82-
var idx = zeroTo( x.length );
83-
console.log( idx );
82+
var y = zeroTo( x.length );
83+
console.log( y );
8484

8585
// Generate a random mask:
8686
var mask = bernoulli( x.length, 0.5, {
@@ -89,7 +89,7 @@ var mask = bernoulli( x.length, 0.5, {
8989
console.log( mask );
9090

9191
// Filter both arrays using the mask:
92-
var out = mskfilter2( x, idx, mask );
92+
var out = mskfilter2( x, y, mask );
9393
console.log( out );
9494
```
9595

‎base/mskfilter2/docs/repl.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
Examples
2828
--------
2929
> var x = [ 1, 2, 3, 4 ];
30-
> var idx = [ 0, 1, 2, 3 ];
31-
> var out = {{alias}}( x, idx, [ 0, 1, 0, 1 ] )
30+
> var y = [ 0, 1, 2, 3 ];
31+
> var out = {{alias}}( x, y, [ 0, 1, 0, 1 ] )
3232
[ [ 2, 4 ], [ 1, 3 ] ]
3333

3434
See Also

‎base/mskfilter2/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ import { Collection } from '@stdlib/types/array';
3232
*
3333
* @example
3434
* var x = [ 1, 2, 3, 4 ];
35-
* var idx = [ 5, 6, 7, 8 ];
35+
* var y = [ 5, 6, 7, 8 ];
3636
* var mask = [ 0, 1, 0, 1 ];
3737
*
38-
* var out = mskfilter2( x, idx, mask );
38+
* var out = mskfilter2( x, y, mask );
3939
* // returns [ [ 2, 4 ], [ 6, 8 ] ]
4040
*/
4141
declare function mskfilter2<T = unknown, U = unknown>( x: Collection<T>, y: Collection<U>, mask: Collection ): [ Array<T>, Array<U> ];

‎base/mskfilter2/examples/index.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ var mskfilter2 = require( './../lib' );
2626
var x = zeroTo( 20 );
2727
console.log( x );
2828

29-
var idx = zeroTo( x.length );
30-
console.log( idx );
29+
var y = zeroTo( x.length );
30+
console.log( y );
3131

3232
// Generate a random mask:
3333
var mask = bernoulli( x.length, 0.5, {
@@ -36,5 +36,5 @@ var mask = bernoulli( x.length, 0.5, {
3636
console.log( mask );
3737

3838
// Filter both arrays using the mask:
39-
var out = mskfilter2( x, idx, mask );
39+
var out = mskfilter2( x, y, mask );
4040
console.log( out );

‎base/mskfilter2/lib/index.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
* var mskfilter2 = require( '@stdlib/array/base/mskfilter2' );
2828
*
2929
* var x = [ 1, 2, 3, 4 ];
30-
* var idx = [ 5, 6, 7, 8 ];
30+
* var y = [ 5, 6, 7, 8 ];
3131
* var mask = [ 0, 1, 0, 1 ];
3232
*
33-
* var out = mskfilter2( x, idx, mask );
33+
* var out = mskfilter2( x, y, mask );
3434
* // returns [ [ 2, 4 ], [ 6, 8 ] ]
3535
*/
3636

‎base/mskfilter2/lib/main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ var resolveGetter = require( './../../../base/resolve-getter' );
3535
*
3636
* @example
3737
* var x = [ 1, 2, 3, 4 ];
38-
* var idx = [ 5, 6, 7, 8 ];
38+
* var y = [ 5, 6, 7, 8 ];
3939
* var mask = [ 0, 1, 0, 1 ];
4040
*
41-
* var out = mskfilter2( x, idx, mask );
41+
* var out = mskfilter2( x, y, mask );
4242
* // returns [ [ 2, 4 ], [ 6, 8 ] ]
4343
*/
4444
function mskfilter2( x, y, mask ) {

‎base/mskfilter2/test/test.main.js‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ tape( 'the function filters array elements', function test( t ) {
4040
var expected;
4141
var actual;
4242
var mask;
43-
var idx;
43+
var y;
4444
var x;
4545

4646
x = [ 1, 2, 3, 4 ];
47-
idx = [ 0, 1, 2, 3 ];
47+
y = [ 0, 1, 2, 3 ];
4848

4949
mask = [ 0, 1, 0, 1 ];
50-
actual = mskfilter2( x, idx, mask );
50+
actual = mskfilter2( x, y, mask );
5151

5252
t.strictEqual( isArray( actual ), true, 'returns expected value' );
5353
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -59,11 +59,11 @@ tape( 'the function filters array elements', function test( t ) {
5959
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
6060

6161
expected = [ 1, 3 ];
62-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
62+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
6363
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
6464

6565
mask = [ 0, 0, 0, 0 ];
66-
actual = mskfilter2( x, idx, mask );
66+
actual = mskfilter2( x, y, mask );
6767

6868
t.strictEqual( isArray( actual ), true, 'returns expected value' );
6969
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -75,11 +75,11 @@ tape( 'the function filters array elements', function test( t ) {
7575
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
7676

7777
expected = [];
78-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
78+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
7979
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
8080

8181
mask = [ 0, 0, 0, 1 ];
82-
actual = mskfilter2( x, idx, mask );
82+
actual = mskfilter2( x, y, mask );
8383

8484
t.strictEqual( isArray( actual ), true, 'returns expected value' );
8585
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -91,11 +91,11 @@ tape( 'the function filters array elements', function test( t ) {
9191
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
9292

9393
expected = [ 3 ];
94-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
94+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
9595
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
9696

9797
mask = [ 1, 1, 1, 1 ];
98-
actual = mskfilter2( x, idx, mask );
98+
actual = mskfilter2( x, y, mask );
9999

100100
t.strictEqual( isArray( actual ), true, 'returns expected value' );
101101
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -107,7 +107,7 @@ tape( 'the function filters array elements', function test( t ) {
107107
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
108108

109109
expected = [ 0, 1, 2, 3 ];
110-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
110+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
111111
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
112112

113113
t.end();
@@ -117,14 +117,14 @@ tape( 'the function filters array elements (accessors)', function test( t ) {
117117
var expected;
118118
var actual;
119119
var mask;
120-
var idx;
120+
var y;
121121
var x;
122122
var i;
123123

124124
x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
125-
idx = [ 0, 1, 2, 3 ];
125+
y = [ 0, 1, 2, 3 ];
126126
mask = [ 0, 1, 0, 1 ];
127-
actual = mskfilter2( x, idx, mask );
127+
actual = mskfilter2( x, y, mask );
128128

129129
t.strictEqual( isArray( actual ), true, 'returns expected value' );
130130
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -139,9 +139,9 @@ tape( 'the function filters array elements (accessors)', function test( t ) {
139139
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
140140

141141
x = new BooleanArray( [ true, false, false, true ] );
142-
idx = [ 0, 1, 2, 3 ];
142+
y = [ 0, 1, 2, 3 ];
143143
mask = [ 0, 1, 0, 1 ];
144-
actual = mskfilter2( x, idx, mask );
144+
actual = mskfilter2( x, y, mask );
145145

146146
t.strictEqual( isArray( actual ), true, 'returns expected value' );
147147
t.strictEqual( actual.length, 2, 'returns expected value' );

‎base/mskfiltern/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Returns new arrays by applying a mask to one or more provided input arrays in a
3636

3737
```javascript
3838
var x = [ 1, 2, 3, 4 ];
39-
var idx = [ 0, 1, 2, 3 ];
39+
var y = [ 0, 1, 2, 3 ];
4040

41-
var out = mskfiltern( x, idx, [ 0, 1, 0, 1 ] );
41+
var out = mskfiltern( x, y, [ 0, 1, 0, 1 ] );
4242
// returns [ [ 2, 4 ], [ 1, 3 ] ]
4343
```
4444

@@ -79,8 +79,8 @@ var mskfiltern = require( '@stdlib/array/base/mskfiltern' );
7979
var x = zeroTo( 20 );
8080
console.log( x );
8181

82-
var idx = zeroTo( x.length );
83-
console.log( idx );
82+
var y = zeroTo( x.length );
83+
console.log( y );
8484

8585
// Generate a random mask:
8686
var mask = bernoulli( x.length, 0.5, {
@@ -89,7 +89,7 @@ var mask = bernoulli( x.length, 0.5, {
8989
console.log( mask );
9090

9191
// Filter both arrays using the mask:
92-
var out = mskfiltern( x, idx, mask );
92+
var out = mskfiltern( x, y, mask );
9393
console.log( out );
9494
```
9595

‎base/mskfiltern/docs/repl.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
Examples
2828
--------
2929
> var x = [ 1, 2, 3, 4 ];
30-
> var idx = [ 0, 1, 2, 3 ];
31-
> var out = {{alias}}( x, idx, [ 0, 1, 0, 1 ] )
30+
> var y = [ 0, 1, 2, 3 ];
31+
> var out = {{alias}}( x, y, [ 0, 1, 0, 1 ] )
3232
[ [ 2, 4 ], [ 1, 3 ] ]
3333

3434
See Also

0 commit comments

Comments
 (0)