Package org.apache.datasketches.tuple.adouble

Enum Class DoubleSummary.Mode

java.lang.Object

java.lang.Enum<DoubleSummary.Mode>

org.apache.datasketches.tuple.adouble.DoubleSummary.Mode

All Implemented Interfaces:

Serializable, Comparable<DoubleSummary.Mode>, Constable

Enclosing class:

DoubleSummary

public static enum DoubleSummary.Mode
extends Enum<DoubleSummary.Mode>

The aggregation modes for this Summary

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AlwaysOne	The aggregation mode is always one.
Max	The aggregation mode is the maximum function.
Min	The aggregation mode is the minimum function.
Sum	The aggregation mode is the summation function.

Method Summary

Modifier and Type	Method	Description
static DoubleSummary.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DoubleSummary.Mode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Sum

public static final DoubleSummary.Mode Sum

The aggregation mode is the summation function.

New retained value = previous retained value + incoming value

Min

public static final DoubleSummary.Mode Min

The aggregation mode is the minimum function.

New retained value = min(previous retained value, incoming value)

Max

public static final DoubleSummary.Mode Max

The aggregation mode is the maximum function.

New retained value = max(previous retained value, incoming value)

AlwaysOne

public static final DoubleSummary.Mode AlwaysOne

The aggregation mode is always one.

New retained value = 1.0

Method Details

values

public static DoubleSummary.Mode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DoubleSummary.Mode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null