Package microsim.statistics.regression

Enum Class RegressionColumnNames

java.lang.Object

java.lang.Enum<RegressionColumnNames>

microsim.statistics.regression.RegressionColumnNames

All Implemented Interfaces:

Serializable, Comparable<RegressionColumnNames>, Constable

public enum RegressionColumnNames
extends Enum<RegressionColumnNames>

Enum types for use with Regressions. This class defines the names of value columns of MultiKeyCoefficientMaps of Regression objects that carry a particular meaning for the calculation of regression scores and probabilities.

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
COEFFICIENT	Name of values column containing the regression coefficients, for use with LinearRegression.getScore() and derived classes.
COVARIANCE	Name of Covariance Matrix, appearing in the top left corner of the matrix, above the column of covariate names
REGRESSOR	Name of key column containing the regressors (also known as covariates)

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REGRESSOR

public static final RegressionColumnNames REGRESSOR

Name of key column containing the regressors (also known as covariates)

COEFFICIENT

public static final RegressionColumnNames COEFFICIENT

Name of values column containing the regression coefficients, for use with LinearRegression.getScore() and derived classes.

COVARIANCE

public static final RegressionColumnNames COVARIANCE

Name of Covariance Matrix, appearing in the top left corner of the matrix, above the column of covariate names

Method Details

values

public static RegressionColumnNames[] 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 RegressionColumnNames 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