IntegralEstimator.java

  1. package org.drip.specialfunction.digamma;

  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>IntegralEstimator</i> demonstrates the Estimation of the Digamma Function using the Integral
  79.  * Representations. The References are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Abramowitz, M., and I. A. Stegun (2007): Handbook of Mathematics Functions <b>Dover Book on
  85.  *              Mathematics</b>
  86.  *      </li>
  87.  *      <li>
  88.  *          Blagouchine, I. V. (2018): Three Notes on Ser's and Hasse's Representations for the
  89.  *              Zeta-Functions https://arxiv.org/abs/1606.02044 <b>arXiv</b>
  90.  *      </li>
  91.  *      <li>
  92.  *          Mezo, I., and M. E. Hoffman (2017): Zeros of the Digamma Function and its Barnes G-function
  93.  *              Analogue <i>Integral Transforms and Special Functions</i> <b>28 (28)</b> 846-858
  94.  *      </li>
  95.  *      <li>
  96.  *          Whitaker, E. T., and G. N. Watson (1996): <i>A Course on Modern Analysis</i> <b>Cambridge
  97.  *              University Press</b> New York
  98.  *      </li>
  99.  *      <li>
  100.  *          Wikipedia (2019): Digamma Function https://en.wikipedia.org/wiki/Digamma_function
  101.  *      </li>
  102.  *  </ul>
  103.  *
  104.  *  <br><br>
  105.  *  <ul>
  106.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  107.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FunctionAnalysisLibrary.md">Function Analysis Library</a></li>
  108.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/README.md">Special Function Implementation Analysis</a></li>
  109.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/digamma/README.md">Estimation Techniques for Digamma Function</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  115. public class IntegralEstimator
  116. {

  118.     /**
  119.      * Generate the Gaussian Integral Digamma Estimator
  120.      * 
  121.      * @return The Gaussian Integral Digamma Estimator
  122.      */

  124.     public static final org.drip.numerical.estimation.R1ToR1IntegrandEstimator Gauss()
  125.     {
  126.         try
  127.         {
  128.             return new org.drip.numerical.estimation.R1ToR1IntegrandEstimator (
  129.                 null,
  130.                 new org.drip.numerical.estimation.R1ToR1IntegrandGenerator()
  131.                 {
  132.                     @Override public org.drip.numerical.estimation.R1ToR1Estimator integrand (
  133.                         final double z)
  134.                     {
  135.                         try
  136.                         {
  137.                             return new org.drip.numerical.estimation.R1ToR1Estimator (null)
  138.                             {
  139.                                 @Override public double evaluate (
  140.                                     final double t)
  141.                                     throws java.lang.Exception
  142.                                 {
  143.                                     double ePowerMinusT = java.lang.Math.exp (-t);

  145.                                     return 0. == t || java.lang.Double.isInfinite (t) ? 0. :
  146.                                         (ePowerMinusT / t) - (java.lang.Math.exp (-z * t) /
  147.                                             (1. - ePowerMinusT));
  148.                                 }
  149.                             };
  150.                         }
  151.                         catch (java.lang.Exception e)
  152.                         {
  153.                             e.printStackTrace();
  154.                         }

  156.                         return null;
  157.                     }
  158.                 },
  159.                 org.drip.numerical.estimation.R1ToR1IntegrandEstimator.INTEGRAND_LIMITS_SETTING_ZERO_INFINITY,
  160.                 1.,
  161.                 new org.drip.numerical.estimation.R1ToR1Estimator (null)
  162.                 {
  163.                     @Override public double evaluate (
  164.                         final double z)
  165.                         throws java.lang.Exception
  166.                     {
  167.                         return 0.;
  168.                     }
  169.                 }
  170.             );
  171.         }
  172.         catch (java.lang.Exception e)
  173.         {
  174.             e.printStackTrace();
  175.         }

  177.         return null;
  178.     }

  180.     /**
  181.      * Generate the Gauss-Euler-Mascheroni Integral Digamma Estimator
  182.      * 
  183.      * @return The Gauss-Euler-Mascheroni Integral Digamma Estimator
  184.      */

  186.     public static final org.drip.numerical.estimation.R1ToR1IntegrandEstimator GaussEulerMascheroni()
  187.     {
  188.         try
  189.         {
  190.             return new org.drip.numerical.estimation.R1ToR1IntegrandEstimator (
  191.                 null,
  192.                 new org.drip.numerical.estimation.R1ToR1IntegrandGenerator()
  193.                 {
  194.                     @Override public org.drip.numerical.estimation.R1ToR1Estimator integrand (
  195.                         final double z)
  196.                     {
  197.                         try
  198.                         {
  199.                             return new org.drip.numerical.estimation.R1ToR1Estimator (null)
  200.                             {
  201.                                 @Override public double evaluate (
  202.                                     final double t)
  203.                                     throws java.lang.Exception
  204.                                 {
  205.                                     return 0. == t ? 1. -
  206.                                         org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI : 1. == t
  207.                                         ? -org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI : (
  208.                                             1. - java.lang.Math.pow (
  209.                                                 t,
  210.                                                 z - 1.
  211.                                             )
  212.                                         ) / (1. - t);
  213.                                 }
  214.                             };
  215.                         }
  216.                         catch (java.lang.Exception e)
  217.                         {
  218.                             e.printStackTrace();
  219.                         }

  221.                         return null;
  222.                     }
  223.                 },
  224.                 org.drip.numerical.estimation.R1ToR1IntegrandEstimator.INTEGRAND_LIMITS_SETTING_ZERO_ONE,
  225.                 1.,
  226.                 new org.drip.numerical.estimation.R1ToR1Estimator (null)
  227.                 {
  228.                     @Override public double evaluate (
  229.                         final double z)
  230.                         throws java.lang.Exception
  231.                     {
  232.                         return -org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI;
  233.                     }
  234.                 }
  235.             );
  236.         }
  237.         catch (java.lang.Exception e)
  238.         {
  239.             e.printStackTrace();
  240.         }

  242.         return null;
  243.     }

  245.     /**
  246.      * Generate the Dirichlet Integral Digamma Estimator
  247.      * 
  248.      * @return The Dirichlet Integral Digamma Estimator
  249.      */

  251.     public static final org.drip.numerical.estimation.R1ToR1IntegrandEstimator Dirichlet()
  252.     {
  253.         try
  254.         {
  255.             return new org.drip.numerical.estimation.R1ToR1IntegrandEstimator (
  256.                 null,
  257.                 new org.drip.numerical.estimation.R1ToR1IntegrandGenerator()
  258.                 {
  259.                     @Override public org.drip.numerical.estimation.R1ToR1Estimator integrand (
  260.                         final double z)
  261.                     {
  262.                         try
  263.                         {
  264.                             return new org.drip.numerical.estimation.R1ToR1Estimator (null)
  265.                             {
  266.                                 @Override public double evaluate (
  267.                                     final double t)
  268.                                     throws java.lang.Exception
  269.                                 {
  270.                                     return 0. == t || java.lang.Double.isInfinite (t) ? 0. : (
  271.                                         java.lang.Math.exp (-t) - java.lang.Math.pow (
  272.                                             1. + t,
  273.                                             -z
  274.                                         )
  275.                                     ) / t;
  276.                                 }
  277.                             };
  278.                         }
  279.                         catch (java.lang.Exception e)
  280.                         {
  281.                             e.printStackTrace();
  282.                         }

  284.                         return null;
  285.                     }
  286.                 },
  287.                 org.drip.numerical.estimation.R1ToR1IntegrandEstimator.INTEGRAND_LIMITS_SETTING_ZERO_INFINITY,
  288.                 1.,
  289.                 new org.drip.numerical.estimation.R1ToR1Estimator (null)
  290.                 {
  291.                     @Override public double evaluate (
  292.                         final double z)
  293.                         throws java.lang.Exception
  294.                     {
  295.                         return 0.;
  296.                     }
  297.                 }
  298.             );
  299.         }
  300.         catch (java.lang.Exception e)
  301.         {
  302.             e.printStackTrace();
  303.         }

  305.         return null;
  306.     }

  308.     /**
  309.      * Generate the Binet Second Integral Digamma Estimator
  310.      * 
  311.      * @return The Binet Second Integral Digamma Estimator
  312.      */

  314.     public static final org.drip.numerical.estimation.R1ToR1IntegrandEstimator BinetSecond()
  315.     {
  316.         try
  317.         {
  318.             return new org.drip.numerical.estimation.R1ToR1IntegrandEstimator (
  319.                 null,
  320.                 new org.drip.numerical.estimation.R1ToR1IntegrandGenerator()
  321.                 {
  322.                     @Override public org.drip.numerical.estimation.R1ToR1Estimator integrand (
  323.                         final double z)
  324.                     {
  325.                         try
  326.                         {
  327.                             return new org.drip.numerical.estimation.R1ToR1Estimator (null)
  328.                             {
  329.                                 @Override public double evaluate (
  330.                                     final double t)
  331.                                     throws java.lang.Exception
  332.                                 {
  333.                                     return 0. == t || java.lang.Double.isInfinite (t) ? 0. : t / (
  334.                                         (t * t + z * z) *
  335.                                             (java.lang.Math.exp (2. * java.lang.Math.PI * t) - 1.)
  336.                                     );
  337.                                 }
  338.                             };
  339.                         }
  340.                         catch (java.lang.Exception e)
  341.                         {
  342.                             e.printStackTrace();
  343.                         }

  345.                         return null;
  346.                     }
  347.                 },
  348.                 org.drip.numerical.estimation.R1ToR1IntegrandEstimator.INTEGRAND_LIMITS_SETTING_ZERO_INFINITY,
  349.                 -2.,
  350.                 new org.drip.numerical.estimation.R1ToR1Estimator (null)
  351.                 {
  352.                     @Override public double evaluate (
  353.                         final double z)
  354.                         throws java.lang.Exception
  355.                     {
  356.                         return 0. == z ? 0. : java.lang.Math.log (z) - 0.5 / z;
  357.                     }
  358.                 }
  359.             );
  360.         }
  361.         catch (java.lang.Exception e)
  362.         {
  363.             e.printStackTrace();
  364.         }

  366.         return null;
  367.     }
  368. }
Created with JaCoCo 0.7.9.201702052155