Skip to content

Commit e5d32c5

Browse files
committed
chore: minor clean-up
1 parent 9798530 commit e5d32c5

File tree

6 files changed

+161
-189
lines changed

6 files changed

+161
-189
lines changed

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

Lines changed: 59 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -390,35 +390,35 @@ var count = context.count;
390390
// returns 3
391391
```
392392

393-
<a name="method-for-each"></a>
393+
<a name="method-filter"></a>
394394

395-
#### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )
395+
#### TypedArrayFE.prototype.filter( predicate\[, thisArg] )
396396

397-
Invokes a function once for each array element.
397+
Returns a new array containing the elements of an array which pass a test implemented by a predicate function.
398398

399399
```javascript
400-
function log( v, i ) {
401-
console.log( '%s: %s', i.toString(), v.toString() );
400+
function predicate( v ) {
401+
return ( v % 2 === 0 );
402402
}
403403

404404
var Float64ArrayFE = fixedEndianFactory( 'float64' );
405405

406-
var arr = new Float64ArrayFE( 'little-endian', 3 );
406+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
407+
408+
var out = arr.filter( predicate );
407409
// returns <Float64ArrayFE>
408410

409-
arr.set( 1.5, 0 );
410-
arr.set( 2.5, 1 );
411-
arr.set( 3.5, 2 );
411+
var len = out.length;
412+
// returns 2
412413

413-
arr.forEach( log );
414-
/* =>
415-
0: 1.5
416-
1: 2.5
417-
2: 3.5
418-
*/
414+
var v = out.get( 0 );
415+
// returns 2.0
416+
417+
v = out.get( 1 );
418+
// return 4.0
419419
```
420420

421-
The invoked function is provided three arguments:
421+
The `predicate` function is provided three arguments:
422422

423423
- **value**: current array element.
424424
- **index**: current array element index.
@@ -427,59 +427,58 @@ The invoked function is provided three arguments:
427427
To set the function execution context, provide a `thisArg`.
428428

429429
```javascript
430-
function fcn( v, i ) {
430+
function predicate( v, i ) {
431431
this.count += 1;
432-
console.log( '%s: %s', i.toString(), v.toString() );
432+
return ( v % 2 === 0 );
433433
}
434434

435-
var Float64ArrayFE = fixedEndianFactory( 'float64' );
436-
437-
var arr = new Float64ArrayFE( 'little-endian', 3 );
438-
// returns <Float64ArrayFE>
439-
440435
var context = {
441436
'count': 0
442437
};
443438

444-
arr.set( 1.0, 0 );
445-
arr.set( 2.0, 1 );
446-
arr.set( 3.0, 2 );
439+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
447440

448-
arr.forEach( fcn, context );
441+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
442+
443+
var out = arr.filter( predicate, context );
444+
// returns <Float64ArrayFE>
445+
446+
var len = out.length;
447+
// returns 2
449448

450449
var count = context.count;
451-
// returns 3
450+
// returns 4
452451
```
453452

454-
<a name="method-filter"></a>
453+
<a name="method-for-each"></a>
455454

456-
#### TypedArrayFE.prototype.filter( predicate\[, thisArg] )
455+
#### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )
457456

458-
Returns a new array containing the elements of an array which pass a test implemented by a predicate function.
457+
Invokes a function once for each array element.
459458

460459
```javascript
461-
function predicate( v ) {
462-
return ( v % 2 === 0 );
460+
function log( v, i ) {
461+
console.log( '%s: %s', i.toString(), v.toString() );
463462
}
464463

465464
var Float64ArrayFE = fixedEndianFactory( 'float64' );
466465

467-
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
468-
469-
var out = arr.filter( predicate );
466+
var arr = new Float64ArrayFE( 'little-endian', 3 );
470467
// returns <Float64ArrayFE>
471468

472-
var len = out.length;
473-
// returns 2
474-
475-
var v = out.get( 0 );
476-
// returns 2.0
469+
arr.set( 1.5, 0 );
470+
arr.set( 2.5, 1 );
471+
arr.set( 3.5, 2 );
477472

478-
v = out.get( 1 );
479-
// return 4.0
473+
arr.forEach( log );
474+
/* =>
475+
0: 1.5
476+
1: 2.5
477+
2: 3.5
478+
*/
480479
```
481480

482-
The `predicate` function is provided three arguments:
481+
The invoked function is provided three arguments:
483482

484483
- **value**: current array element.
485484
- **index**: current array element index.
@@ -488,27 +487,28 @@ The `predicate` function is provided three arguments:
488487
To set the function execution context, provide a `thisArg`.
489488

490489
```javascript
491-
function predicate( v, i ) {
490+
function fcn( v, i ) {
492491
this.count += 1;
493-
return ( v % 2 === 0 );
492+
console.log( '%s: %s', i.toString(), v.toString() );
494493
}
495494

495+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
496+
497+
var arr = new Float64ArrayFE( 'little-endian', 3 );
498+
// returns <Float64ArrayFE>
499+
496500
var context = {
497501
'count': 0
498502
};
499503

500-
var Float64ArrayFE = fixedEndianFactory( 'float64' );
501-
502-
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
503-
504-
var out = arr.filter( predicate, context );
505-
// returns <Float64ArrayFE>
504+
arr.set( 1.0, 0 );
505+
arr.set( 2.0, 1 );
506+
arr.set( 3.0, 2 );
506507

507-
var len = out.length;
508-
// returns 2
508+
arr.forEach( fcn, context );
509509

510510
var count = context.count;
511-
// returns 4
511+
// returns 3
512512
```
513513

514514
<a name="method-get"></a>
@@ -883,7 +883,7 @@ var str = arr.toString();
883883

884884
#### TypedArrayFE.prototype.join( \[separator] )
885885

886-
Serializes the array elements into a string, with elements separated by the specified `separator`. If no `separator` is provided, a comma (`,`) is used as the default.
886+
Returns a new string by concatenating all array elements.
887887

888888
```javascript
889889
var Float64ArrayFE = fixedEndianFactory( 'float64' );
@@ -892,20 +892,17 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
892892

893893
var str = arr.join();
894894
// returns '1,2,3'
895-
896-
str = arr.join( ' - ' );
897-
// returns '1 - 2 - 3'
898895
```
899896

900-
If the provided `separator` is not a string, it is coerced to a string.
897+
By default, the method separates serialized array elements with a comma. To use an alternative separator, provide a `separator` string.
901898

902899
```javascript
903900
var Float64ArrayFE = fixedEndianFactory( 'float64' );
904901

905902
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
906903

907-
var str = arr.join( 0 );
908-
// returns '10203'
904+
var str = arr.join( ' - ' );
905+
// returns '1 - 2 - 3'
909906
```
910907

911908
<a name="method-with"></a>

lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.join.length.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ var Float64ArrayFE = factory( 'float64' );
4242
* @returns {Function} benchmark function
4343
*/
4444
function createBenchmark( len ) {
45-
var arr;
46-
arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
45+
var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
4746
return benchmark;
4847

4948
/**

0 commit comments

Comments
 (0)