de.caff.generics.util

Class MinMaxAv

java.lang.Object

de.caff.generics.util.MinMaxAv

public class MinMaxAv
extends java.lang.Object

Calculation helper for the minimum, maximum, and average of sets.

Since:

June 03, 2025

Author:

Rammi

Constructor Summary

Constructors

Constructor and Description
MinMaxAv()

Method Summary

Modifier and Type	Method and Description
void	add(double value) Add a value to the set.
double	getAverage() Get the average of values in the set.
int	getCount() Get the number of values in the set.
double	getMaximum() Get the maximum value of the set.
double	getMinimum() Get the minimum value of the set.
boolean	isValid() Is this item valid?
static MinMaxAv	of(byte... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(char... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(double... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(float... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(int... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(java.lang.Iterable<? extends java.lang.Number> values) Get the minimum, maximum and average of the given iterable of numeric values.
static <T,N extends java.lang.Number> MinMaxAv	of(java.lang.Iterable<T> elements, java.util.function.Function<? super T,? extends N> extractor) Get the minimum, maximum and average of the given iterable of generic elements.
static MinMaxAv	of(long... values) Get the minimum, maximum and average of the given array of values.
static MinMaxAv	of(short... values) Get the minimum, maximum and average of the given array of values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MinMaxAv

public MinMaxAv()

Method Detail

add

public void add(double value)

Add a value to the set.

Parameters:

value - value to add

isValid

public boolean isValid()

Is this item valid?

Returns:

true if at least one value was added
false if the set of values is empty

getMinimum

public double getMinimum()

Get the minimum value of the set.

Returns:

the minimum value

getMaximum

public double getMaximum()

Get the maximum value of the set.

Returns:

the maximum value

getCount

public int getCount()

Get the number of values in the set.

Returns:

the number of added values

getAverage

public double getAverage()

Get the average of values in the set.

Returns:

the average, or NaN if this set is not valid

of

@NotNull
public static MinMaxAv of(@NotNull
                                   double... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - double array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   float... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - float array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   long... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - long array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   int... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - int array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   short... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - short array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   byte... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - byte array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   char... values)

Get the minimum, maximum and average of the given array of values.

Parameters:

values - char array

Returns:

the minimum, maximum, and average

of

@NotNull
public static MinMaxAv of(@NotNull
                                   java.lang.Iterable<? extends java.lang.Number> values)

Get the minimum, maximum and average of the given iterable of numeric values.

Parameters:

values - iterable of numbers

Returns:

the minimum, maximum, and average

of

@NotNull
public static <T,N extends java.lang.Number> MinMaxAv of(@NotNull
                                                                  java.lang.Iterable<T> elements,
                                                                  @NotNull
                                                                  java.util.function.Function<? super T,? extends N> extractor)

Get the minimum, maximum and average of the given iterable of generic elements.

Type Parameters:

T - element type

N - type of number from which the minimum, maximum, and average is calculated

Parameters:

elements - iterable of elements

extractor - function which extracts a numeric value from a value

Returns:

the minimum, maximum, and average