org.drip.function.r1tor1

Class HyperbolicTension

java.lang.Object

org.drip.function.definition.R1ToR1

org.drip.function.r1tor1.HyperbolicTension

public class HyperbolicTension
extends R1ToR1

HyperbolicTension provides the evaluation of the Hyperbolic Tension Function and its derivatives for a specified variate.

Author:

Lakshmi Krishnamurthy

Field Summary

Fields

Modifier and Type	Field and Description
static int	COSH Hyperbolic Tension Function Type - cosh
static int	SINH Hyperbolic Tension Function Type - sinh

Constructor Summary

Constructors

Constructor and Description
HyperbolicTension(int iType, double dblTension) HyperbolicTension constructor

Method Summary

Modifier and Type	Method and Description
double	derivative(double dblVariate, int iOrder) Calculate the derivative as a double
double	evaluate(double dblVariate) Evaluate for the given variate
double	getTension() Retrieve the Tension Parameter
int	getType() Retrieve the hyperbolic function type
double	integrate(double dblBegin, double dblEnd) Integrate over the given range
static void	main(java.lang.String[] astrArgs)

Methods inherited from class org.drip.function.definition.R1ToR1

differential, differential, maxima, maxima, minima, minima

Methods inherited from class java.lang.Object

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

Field Detail

SINH

public static final int SINH

Hyperbolic Tension Function Type - sinh

See Also:

Constant Field Values

COSH

public static final int COSH

Hyperbolic Tension Function Type - cosh

See Also:

Constant Field Values

Constructor Detail

HyperbolicTension

public HyperbolicTension(int iType,
                         double dblTension)
                  throws java.lang.Exception

HyperbolicTension constructor

Parameters:

iType - Type of the HyperbolicTension Function - SINH/COSH/TANH

dblTension - Tension of the HyperbolicTension Function

Throws:

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

Method Detail

evaluate

public double evaluate(double dblVariate)
                throws java.lang.Exception

Description copied from class: R1ToR1

Evaluate for the given variate

Specified by:

evaluate in class R1ToR1

Parameters:

dblVariate - Variate

Returns:

Returns the calculated value

Throws:

java.lang.Exception - Thrown if evaluation cannot be done

derivative

public double derivative(double dblVariate,
                         int iOrder)
                  throws java.lang.Exception

Description copied from class: R1ToR1

Calculate the derivative as a double

Overrides:

derivative in class R1ToR1

Parameters:

dblVariate - Variate at which the derivative is to be calculated

iOrder - Order of the derivative to be computed

Returns:

The Derivative

Throws:

java.lang.Exception - Thrown if Inputs are Invalid

integrate

public double integrate(double dblBegin,
                        double dblEnd)
                 throws java.lang.Exception

Description copied from class: R1ToR1

Integrate over the given range

Overrides:

integrate in class R1ToR1

Parameters:

dblBegin - Range Begin

dblEnd - Range End

Returns:

The Integrated Value

Throws:

java.lang.Exception - Thrown if evaluation cannot be done

getType

public int getType()

Retrieve the hyperbolic function type

Returns:

Hyperbolic function type

getTension

public double getTension()

Retrieve the Tension Parameter

Returns:

Tension Parameter

main

public static final void main(java.lang.String[] astrArgs)
                       throws java.lang.Exception

Throws:

java.lang.Exception