Package org.apache.commons.statistics.descriptive

Class IntMax

java.lang.Object

org.apache.commons.statistics.descriptive.IntMax

All Implemented Interfaces:

DoubleSupplier, IntConsumer, IntSupplier, LongSupplier, IntStatistic, StatisticAccumulator<IntMax>, StatisticResult

public final class IntMax
extends Object
implements IntStatistic, StatisticAccumulator<IntMax>

Returns the maximum of the available values. Uses Math.max as an underlying function to compute the maximum.

• The result is Integer.MIN_VALUE if no values are added.

This class is designed to work with (though does not require) streams.

This implementation is not thread safe. If multiple threads access an instance of this class concurrently, and at least one of the threads invokes the accept or combine method, it must be synchronized externally.

However, it is safe to use accept and combine as accumulator and combiner functions of Collector on a parallel stream, because the parallel implementation of Stream.collect() provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.

Since:

1.1

See Also:

• Math.max(int, int)

Method Summary

Modifier and Type	Method	Description
void	accept(int value)	Updates the state of the statistic to reflect the addition of value.
IntMax	combine(IntMax other)	Combines the state of the other statistic into this one.
static IntMax	create()	Creates an instance.
BigInteger	getAsBigInteger()	Gets a result as a BigInteger.
double	getAsDouble()
int	getAsInt()	Gets the maximum of all input values.
long	getAsLong()
static IntMax	of(int... values)	Returns an instance populated using the input values.
static IntMax	ofRange(int[] values, int from, int to)	Returns an instance populated using the specified range of values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.IntConsumer

andThen

Method Details

create

public static IntMax create()

Creates an instance.

The initial result is Integer.MIN_VALUE.

Returns:

IntMax instance.

of

public static IntMax of(int... values)

Returns an instance populated using the input values.

When the input is an empty array, the result is Integer.MIN_VALUE.

Parameters:

values - Values.

Returns:

IntMax instance.

ofRange

public static IntMax ofRange(int[] values,
 int from,
 int to)

Returns an instance populated using the specified range of values.

When the range is empty, the result is Integer.MIN_VALUE.

Parameters:

values - Values.

from - Inclusive start of the range.

to - Exclusive end of the range.

Returns:

IntMax instance.

Throws:

IndexOutOfBoundsException - if the sub-range is out of bounds

Since:

1.2

accept

public void accept(int value)

Updates the state of the statistic to reflect the addition of value.

Specified by:

accept in interface IntConsumer

Parameters:

value - Value.

getAsInt

public int getAsInt()

Gets the maximum of all input values.

When no values have been added, the result is Integer.MIN_VALUE.

Specified by:

getAsInt in interface IntSupplier

Specified by:

getAsInt in interface StatisticResult

Returns:

maximum of all values.

getAsLong

public long getAsLong()

Description copied from interface: StatisticResult

The default implementation uses the closest representable long value of the DoubleSupplier.getAsDouble() result. In the event of ties the result is rounded towards positive infinity. This will raise an ArithmeticException if the closest integer result is not within the range [-2^63, 2^63).

Specified by:

getAsLong in interface LongSupplier

Specified by:

getAsLong in interface StatisticResult

getAsDouble

public double getAsDouble()

Specified by:

getAsDouble in interface DoubleSupplier

getAsBigInteger

public BigInteger getAsBigInteger()

Description copied from interface: StatisticResult

Gets a result as a BigInteger.

The default implementation uses the closest representable BigInteger value of the DoubleSupplier.getAsDouble() result. In the event of ties the result is rounded towards positive infinity. This will raise an ArithmeticException if the result is not finite.

Specified by:

getAsBigInteger in interface StatisticResult

Returns:

a result

combine

public IntMax combine(IntMax other)

Description copied from interface: StatisticAccumulator

Combines the state of the other statistic into this one.

Specified by:

combine in interface StatisticAccumulator<IntMax>

Parameters:

other - Another statistic to be combined.

Returns:

this instance after combining other.