org.ojalgo.function.aggregator
Enum ChainableAggregator

java.lang.Object
  java.lang.Enum<ChainableAggregator>
      org.ojalgo.function.aggregator.ChainableAggregator

All Implemented Interfaces:

Serializable, Comparable<ChainableAggregator>

public enum ChainableAggregator
extends Enum<ChainableAggregator>

Enum Constant Summary

LARGEST

NORM1

NORM2

PRODUCT

PRODUCT2

SMALLEST

SUM

SUM2

Method Summary

AggregatorFunction<BigDecimal>	getBigFunction()
AggregatorFunction<ComplexNumber>	getComplexFunction()
<N extends Number> AggregatorFunction<N>	getFunction(Class<?> aType)
AggregatorFunction<Double>	getPrimitiveFunction()
static ChainableAggregator	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChainableAggregator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LARGEST

public static final ChainableAggregator LARGEST

NORM1

public static final ChainableAggregator NORM1

NORM2

public static final ChainableAggregator NORM2

PRODUCT

public static final ChainableAggregator PRODUCT

PRODUCT2

public static final ChainableAggregator PRODUCT2

SMALLEST

public static final ChainableAggregator SMALLEST

SUM

public static final ChainableAggregator SUM

SUM2

public static final ChainableAggregator SUM2

Method Detail

values

public static ChainableAggregator[] 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 (ChainableAggregator c : ChainableAggregator.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChainableAggregator 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

getBigFunction

public final AggregatorFunction<BigDecimal> getBigFunction()

getComplexFunction

public final AggregatorFunction<ComplexNumber> getComplexFunction()

getFunction

public final <N extends Number> AggregatorFunction<N> getFunction(Class<?> aType)

getPrimitiveFunction

public final AggregatorFunction<Double> getPrimitiveFunction()