function min(): InputFunction
Finds the minimum number in an Iterable
. Accepts no parameters.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function minBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
Like min
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify what value gets processed on each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function max(): InputFunction
Finds the maximum number in an Iterable
. Accepts no parameters.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function maxBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
Like max
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify what value gets processed on each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function sum(): InputFunction
Sums the elements in an Iterable
. Accepts no parameters.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function sumBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
Like sum
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify what value gets summed on each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function average(): InputFunction
Averages the elements in an Iterable
. Accepts no parameters.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function averageBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
Like average
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify what value gets averaged on each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function mean(): InputFunction
An alias for {@link average}.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function meanBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
An alias for {@link averageBy}.
A function that allows you to specify what value gets averaged on each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function median(): InputFunction
Averages the elements in an Iterable
. Accepts no parameters.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function medianBy(valueMapper: (value: *, key: *, iter: Iterable) => Number): InputFunction
Like median
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify what value gets read from each item in the input Iterable
.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function percent(): InputFunction
Calculates the percentage of each number
in a Iterable
compared to the sum of all number
s in the Iterable
.
A partially applied function which accepts a single Iterable
, and returns the result of the operation.
function percentBy(valueMapper: (value: *, key: *, iter: Iterable) => Number, valueSetter: (item: *, value: *, key: *, iter: Iterable)): InputFunction
Like percent
, but also accepts a valueMapper
function which allows you to process child properties.
A function that allows you to specify which value gets pulled from each item in the input Iterable
when performing a calculation.
The value of the current item in the input Iterable
.
The key of the current item in the input Iterable
.
The original input
Iterable
.
The number to use in the operation.
When provided, this function works like .map()
providing you with the output of a calculation for each item in the Iterable
.
The current item in the Iterable
.
The value from the calculation.
The key of the current item in the input Iterable
.
The original input
Iterable
.