Skip to content

Commit 55f8f64

Browse files
committed
docs: update examples
Ref: 8dfa8c0#r151217188 --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 998c1be commit 55f8f64

File tree

6 files changed

+29
-29
lines changed

6 files changed

+29
-29
lines changed

lib/node_modules/@stdlib/array/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

lib/node_modules/@stdlib/array/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

lib/node_modules/@stdlib/array/base/mskfiltern/examples/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ var mskfiltern = 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 = mskfiltern( x, idx, mask );
39+
var out = mskfiltern( x, y, mask );
4040
console.log( out );

lib/node_modules/@stdlib/array/base/mskfiltern/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
* var mskfiltern = require( '@stdlib/array/base/mskfiltern' );
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 = mskfiltern( x, idx, mask );
33+
* var out = mskfiltern( x, y, mask );
3434
* // returns [ [ 2, 4 ], [ 6, 8 ] ]
3535
*/
3636

lib/node_modules/@stdlib/array/base/mskfiltern/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ var resolveGetter = require( '@stdlib/array/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 = mskfiltern( x, idx, mask );
41+
* var out = mskfiltern( x, y, mask );
4242
* // returns [ [ 2, 4 ], [ 6, 8 ] ]
4343
*/
4444
function mskfiltern() {

lib/node_modules/@stdlib/array/base/mskfiltern/test/test.main.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ tape( 'the function filters array elements (2 arrays)', function test( t ) {
9595
var expected;
9696
var actual;
9797
var mask;
98-
var idx;
98+
var y;
9999
var x;
100100

101101
x = [ 1, 2, 3, 4 ];
102-
idx = [ 0, 1, 2, 3 ];
102+
y = [ 0, 1, 2, 3 ];
103103

104104
mask = [ 0, 1, 0, 1 ];
105-
actual = mskfiltern( x, idx, mask );
105+
actual = mskfiltern( x, y, mask );
106106

107107
t.strictEqual( isArray( actual ), true, 'returns expected value' );
108108
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -114,11 +114,11 @@ tape( 'the function filters array elements (2 arrays)', function test( t ) {
114114
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
115115

116116
expected = [ 1, 3 ];
117-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
117+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
118118
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
119119

120120
mask = [ 0, 0, 0, 0 ];
121-
actual = mskfiltern( x, idx, mask );
121+
actual = mskfiltern( x, y, mask );
122122

123123
t.strictEqual( isArray( actual ), true, 'returns expected value' );
124124
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -130,11 +130,11 @@ tape( 'the function filters array elements (2 arrays)', function test( t ) {
130130
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
131131

132132
expected = [];
133-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
133+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
134134
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
135135

136136
mask = [ 0, 0, 0, 1 ];
137-
actual = mskfiltern( x, idx, mask );
137+
actual = mskfiltern( x, y, mask );
138138

139139
t.strictEqual( isArray( actual ), true, 'returns expected value' );
140140
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -146,11 +146,11 @@ tape( 'the function filters array elements (2 arrays)', function test( t ) {
146146
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
147147

148148
expected = [ 3 ];
149-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
149+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
150150
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
151151

152152
mask = [ 1, 1, 1, 1 ];
153-
actual = mskfiltern( x, idx, mask );
153+
actual = mskfiltern( x, y, mask );
154154

155155
t.strictEqual( isArray( actual ), true, 'returns expected value' );
156156
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -162,7 +162,7 @@ tape( 'the function filters array elements (2 arrays)', function test( t ) {
162162
t.deepEqual( actual[ 0 ], expected, 'returns expected value' );
163163

164164
expected = [ 0, 1, 2, 3 ];
165-
t.notEqual( actual[ 1 ], idx, 'returns expected value' );
165+
t.notEqual( actual[ 1 ], y, 'returns expected value' );
166166
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
167167

168168
t.end();
@@ -208,14 +208,14 @@ tape( 'the function filters array elements (2 arrays; accessors)', function test
208208
var expected;
209209
var actual;
210210
var mask;
211-
var idx;
211+
var y;
212212
var x;
213213
var i;
214214

215215
x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
216-
idx = [ 0, 1, 2, 3 ];
216+
y = [ 0, 1, 2, 3 ];
217217
mask = [ 0, 1, 0, 1 ];
218-
actual = mskfiltern( x, idx, mask );
218+
actual = mskfiltern( x, y, mask );
219219

220220
t.strictEqual( isArray( actual ), true, 'returns expected value' );
221221
t.strictEqual( actual.length, 2, 'returns expected value' );
@@ -230,9 +230,9 @@ tape( 'the function filters array elements (2 arrays; accessors)', function test
230230
t.deepEqual( actual[ 1 ], expected, 'returns expected value' );
231231

232232
x = new BooleanArray( [ true, false, false, true ] );
233-
idx = [ 0, 1, 2, 3 ];
233+
y = [ 0, 1, 2, 3 ];
234234
mask = [ 0, 1, 0, 1 ];
235-
actual = mskfiltern( x, idx, mask );
235+
actual = mskfiltern( x, y, mask );
236236

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

0 commit comments

Comments
 (0)