Package org.apache.commons.statistics.descriptive

Class LongMax

java.lang.Object

org.apache.commons.statistics.descriptive.LongMax

All Implemented Interfaces:

DoubleSupplier, IntSupplier, LongConsumer, LongSupplier, LongStatistic, StatisticAccumulator<LongMax>, StatisticResult

public final class LongMax
extends Object
implements LongStatistic, StatisticAccumulator<LongMax>

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

• The result is Long.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(long, long)

Method Summary

Modifier and Type	Method	Description
void	accept(long value)	Updates the state of the statistic to reflect the addition of value.
LongMax	combine(LongMax other)	Combines the state of the other statistic into this one.
static LongMax	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()	Gets the maximum of all input values.
static LongMax	of(long... values)	Returns an instance populated using the input 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.LongConsumer

andThen

Method Detail

create

public static LongMax create()

Creates an instance.

The initial result is Long.MIN_VALUE.

Returns:

Min instance.

of

public static LongMax of(long... values)

Returns an instance populated using the input values.

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

Parameters:

values - Values.

Returns:

Min instance.

accept

public void accept(long value)

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

Specified by:

accept in interface LongConsumer

Parameters:

value - Value.

getAsLong

public long getAsLong()

Gets the maximum of all input values.

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

Specified by:

getAsLong in interface LongSupplier

Specified by:

getAsLong in interface StatisticResult

Returns:

maximum of all values.

getAsInt

public int getAsInt()

Gets the maximum of all input values.

This method will throw an ArithmeticException if the long maximum overflows an int; or no values have been added.

Specified by:

getAsInt in interface IntSupplier

Specified by:

getAsInt in interface StatisticResult

Returns:

maximum of all values.

See Also:

Math.toIntExact(long)

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 LongMax combine(LongMax other)

Description copied from interface: StatisticAccumulator

Combines the state of the other statistic into this one.

Specified by:

combine in interface StatisticAccumulator<LongMax>

Parameters:

other - Another statistic to be combined.

Returns:

this instance after combining other.