hex.genmodel.utils

Enum DistributionFamily

java.lang.Object

java.lang.Enum<DistributionFamily>

hex.genmodel.utils.DistributionFamily

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistributionFamily>

public enum DistributionFamily
extends java.lang.Enum<DistributionFamily>

Used to be `hex.Distribution.Family`.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO
bernoulli
gamma
gaussian
huber
laplace
modified_huber
multinomial
poisson
quantile
tweedie

Method Summary

Methods

Modifier and Type	Method and Description
static double	exp(double x)
static java.lang.String	expString(java.lang.String x)
double	link(double f) Canonical link
double	linkInv(double f) Canonical link inverse
java.lang.String	linkInvString(java.lang.String f) String version of link inverse (for POJO scoring code generation)
static double	log(double x)
static DistributionFamily	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DistributionFamily[]	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

AUTO

public static final DistributionFamily AUTO

bernoulli

public static final DistributionFamily bernoulli

modified_huber

public static final DistributionFamily modified_huber

multinomial

public static final DistributionFamily multinomial

gaussian

public static final DistributionFamily gaussian

poisson

public static final DistributionFamily poisson

gamma

public static final DistributionFamily gamma

tweedie

public static final DistributionFamily tweedie

huber

public static final DistributionFamily huber

laplace

public static final DistributionFamily laplace

quantile

public static final DistributionFamily quantile

Method Detail

values

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

Returns:

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

valueOf

public static DistributionFamily valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

linkInv

public double linkInv(double f)

Canonical link inverse

Parameters:

f - value in link space, to be transformed back to original space

Returns:

linkInv(f)

link

public double link(double f)

Canonical link

Parameters:

f - value in original space, to be transformed to link space

Returns:

link(f)

linkInvString

public java.lang.String linkInvString(java.lang.String f)

String version of link inverse (for POJO scoring code generation)

Parameters:

f - value to be transformed by link inverse

Returns:

String that turns into compilable expression of linkInv(f)

exp

public static double exp(double x)

expString

public static java.lang.String expString(java.lang.String x)

log

public static double log(double x)