📊 Calculates the average (arithmetic mean) of a list of numbers.
Info
Mean: The "average" number; found by adding all data points and dividing by the number of data points.
Syntax
TypeScript
import { mean } from '@opentf/std'; mean<T>( arr: T[] = [], cb?: (val: T, index: number) => number ): number
Parameters
arr: An array of numbers.cb: An optional iteratee invoked for each element to generate the value to be averaged.
Returns
The calculated mean. Returns NaN for empty arrays.
Sparse array holes are ignored.
Examples
TypeScript
mean([]) //=> NaN mean([1]) //=> 1 mean([4, 1, 7]) //=> 4 mean([4, 2, 8]) //=> 4.666666666666667 const objects = [{ a: 4 }, { a: 2 }, { a: 8 }]; mean(objects, (o) => o.a) //=> 4.666666666666667