20 lines
481 B
JavaScript
20 lines
481 B
JavaScript
import { sum } from "./sum.mjs";
|
|
//#region src/math/mean.ts
|
|
/**
|
|
* Calculates the average of an array of numbers.
|
|
*
|
|
* If the array is empty, this function returns `NaN`.
|
|
*
|
|
* @param nums - An array of numbers to calculate the average.
|
|
* @returns The average of all the numbers in the array.
|
|
*
|
|
* @example
|
|
* const numbers = [1, 2, 3, 4, 5];
|
|
* const result = mean(numbers);
|
|
* // result will be 3
|
|
*/
|
|
function mean(nums) {
|
|
return sum(nums) / nums.length;
|
|
}
|
|
//#endregion
|
|
export { mean };
|