org.ojalgo.function.aggregator

Enum Aggregator

java.lang.Object

java.lang.Enum<Aggregator>

org.ojalgo.function.aggregator.Aggregator

All Implemented Interfaces:

Serializable, Comparable<Aggregator>

public enum Aggregator
extends Enum<Aggregator>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE
CARDINALITY
LARGEST
MAXIMUM
MINIMUM
NORM1
NORM2
PRODUCT
PRODUCT2
SMALLEST
SUM
SUM2

Method Summary

Modifier and Type	Method and Description
<N extends Number> AggregatorFunction<N>	getFunction(AggregatorSet<N> collection)
static Aggregator	valueOf(String name) Returns the enum constant of this type with the specified name.
static Aggregator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AVERAGE

public static final Aggregator AVERAGE

CARDINALITY

public static final Aggregator CARDINALITY

LARGEST

public static final Aggregator LARGEST

MAXIMUM

public static final Aggregator MAXIMUM

MINIMUM

public static final Aggregator MINIMUM

NORM1

public static final Aggregator NORM1

NORM2

public static final Aggregator NORM2

PRODUCT

public static final Aggregator PRODUCT

PRODUCT2

public static final Aggregator PRODUCT2

SMALLEST

public static final Aggregator SMALLEST

SUM

public static final Aggregator SUM

SUM2

public static final Aggregator SUM2

Method Detail

values

public static Aggregator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Aggregator c : Aggregator.values())
    System.out.println(c);

Returns:

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

valueOf

public static Aggregator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getFunction

public final <N extends Number> AggregatorFunction<N> getFunction(AggregatorSet<N> collection)