org.drip.spline.segment

Class Monotonocity

java.lang.Object

org.drip.spline.segment.Monotonocity

public class Monotonocity
extends java.lang.Object

This class contains the monotonicity details related to the given segment. Indicates whether the segment is monotonic, and if not, whether it contains a maximum, a minimum, or an inflection.

Author:

Lakshmi Krishnamurthy

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFLECTION NON MONOTONE - INFLECTION
static int	MAXIMA NON MONOTONE - MAXIMA
static int	MINIMA NON MONOTONE - MINIMA
static int	MONOTONIC MONOTONIC
static int	NON_MONOTONIC NON-MONOTONIC

Constructor Summary

Constructors

Constructor and Description
Monotonocity(int iMonotoneType) Monotonocity constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
int	type() Retrieve the Monotone Type

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MONOTONIC

public static final int MONOTONIC

MONOTONIC

See Also:

Constant Field Values

NON_MONOTONIC

public static final int NON_MONOTONIC

NON-MONOTONIC

See Also:

Constant Field Values

MINIMA

public static final int MINIMA

NON MONOTONE - MINIMA

See Also:

Constant Field Values

MAXIMA

public static final int MAXIMA

NON MONOTONE - MAXIMA

See Also:

Constant Field Values

INFLECTION

public static final int INFLECTION

NON MONOTONE - INFLECTION

See Also:

Constant Field Values

Constructor Detail

Monotonocity

public Monotonocity(int iMonotoneType)
             throws java.lang.Exception

Monotonocity constructor

Parameters:

iMonotoneType - One of the valid monotone types

Throws:

java.lang.Exception - Thrown if the input monotone type is invalid

Method Detail

type

public int type()

Retrieve the Monotone Type

Returns:

The Monotone Type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object