Package com.activeviam.risk.core.utils

Enum MathFunctions.Metric

java.lang.Object

java.lang.Enum<MathFunctions.Metric>

com.activeviam.risk.core.utils.MathFunctions.Metric

All Implemented Interfaces:

Serializable, Comparable<MathFunctions.Metric>

Enclosing class:

MathFunctions

public static enum MathFunctions.Metric
extends Enum<MathFunctions.Metric>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVERAGE
AVGSQ
RMS
STDEV_P
STDEV_S
SUM
SUMSQ
VAR_P
VAR_S

Method Summary

Modifier and Type	Method	Description
ToDoubleFunction<DoubleStream>	getCollector()
static MathFunctions.Metric	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MathFunctions.Metric[]	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

SUM

public static final MathFunctions.Metric SUM

AVERAGE

public static final MathFunctions.Metric AVERAGE

STDEV_S

public static final MathFunctions.Metric STDEV_S

VAR_S

public static final MathFunctions.Metric VAR_S

STDEV_P

public static final MathFunctions.Metric STDEV_P

VAR_P

public static final MathFunctions.Metric VAR_P

SUMSQ

public static final MathFunctions.Metric SUMSQ

RMS

public static final MathFunctions.Metric RMS

AVGSQ

public static final MathFunctions.Metric AVGSQ

Method Detail

values

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

Returns:

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

valueOf

public static MathFunctions.Metric 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

getCollector

public ToDoubleFunction<DoubleStream> getCollector()