https://github.com/stdlib-js/array-filled-by
Create a filled array according to a provided callback function.
https://github.com/stdlib-js/array-filled-by
array data float32array float64array int16array int32array javascript matrix ndarray node node-js nodejs stdlib structure typed typed-array types uint32array vector
Last synced: about 2 months ago
JSON representation
Create a filled array according to a provided callback function.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-filled-by
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-10-22T22:35:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T01:53:04.000Z (3 months ago)
- Last Synced: 2025-03-27T01:46:41.732Z (2 months ago)
- Topics: array, data, float32array, float64array, int16array, int32array, javascript, matrix, ndarray, node, node-js, nodejs, stdlib, structure, typed, typed-array, types, uint32array, vector
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.6 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# filledarrayBy
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create a filled array according to a provided callback function.
## Installation
```bash
npm install @stdlib/array-filled-by
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var filledarrayBy = require( '@stdlib/array-filled-by' );
```
#### filledarrayBy( \[dtype] )
Creates a filled array having a specified [data type][@stdlib/array/dtypes] `dtype`.
```javascript
var arr = filledarrayBy();
// returns
```
By default, the output array [data type][@stdlib/array/dtypes] is `float64` (i.e., a [typed array][mdn-typed-array]). To specify an alternative [data type][@stdlib/array/dtypes], provide a `dtype` argument.
```javascript
var arr = filledarrayBy( 'int32' );
// returns
```
#### filledarrayBy( length\[, dtype], clbk\[, thisArg] )
Returns a filled array according to a provided callback function and having a specified `length`.
```javascript
function constant() {
return 1.0;
}
var arr1 = filledarrayBy( 5, constant );
// returns [ 1.0, 1.0, 1.0, 1.0, 1.0 ]
var arr2 = filledarrayBy( 5, 'uint8', constant );
// returns [ 1, 1, 1, 1, 1 ]
```
#### filledarrayBy( array\[, dtype], clbk\[, thisArg] )
Creates a filled array from another array (or array-like object) according to a provided callback function.
```javascript
var arr0 = {
'0': 0.5,
'1': 0.5,
'2': 0.5,
'length': 3
};
function clbk1() {
return 1.0;
}
var arr1 = filledarrayBy( arr0, clbk1 );
// returns [ 1.0, 1.0, 1.0 ]
function clbk2() {
return 2.0;
}
var arr2 = filledarrayBy( arr1, clbk2 );
// returns [ 2.0, 2.0, 2.0 ]
function clbk3() {
return 3.0;
}
var arr3 = filledarrayBy( arr1, 'int32', clbk3 );
// returns [ 3, 3, 3 ]
```
#### filledarrayBy( iterable\[, dtype], clbk\[, thisArg] )
Creates a filled array from an iterable according to a provided callback function.
```javascript
var iterConstant = require( '@stdlib/iter-constant' );
function clbk() {
return 1.0;
}
var it = iterConstant( 3.0, {
'iter': 3
});
var arr1 = filledarrayBy( it, clbk );
// returns [ 1.0, 1.0, 1.0 ]
var arr2 = filledarrayBy( it, 'float32', clbk );
// returns [ 1.0, 1.0, 1.0 ]
```
#### filledarrayBy( buffer\[, byteOffset\[, length]]\[, dtype], clbk\[, thisArg] )
Returns a filled [typed array][mdn-typed-array] view of an [`ArrayBuffer`][mdn-arraybuffer] according to a provided callback function.
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
function clbk() {
return 1.0;
}
var buf = new ArrayBuffer( 32 );
var arr = filledarrayBy( buf, clbk );
// returns [ 1.0, 1.0, 1.0, 1.0 ]
buf = new ArrayBuffer( 32 );
arr = filledarrayBy( buf, 'float32', clbk );
// returns [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
buf = new ArrayBuffer( 32 );
arr = filledarrayBy( buf, 16, clbk );
// returns [ 1.0, 1.0 ]
buf = new ArrayBuffer( 32 );
arr = filledarrayBy( buf, 16, 'float32', clbk );
// returns [ 1.0, 1.0, 1.0, 1.0 ]
buf = new ArrayBuffer( 32 );
arr = filledarrayBy( buf, 16, 1, clbk );
// returns [ 1.0 ]
buf = new ArrayBuffer( 32 );
arr = filledarrayBy( buf, 10, 4, 'int16', clbk );
// returns [ 1, 1, 1, 1 ]
```
## Notes
- Creating a generic [array][mdn-array] from an [`ArrayBuffer`][mdn-arraybuffer] is **not** supported.
- A callback function is provided a single argument:
- **index**: the current array index.
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var dtypes = require( '@stdlib/array-typed-real-dtypes' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
// Create a pseudorandom number generator:
var rand = discreteUniform( 0, 100 );
// Get a list of array data types:
var dt = dtypes();
// Generate filled arrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
arr = filledarrayBy( 10, dt[ i ], rand );
console.log( arr );
}
```
* * *
## See Also
- [`@stdlib/array-filled`][@stdlib/array/filled]: create a filled array.
- [`@stdlib/array-typed`][@stdlib/array/typed]: create a typed array.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, 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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-filled-by.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-filled-by
[test-image]: https://github.com/stdlib-js/array-filled-by/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-filled-by/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-filled-by/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-filled-by?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/array-filled-by/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-filled-by/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-filled-by/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-filled-by/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-filled-by/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-filled-by/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-filled-by/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-filled-by/main/LICENSE
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes
[@stdlib/array/filled]: https://github.com/stdlib-js/array-filled
[@stdlib/array/typed]: https://github.com/stdlib-js/array-typed