Package ch.nolix.coreapi.containerapi.commoncontainerapi

Schnittstelle IStatisticalConainer<E>

Typparameter:

E - is the type of the elements a IStatisticalConainer.

Alle bekannten Unterschnittstellen:

IArrayList<E>, ICachingContainer<E>, IContainer<E>, ILinkedList<E>, IMatrix<E>, ISqlRecord

Alle bekannten Implementierungsklassen:

ArrayList, ArrayView, CachingContainer, Container, ContainerView, ContainerView, FilterContainerView, ImmutableList, IterableView, LinkedList, Matrix, MatrixColumn, MatrixRow, MultiContainerView, SqlRecord

public interface IStatisticalConainer<E>

Version:

2023-10-30

Autor:

Silvan Wyss

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
double	getAverage(Function<E,Number> valueMapper)
double	getAverageOrZero(Function<E,Number> valueMapper)
<C extends Comparable<C>> C	getMax(Function<E,C> comparableMapper)
double	getMaxOrZero(Function<E,Number> numberMapper)
double	getMedian(Function<E,Number> numberMapper)
double	getMedianOrZero(Function<E,Number> numberMapper)
<C extends Comparable<C>> C	getMin(Function<E,C> comparableMapper)
double	getMinOrZero(Function<E,Number> numberMapper)
double	getStandardDeviation(Function<E,Number> numberMapper)
BigDecimal	getSum(Function<E,Number> valueMapper)
BigInteger	getSumOfInts(ToIntFunction<E> intMapper)
double	getVariance(Function<E,Number> numberMapper)

Methodendetails

getAverage

double getAverage(Function<E,Number> valueMapper)

Parameter:

valueMapper -

Gibt zurück:

the average of the values the given valueMapper maps from the elements of the current IStatisticalConainer. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given valueMapper is null.

RuntimeException - if the current IStatisticalConainer is empty.

getAverageOrZero

double getAverageOrZero(Function<E,Number> valueMapper)

Parameter:

valueMapper -

Gibt zurück:

the average of the values the given valueMapper maps from the elements of the current IStatisticalConainer if the current IStatisticalConainer contains any, 0.0 otherwise. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given valueMapper is null.

getMax

<C extends Comparable<C>> C getMax(Function<E,C> comparableMapper)

Typparameter:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current IStatisticalConainer.

Parameter:

comparableMapper -

Gibt zurück:

the biggest Comparable the given comparableMapper maps from the elements of the current IStatisticalConainer. Ignores null elements.

Löst aus:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current IStatisticalConainer does not contain a non-null element.

getMaxOrZero

double getMaxOrZero(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the biggest number the given numberMapper maps from the non-null elements of the current IStatisticalConainer if the current IStatisticalConainer contains non-null elements, 0.0 otherwise.

getMedian

double getMedian(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the median of the numbers the given numberMapper maps from the elements of the current IStatisticalConainer. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current IStatisticalConainer is empty.

getMedianOrZero

double getMedianOrZero(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the median of the numbers the given numberMapper maps from the elements of the current IStatisticalConainer if the current IStatisticalConainer is not empty, 0.0 otherwise. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given numberMapper is null.

getMin

<C extends Comparable<C>> C getMin(Function<E,C> comparableMapper)

Typparameter:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current IStatisticalConainer.

Parameter:

comparableMapper -

Gibt zurück:

the smallest Comparable the given comparableMapper maps from the elements of the current IStatisticalConainer. Ignores null elements.

Löst aus:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current IStatisticalConainer does not contain a non-null element.

getMinOrZero

double getMinOrZero(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the smallest number the given numberMapper maps from the non-null elements of the current IStatisticalConainer if the current IStatisticalConainer contains non-null elements, 0.0 otherwise.

getStandardDeviation

double getStandardDeviation(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the standard deviation of the numbers the given numberMapper maps from the elements of the current IStatisticalConainer.

Löst aus:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current IStatisticalConainer is empty.

getSum

BigDecimal getSum(Function<E,Number> valueMapper)

Parameter:

valueMapper -

Gibt zurück:

the sum of the values the given valueMapper maps from the elements of the current IStatisticalConainer. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given valueMapper is null.

getSumOfInts

BigInteger getSumOfInts(ToIntFunction<E> intMapper)

Parameter:

intMapper -

Gibt zurück:

the sum of the ints the given intMapper maps from the elements of the current IStatisticalConainer. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given intMapper is null.

getVariance

double getVariance(Function<E,Number> numberMapper)

Parameter:

numberMapper -

Gibt zurück:

the variance of the numbers the given numberMapper maps from the elements of the current IStatisticalConainer. Maps null elements to 0.0.

Löst aus:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current IStatisticalConainer is empty.