HyperbolicTension.java

  1. package org.drip.function.r1tor1;

  3. /*
  4.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  5.  */

  7. /*!
  8.  * Copyright (C) 2020 Lakshmi Krishnamurthy
  9.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  10.  * Copyright (C) 2018 Lakshmi Krishnamurthy
  11.  * Copyright (C) 2017 Lakshmi Krishnamurthy
  12.  * Copyright (C) 2016 Lakshmi Krishnamurthy
  13.  * Copyright (C) 2015 Lakshmi Krishnamurthy
  14.  * Copyright (C) 2014 Lakshmi Krishnamurthy
  15.  * Copyright (C) 2013 Lakshmi Krishnamurthy
  16.  * 
  17.  *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
  18.  *      asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
  19.  *      analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
  20.  *      equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
  21.  *      numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
  22.  *      and computational support.
  23.  *  
  24.  *      https://lakshmidrip.github.io/DROP/
  25.  *  
  26.  *  DROP is composed of three modules:
  27.  *  
  28.  *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
  29.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  30.  *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
  31.  * 
  32.  *  DROP Product Core implements libraries for the following:
  33.  *  - Fixed Income Analytics
  34.  *  - Loan Analytics
  35.  *  - Transaction Cost Analytics
  36.  * 
  37.  *  DROP Portfolio Core implements libraries for the following:
  38.  *  - Asset Allocation Analytics
  39.  *  - Asset Liability Management Analytics
  40.  *  - Capital Estimation Analytics
  41.  *  - Exposure Analytics
  42.  *  - Margin Analytics
  43.  *  - XVA Analytics
  44.  * 
  45.  *  DROP Computational Core implements libraries for the following:
  46.  *  - Algorithm Support
  47.  *  - Computation Support
  48.  *  - Function Analysis
  49.  *  - Model Validation
  50.  *  - Numerical Analysis
  51.  *  - Numerical Optimizer
  52.  *  - Spline Builder
  53.  *  - Statistical Learning
  54.  * 
  55.  *  Documentation for DROP is Spread Over:
  56.  * 
  57.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  58.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  59.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  60.  *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
  61.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  62.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  63.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  64.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  65.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  66.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  67.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  68.  * 
  69.  *  Licensed under the Apache License, Version 2.0 (the "License");
  70.  *      you may not use this file except in compliance with the License.
  71.  *   
  72.  *  You may obtain a copy of the License at
  73.  *      http://www.apache.org/licenses/LICENSE-2.0
  74.  *  
  75.  *  Unless required by applicable law or agreed to in writing, software
  76.  *      distributed under the License is distributed on an "AS IS" BASIS,
  77.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  78.  *  
  79.  *  See the License for the specific language governing permissions and
  80.  *      limitations under the License.
  81.  */

  83. /**
  84.  * <i>HyperbolicTension</i> provides the evaluation of the Hyperbolic Tension Function and its derivatives
  85.  * for a specified variate.
  86.  *
  87.  *  <br><br>
  88.  *  <ul>
  89.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  90.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalAnalysisLibrary.md">Numerical Analysis Library</a></li>
  91.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/function/README.md">R<sup>d</sup> To R<sup>d</sup> Function Analysis</a></li>
  92.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/function/r1tor1/README.md">Built-in R<sup>1</sup> To R<sup>1</sup> Functions</a></li>
  93.  *  </ul>
  94.  *
  95.  * @author Lakshmi Krishnamurthy
  96.  */

  98. public class HyperbolicTension extends org.drip.function.definition.R1ToR1 {

  100.     /**
  101.      * Hyperbolic Tension Function Type - sinh
  102.      */

  104.     public static final int SINH = 1;

  106.     /**
  107.      * Hyperbolic Tension Function Type - cosh
  108.      */

  110.     public static final int COSH = 2;

  112.     private int _iType = -1;
  113.     private double _dblTension = java.lang.Double.NaN;

  115.     /**
  116.      * HyperbolicTension constructor
  117.      * 
  118.      * @param iType Type of the HyperbolicTension Function - SINH/COSH/TANH
  119.      * @param dblTension Tension of the HyperbolicTension Function
  120.      * 
  121.      * @throws java.lang.Exception Thrown if the input is invalid
  122.      */

  124.     public HyperbolicTension (
  125.         final int iType,
  126.         final double dblTension)
  127.         throws java.lang.Exception
  128.     {
  129.         super (null);

  131.         if ((SINH != (_iType = iType) && COSH != _iType) || !org.drip.numerical.common.NumberUtil.IsValid
  132.             (_dblTension = dblTension))
  133.             throw new java.lang.Exception ("HyperbolicTension ctr: Invalid Inputs");
  134.     }

  136.     @Override public double evaluate (
  137.         final double dblVariate)
  138.         throws java.lang.Exception
  139.     {
  140.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblVariate))
  141.             throw new java.lang.Exception ("HyperbolicTension::evaluate => Invalid Inputs");

  143.         return SINH == _iType ? java.lang.Math.sinh (_dblTension * dblVariate) : java.lang.Math.cosh
  144.             (_dblTension * dblVariate);
  145.     }

  147.     @Override public double derivative (
  148.         final double dblVariate,
  149.         final int iOrder)
  150.         throws java.lang.Exception
  151.     {
  152.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblVariate) || 0 > iOrder)
  153.             throw new java.lang.Exception ("HyperbolicTension::derivative => Invalid Inputs");

  155.         double dblDerivFactor = 1.;

  157.         for (int i = 0; i < iOrder; ++i)
  158.             dblDerivFactor *= _dblTension;

  160.         return (SINH == _iType) ? dblDerivFactor * (1 == iOrder % 2 ? java.lang.Math.cosh (_dblTension *
  161.             dblVariate) : java.lang.Math.sinh (_dblTension * dblVariate)) : dblDerivFactor * (1 == iOrder % 2
  162.                 ? java.lang.Math.sinh (_dblTension * dblVariate) : java.lang.Math.cosh (_dblTension *
  163.                     dblVariate));
  164.     }

  166.     @Override public double integrate (
  167.         final double dblBegin,
  168.         final double dblEnd)
  169.         throws java.lang.Exception
  170.     {
  171.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblBegin) || !org.drip.numerical.common.NumberUtil.IsValid
  172.             (dblEnd))
  173.             throw new java.lang.Exception ("HyperbolicTension::integrate => Invalid Inputs");

  175.         return SINH == _iType ? (java.lang.Math.cosh (_dblTension * dblEnd) - java.lang.Math.cosh
  176.             (_dblTension * dblBegin)) / _dblTension : (java.lang.Math.sinh (_dblTension * dblEnd) -
  177.                 java.lang.Math.sinh (_dblTension * dblBegin)) / _dblTension;
  178.     }

  180.     /**
  181.      * Retrieve the hyperbolic function type
  182.      * 
  183.      * @return Hyperbolic function type
  184.      */

  186.     public int getType()
  187.     {
  188.         return _iType;
  189.     }

  191.     /**
  192.      * Retrieve the Tension Parameter
  193.      * 
  194.      * @return Tension Parameter
  195.      */

  197.     public double getTension()
  198.     {
  199.         return _dblTension;
  200.     }

  202.     public static final void main (
  203.         final java.lang.String[] astrArgs)
  204.         throws java.lang.Exception
  205.     {
  206.         HyperbolicTension e = new HyperbolicTension (SINH, 2.);

  208.         System.out.println ("E[0.0] = " + e.evaluate (0.0));

  210.         System.out.println ("E[0.5] = " + e.evaluate (0.5));

  212.         System.out.println ("E[1.0] = " + e.evaluate (1.0));

  214.         System.out.println ("EDeriv[0.0] = " + e.derivative (0.0, 2));

  216.         System.out.println ("EDeriv[0.5] = " + e.derivative (0.5, 2));

  218.         System.out.println ("EDeriv[1.0] = " + e.derivative (1.0, 2));
  219.     }
  220. }
Created with JaCoCo 0.7.9.201702052155