net.finmath.marketdata.model.curves

Enum CurveInterpolation.InterpolationEntity

java.lang.Object

java.lang.Enum<CurveInterpolation.InterpolationEntity>

net.finmath.marketdata.model.curves.CurveInterpolation.InterpolationEntity

All Implemented Interfaces:

Serializable, Comparable<CurveInterpolation.InterpolationEntity>

Enclosing class:

CurveInterpolation

public static enum CurveInterpolation.InterpolationEntity
extends Enum<CurveInterpolation.InterpolationEntity>

Possible interpolation entities.

Author:

Christian Fries

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOG_OF_VALUE Interpolation is performed on the log of the point values, i.e. log(value(t))
LOG_OF_VALUE_PER_TIME Interpolation is performed on the log of the point values divided by their respective time, i.e. log(value(t))/t
VALUE Interpolation is performed on the native point values, i.e. value(t)

Method Summary

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

VALUE

public static final CurveInterpolation.InterpolationEntity VALUE

Interpolation is performed on the native point values, i.e. value(t)

LOG_OF_VALUE

public static final CurveInterpolation.InterpolationEntity LOG_OF_VALUE

Interpolation is performed on the log of the point values, i.e. log(value(t))

LOG_OF_VALUE_PER_TIME

public static final CurveInterpolation.InterpolationEntity LOG_OF_VALUE_PER_TIME

Interpolation is performed on the log of the point values divided by their respective time, i.e. log(value(t))/t

Method Detail

values

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

Returns:

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

valueOf

public static CurveInterpolation.InterpolationEntity 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