Skip to content

Fill all elements within a portion of an array according to a callback function.

License

Notifications You must be signed in to change notification settings

stdlib-js/array-base-fill-by

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

fillBy

NPM version Build Status Coverage Status

Fill all elements within a portion of an array according to a callback function.

Usage

import fillBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-fill-by@deno/mod.js';

fillBy( x, start, end, fcn[, thisArg] )

Fills all elements within a portion of an array from an inclusive start index to an exclusive end index according to a provided callback function.

function fcn() {
    return 10;
}

var x = [ 1, 2, 3, 4, 5, 6 ];

var out = fillBy( x, 1, 4, fcn );
// returns [ 1, 10, 10, 10, 5, 6 ]

var bool = ( out === x );
// returns true

The callback function is provided the following arguments:

  • value: current array element.
  • index: current array element index.
  • arr: input array.

To set the callback execution context, provide a thisArg.

function fcn() {
    this.count += 1;
    return 10;
}

var x = [ 1, 2, 3, 4, 5, 6 ];

var ctx = {
    'count': 0
};
var out = fillBy( x, 1, 4, fcn, ctx );
// returns [ 1, 10, 10, 10, 5, 6 ]

var bool = ( out === x );
// returns true

var cnt = ctx.count;
// returns 3

Notes

  • Negative start and end indices are resolved to positive indices by counting from the end of the array with -1 corresponding to the last indexed element.
  • The function mutates the input array.

Examples

import constantFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@deno/mod.js';
import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';
import zeroTo from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zero-to@deno/mod.js';
import fillBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-fill-by@deno/mod.js';

var x = new Float64Array( zeroTo( 6 ) );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]

var y = fillBy( x, 0, 6, constantFunction( 10.0 ) );
// returns <Float64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]

y = fillBy( x, 0, 4, constantFunction( 0.0 ) );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 10.0, 10.0 ]

y = fillBy( x, 2, 6, constantFunction( 20.0 ) );
// returns <Float64Array>[ 0.0, 0.0, 20.0, 20.0, 20.0, 20.0 ]

y = fillBy( x, 2, 4, constantFunction( 30.0 ) );
// returns <Float64Array>[ 0.0, 0.0, 30.0, 30.0, 20.0, 20.0 ]

Notice

This package is part of stdlib, a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.