Class ExponentialTension

java.lang.Object
org.drip.function.definition.R1ToR1
org.drip.function.r1tor1.ExponentialTension

public class ExponentialTension
extends R1ToR1
ExponentialTension provides the evaluation of the Exponential Tension Function and its derivatives for a specified variate.

Author:
Lakshmi Krishnamurthy
  • Constructor Summary

    Constructors
    Constructor Description
    ExponentialTension​(double dblBase, double dblTension)
    ExponentialTension constructor
  • Method Summary

    Modifier and Type Method Description
    double derivative​(double dblVariate, int iOrder)
    Calculate the derivative as a double
    double evaluate​(double dblVariate)
    Evaluate for the given variate
    double getBase()
    Retrieve the Base
    double getTension()
    Retrieve the Tension Parameter
    double integrate​(double dblBegin, double dblEnd)
    Integrate over the given range
    boolean isBaseNatural()
    Is the base natural?

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

    antiDerivative, differential, differential, maxima, maxima, minima, minima, poleResidue

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • ExponentialTension

      public ExponentialTension​(double dblBase, double dblTension) throws java.lang.Exception
      ExponentialTension constructor
      Parameters:
      dblBase - Base of the ExponentialTension Function
      dblTension - Tension of the ExponentialTension Function
      Throws:
      java.lang.Exception - Thrown if the input is invalid
  • Method Details

    • 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
    • isBaseNatural

      public boolean isBaseNatural()
      Is the base natural?
      Returns:
      TRUE - Base is off of natural logarithm
    • getBase

      public double getBase()
      Retrieve the Base
      Returns:
      The Base
    • getTension

      public double getTension()
      Retrieve the Tension Parameter
      Returns:
      Tension Parameter