Package cdm.base.math

Enum AveragingCalculationMethodEnum

java.lang.Object

java.lang.Enum<AveragingCalculationMethodEnum>

cdm.base.math.AveragingCalculationMethodEnum

All Implemented Interfaces:

Serializable, Comparable<AveragingCalculationMethodEnum>

@RosettaEnum("AveragingCalculationMethodEnum")
public enum AveragingCalculationMethodEnum
extends Enum<AveragingCalculationMethodEnum>

Specifies enumerations for the type of averaging calculation.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARITHMETIC	Refers to the calculation of an average by taking the sum of observations divided by the count of observations.
GEOMETRIC	Refers to the calculation of an average by taking the nth root of the product of n observations.
HARMONIC	Refers to the calculation of an average by taking the reciprocal of the arithmetic mean of the reciprocals of the observations.

Method Summary

Modifier and Type	Method	Description
static AveragingCalculationMethodEnum	fromDisplayName(String name)
String	toDisplayString()
String	toString()
static AveragingCalculationMethodEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AveragingCalculationMethodEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARITHMETIC

@RosettaEnumValue("Arithmetic")
public static final AveragingCalculationMethodEnum ARITHMETIC

Refers to the calculation of an average by taking the sum of observations divided by the count of observations.

GEOMETRIC

@RosettaEnumValue("Geometric")
public static final AveragingCalculationMethodEnum GEOMETRIC

Refers to the calculation of an average by taking the nth root of the product of n observations.

HARMONIC

@RosettaEnumValue("Harmonic")
public static final AveragingCalculationMethodEnum HARMONIC

Refers to the calculation of an average by taking the reciprocal of the arithmetic mean of the reciprocals of the observations.

Method Details

values

public static AveragingCalculationMethodEnum[] values()

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

Returns:

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

valueOf

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

fromDisplayName

public static AveragingCalculationMethodEnum fromDisplayName(String name)

toString

public String toString()

Overrides:

toString in class Enum<AveragingCalculationMethodEnum>

toDisplayString

public String toDisplayString()