ErrorFunctionComplementAnalytical.java

  1. package org.drip.function.e2erfc;

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

  77. /**
  78.  * <i>ErrorFunctionComplementAnalytical</i> implements Analytical Versions of the Error Function Complement
  79.  * (erfc) Estimate. The References are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Abramowitz, M., and I. A. Stegun (2007): <i>Handbook of Mathematics Functions</i> <b>Dover Book
  85.  *              on Mathematics</b>
  86.  *      </li>
  87.  *      <li>
  88.  *          Chang, S. H., P. C. Cosman, L. B. Milstein (2011): Chernoff-Type Bounds for Gaussian Error
  89.  *              Function <i>IEEE Transactions on Communications</i> <b>59 (11)</b> 2939-2944
  90.  *      </li>
  91.  *      <li>
  92.  *          Cody, W. J. (1991): Algorithm 715: SPECFUN – A Portable FORTRAN Package of Special Function
  93.  *              Routines and Test Drivers <i>ACM Transactions on Mathematical Software</i> <b>19 (1)</b>
  94.  *              22-32
  95.  *      </li>
  96.  *      <li>
  97.  *          Schopf, H. M., and P. H. Supancic (2014): On Burmann’s Theorem and its Application to Problems of
  98.  *              Linear and Non-linear Heat Transfer and Diffusion
  99.  *              https://www.mathematica-journal.com/2014/11/on-burmanns-theorem-and-its-application-to-problems-of-linear-and-nonlinear-heat-transfer-and-diffusion/#more-39602/
  100.  *      </li>
  101.  *      <li>
  102.  *          Wikipedia (2019): Error Function https://en.wikipedia.org/wiki/Error_function
  103.  *      </li>
  104.  *  </ul>
  105.  *
  106.  *  <br><br>
  107.  *  <ul>
  108.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  109.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalAnalysisLibrary.md">Numerical Analysis Library</a></li>
  110.  *      <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>
  111.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/function/e2erfc/README.md">E<sub>2</sub> erfc Estimation Function Implementation</a></li>
  112.  *  </ul>
  113.  *
  114.  * @author Lakshmi Krishnamurthy
  115.  */

  117. public class ErrorFunctionComplementAnalytical
  118. {

  120.     private static final double ContinuedFractionRecursor (
  121.         final double z,
  122.         final int termIndex,
  123.         final int termCount)
  124.     {
  125.         if (termIndex == termCount)
  126.         {
  127.             return 0.;
  128.         }

  130.         return ((1 == termIndex % 2) ? z * z : 1.) + 0.5 * termIndex / (
  131.             1. + ContinuedFractionRecursor (
  132.                 z,
  133.                 termIndex + 1,
  134.                 termCount
  135.             )
  136.         );
  137.     }

  139.     /**
  140.      * Construct Karagiannidis-Lioumpas (2007) Version of the Analytical Error Function Complement
  141.      * 
  142.      * @param A A
  143.      * @param B B
  144.      * 
  145.      * @return Karagiannidis-Lioumpas (2007) Version of the Analytical Error Function Complement
  146.      */

  148.     public static final org.drip.function.e2erfc.ErrorFunctionComplement KaragiannidisLioumpas2007 (
  149.         final double A,
  150.         final double B)
  151.     {
  152.         try
  153.         {
  154.             return !org.drip.numerical.common.NumberUtil.IsValid (A) ||
  155.                 !org.drip.numerical.common.NumberUtil.IsValid (B) ? null :
  156.                     new org.drip.function.e2erfc.ErrorFunctionComplement (
  157.                         null,
  158.                         null
  159.                     )
  160.                 {
  161.                     @Override public double evaluate (
  162.                         final double z)
  163.                         throws java.lang.Exception
  164.                     {
  165.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  166.                         {
  167.                             throw new java.lang.Exception
  168.                                 ("ErrorFunctionComplementAnalytical::KaragiannidisLioumpas2007::evaluate => Invalid Inputs");
  169.                         }

  171.                         if (0. == z)
  172.                         {
  173.                             return 1.;
  174.                         }

  176.                         if (z < 0)
  177.                         {
  178.                             return 2. - evaluate (-1. * z);
  179.                         }

  181.                         return (1. - java.lang.Math.exp (-1. * A * z)) * java.lang.Math.exp (-1. * z * z) /
  182.                             (B * z * java.lang.Math.sqrt (java.lang.Math.PI));
  183.                     }
  184.                 };
  185.         }
  186.         catch (java.lang.Exception e)
  187.         {
  188.             e.printStackTrace();
  189.         }

  191.         return null;
  192.     }

  194.     /**
  195.      * Construct Karagiannidis-Lioumpas (2007) Version of the Analytical Error Function Complement
  196.      * 
  197.      * @return Karagiannidis-Lioumpas (2007) Version of the Analytical Error Function Complement
  198.      */

  200.     public static final org.drip.function.e2erfc.ErrorFunctionComplement KaragiannidisLioumpas2007()
  201.     {
  202.         return KaragiannidisLioumpas2007 (
  203.             1.980,
  204.             1.135
  205.         );
  206.     }

  208.     /**
  209.      * Construct the Chiani-Dardari-Simon (2012a) Version of the Analytical Error Function Complement
  210.      * 
  211.      * @return The Chiani-Dardari-Simon (2012a) Version of the Analytical Error Function Complement
  212.      */

  214.     public static final org.drip.function.e2erfc.ErrorFunctionComplement ChianiDardariSimon2012a()
  215.     {
  216.         try
  217.         {
  218.             return new org.drip.function.e2erfc.ErrorFunctionComplement (
  219.                 null,
  220.                 null
  221.             )
  222.             {
  223.                 @Override public double evaluate (
  224.                     final double z)
  225.                     throws java.lang.Exception
  226.                 {
  227.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  228.                     {
  229.                         throw new java.lang.Exception
  230.                             ("ErrorFunctionComplementAnalytical::ChianiDardariSimon2012a::evaluate => Invalid Inputs");
  231.                     }

  233.                     if (0. == z)
  234.                     {
  235.                         return 1.;
  236.                     }

  238.                     if (z < 0)
  239.                     {
  240.                         return 2. - evaluate (-1. * z);
  241.                     }

  243.                     return 0.5 * java.lang.Math.exp (-2. * z * z) + 0.5 * java.lang.Math.exp (-1. * z * z);
  244.                 }

  246.                 @Override public org.drip.numerical.estimation.R1Estimate boundedEstimate (
  247.                     final double z)
  248.                 {
  249.                     try
  250.                     {
  251.                         double baseline = evaluate (z);

  253.                         return new org.drip.numerical.estimation.R1Estimate (
  254.                             baseline,
  255.                             baseline,
  256.                             java.lang.Math.exp (-1. * z * z)
  257.                         );
  258.                     }
  259.                     catch (java.lang.Exception e)
  260.                     {
  261.                         e.printStackTrace();
  262.                     }

  264.                     return null;
  265.                 }
  266.             };
  267.         }
  268.         catch (java.lang.Exception e)
  269.         {
  270.             e.printStackTrace();
  271.         }

  273.         return null;
  274.     }

  276.     /**
  277.      * Construct the Chiani-Dardari-Simon (2012b) Version of the Analytical Error Function Complement
  278.      * 
  279.      * @return The Chiani-Dardari-Simon (2012b) Version of the Analytical Error Function Complement
  280.      */

  282.     public static final org.drip.function.e2erfc.ErrorFunctionComplement ChianiDardariSimon2012b()
  283.     {
  284.         try
  285.         {
  286.             return new org.drip.function.e2erfc.ErrorFunctionComplement (
  287.                 null,
  288.                 null
  289.             )
  290.             {
  291.                 @Override public double evaluate (
  292.                     final double z)
  293.                     throws java.lang.Exception
  294.                 {
  295.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  296.                     {
  297.                         throw new java.lang.Exception
  298.                             ("ErrorFunctionComplementAnalytical::ChianiDardariSimon2012b::evaluate => Invalid Inputs");
  299.                     }

  301.                     if (0. == z)
  302.                     {
  303.                         return 1.;
  304.                     }

  306.                     if (z < 0)
  307.                     {
  308.                         return 2. - evaluate (-1. * z);
  309.                     }

  311.                     return java.lang.Math.exp (-1. * z * z) / 6. + 0.5 * java.lang.Math.exp (-4. * z * z / 3.);
  312.                 }
  313.             };
  314.         }
  315.         catch (java.lang.Exception e)
  316.         {
  317.             e.printStackTrace();
  318.         }

  320.         return null;
  321.     }

  323.     /**
  324.      * Construct the Chang-Cosman-Milstein (2011) Version of the Analytical Error Function Complement
  325.      * 
  326.      * @param beta Beta
  327.      * 
  328.      * @return The Chang-Cosman-Milstein (2011) Version of the Analytical Error Function Complement
  329.      */

  331.     public static final org.drip.function.e2erfc.ErrorFunctionComplement ChangCosmanMilstein2011 (
  332.         final double beta)
  333.     {
  334.         try
  335.         {
  336.             return !org.drip.numerical.common.NumberUtil.IsValid (beta) || 1. >= beta ? null :
  337.                 new org.drip.function.e2erfc.ErrorFunctionComplement (
  338.                     null,
  339.                     null
  340.                 )
  341.             {
  342.                 @Override public double evaluate (
  343.                     final double z)
  344.                     throws java.lang.Exception
  345.                 {
  346.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  347.                     {
  348.                         throw new java.lang.Exception
  349.                             ("ErrorFunctionComplementAnalytical::ChangCosmanMilstein2011::evaluate => Invalid Inputs");
  350.                     }

  352.                     if (0. == z)
  353.                     {
  354.                         return 1.;
  355.                     }

  357.                     if (z < 0)
  358.                     {
  359.                         return 2. - evaluate (-1. * z);
  360.                     }

  362.                     return java.lang.Math.sqrt (2. * java.lang.Math.E * (beta - 1.) / java.lang.Math.PI) *
  363.                         java.lang.Math.exp (-1. * beta * z * z) / beta;
  364.                 }
  365.             };
  366.         }
  367.         catch (java.lang.Exception e)
  368.         {
  369.             e.printStackTrace();
  370.         }

  372.         return null;
  373.     }

  375.     /**
  376.      * Construct the Continued Fraction Expansion Version of the Analytical Error Function Complement
  377.      * 
  378.      * @param termCount Term Count
  379.      * 
  380.      * @return The Continued Fraction Expansion Version of the Analytical Error Function Complement
  381.      */

  383.     public static final org.drip.function.e2erfc.ErrorFunctionComplement ContinuedFractionExpansion (
  384.         final int termCount)
  385.     {
  386.         try
  387.         {
  388.             return 0 >= termCount ? null : new org.drip.function.e2erfc.ErrorFunctionComplement (
  389.                 null,
  390.                 null
  391.             )
  392.             {
  393.                 @Override public double evaluate (
  394.                     final double z)
  395.                     throws java.lang.Exception
  396.                 {
  397.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  398.                     {
  399.                         throw new java.lang.Exception
  400.                             ("ErrorFunctionComplementAnalytical::ContinuedFractionExpansion::evaluate => Invalid Inputs");
  401.                     }

  403.                     if (0. == z)
  404.                     {
  405.                         return 1.;
  406.                     }

  408.                     if (z < 0)
  409.                     {
  410.                         return 2. - evaluate (-1. * z);
  411.                     }

  413.                     return z * java.lang.Math.exp (-1. * z * z) / java.lang.Math.sqrt (java.lang.Math.PI) /
  414.                         ContinuedFractionRecursor (
  415.                             z,
  416.                             1,
  417.                             termCount
  418.                         );
  419.                 }
  420.             };
  421.         }
  422.         catch (java.lang.Exception e)
  423.         {
  424.             e.printStackTrace();
  425.         }

  427.         return null;
  428.     }

  430.     /**
  431.      * Construct the Craig 1991 Version of the ErrorFunctionComplement Quadrature
  432.      * 
  433.      * @return The Craig 1991 Version of the ErrorFunctionComplement Quadrature
  434.      */

  436.     public static final org.drip.function.e2erfc.ErrorFunctionComplement Craig1991()
  437.     {
  438.         try
  439.         {
  440.             return new org.drip.function.e2erfc.ErrorFunctionComplement (
  441.                 null,
  442.                 null
  443.             )
  444.             {
  445.                 @Override public double evaluate (
  446.                     final double z)
  447.                     throws java.lang.Exception
  448.                 {
  449.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  450.                     {
  451.                         throw new java.lang.Exception
  452.                             ("ErrorFunctionComplementAnalytical::Craig1991::evaluate => Invalid Inputs");
  453.                     }

  455.                     if (0. == z)
  456.                     {
  457.                         return 1.;
  458.                     }

  460.                     if (z < 0)
  461.                     {
  462.                         return 2. - evaluate (-1. * z);
  463.                     }

  465.                     return org.drip.numerical.integration.NewtonCotesQuadratureGenerator.Zero_PlusOne (
  466.                         0.,
  467.                         z,
  468.                         100
  469.                     ).integrate (
  470.                         new org.drip.function.definition.R1ToR1 (null)
  471.                         {
  472.                             @Override public double evaluate (
  473.                                 final double theta)
  474.                                 throws java.lang.Exception
  475.                             {
  476.                                 if (0. == theta)
  477.                                 {
  478.                                     return 0.;
  479.                                 }

  481.                                 double sinTheta = java.lang.Math.sin (theta);

  483.                                 return 2. * java.lang.Math.exp (-1. * z * z / (sinTheta * sinTheta)) /
  484.                                     java.lang.Math.PI;
  485.                             }
  486.                         }
  487.                     );
  488.                 }
  489.             };
  490.         }
  491.         catch (java.lang.Exception e)
  492.         {
  493.             e.printStackTrace();
  494.         }

  496.         return null;
  497.     }
  498. }
Created with JaCoCo 0.7.9.201702052155