Function weight

Applies a function fn to the elements of an array, weighting them based on their relative position.

// Six items
weight([1,1,1,1,1,1], Modulation.gaussian());

// Yields:
// [0.02, 0.244, 0.85, 0.85, 0.244, 0.02]
Copy

fn is expected to map (0..1) => (0..1), such as an easing function. The input to the fn is the relative position of an element. Thus the first element will be 0, the middle 0.5 and so on. The output of fn is then multiplied by the original value.

In the below example (which is also the default if fn is not specified), the relative position is how values are weighted:

weight([1,1,1,1,1,1], (relativePos) => relativePos);
// Yields:
// [0, 0.2, 0.4, 0.6, 0.8, 1]
Copy

Throws TypeError if data is not an array or for any element not a number.