Skip to content

Scatter a list of provided values to specified indices in a new zero-filled "generic" array.

License

Notifications You must be signed in to change notification settings

stdlib-js/array-base-scattered

 
 

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!

scattered

NPM version Build Status Coverage Status

Scatter a list of provided values to specified indices in a new zero-filled "generic" array.

Usage

To use in Observable,

scattered = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-scattered@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var scattered = require( 'path/to/vendor/umd/array-base-scattered/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-scattered@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.scattered;
})();
</script>

scattered( len, indices, values, mode )

Scatters a list of provided values to specified indices in a new zero-filled "generic" array.

var out = scattered( 4, [ 1, 3 ], [ 20, 40 ], 'throw' );
// returns [ 0, 20, 0, 40 ]

The function supports the following parameters:

  • len: output array length.
  • indices: list of indices.
  • values: values to scatter. When indices contains one or more elements, values must be broadcast compatible with indices (i.e., must have either one element or the same number of elements as indices).
  • mode: index mode.

If indices is an empty array, the function returns a zero-filled array.

var out = scattered( 4, [], [ 20, 40 ], 'throw' );
// returns [ 0, 0, 0, 0 ]

The function supports broadcasting a values array containing a single element against an indices array containing one or more elements.

var out = scattered( 4, [ 1, 3 ], [ 20 ], 'throw' );
// returns [ 0, 20, 0, 20 ]

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-scattered@umd/browser.js"></script>
<script type="text/javascript">
(function () {

// Generate an array of random indices:
var N = discreteUniform( 5, 15 );
var indices = filledBy( N, discreteUniform.factory( 0, 10 ) );
console.log( indices );

// Generate an array of random values:
var values = filledBy( N, discreteUniform.factory( 1000, 2025 ) );
console.log( values );

// Scatter a random sample of elements to a new array:
var out = scattered( 11, indices, values, 'throw' );
console.log( out );

})();
</script>
</body>
</html>

Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

About

Scatter a list of provided values to specified indices in a new zero-filled "generic" array.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published