InfiniteSumEstimator.java

  1. package org.drip.specialfunction.loggamma;

  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>InfiniteSumEstimator</i> estimates Log Gamma using the Infinite Series Infinite Sum. The References
  79.  * are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Blagouchine, I. V. (2014): Re-discovery of Malmsten's Integrals, their Evaluation by Contour
  85.  *              Integration Methods, and some Related Results <i>Ramanujan Journal</i> <b>35 (1)</b> 21-110
  86.  *      </li>
  87.  *      <li>
  88.  *          Borwein, J. M., and R. M. Corless (2017): Gamma Function and the Factorial in the Monthly
  89.  *              https://arxiv.org/abs/1703.05349 <b>arXiv</b>
  90.  *      </li>
  91.  *      <li>
  92.  *          Davis, P. J. (1959): Leonhard Euler's Integral: A Historical Profile of the Gamma Function
  93.  *              <i>American Mathematical Monthly</i> <b>66 (10)</b> 849-869
  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): Gamma Function https://en.wikipedia.org/wiki/Gamma_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/loggamma/README.md">Analytic/Series/Integral Log Gamma Estimators</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  115. public abstract class InfiniteSumEstimator extends org.drip.numerical.estimation.R1ToR1Estimator
  116. {
  117.     private org.drip.numerical.estimation.R1ToR1Series _infiniteSumSeries = null;

  119.     /**
  120.      * Compute the Euler Infinite Sum Series of Log Gamma Estimator
  121.      * 
  122.      * @param termCount Number of Terms in the Estimation
  123.      * 
  124.      * @return The Euler Infinite Sum Series of Log Gamma Estimator
  125.      */

  127.     public static final InfiniteSumEstimator Euler (
  128.         final int termCount)
  129.     {
  130.         try
  131.         {
  132.             return new InfiniteSumEstimator (
  133.                 org.drip.specialfunction.loggamma.InfiniteSumSeries.Euler (termCount),
  134.                 null
  135.             )
  136.             {
  137.                 @Override public double evaluate (
  138.                     final double z)
  139.                     throws java.lang.Exception
  140.                 {
  141.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || z <= 0.)
  142.                     {
  143.                         throw new java.lang.Exception
  144.                             ("InfiniteSumEstimator::Euler::evaluate => Invalid Inputs");
  145.                     }

  147.                     return infiniteSumSeries().evaluate (z) - java.lang.Math.log (z);
  148.                 }
  149.             };
  150.         }
  151.         catch (java.lang.Exception e)
  152.         {
  153.             e.printStackTrace();
  154.         }

  156.         return null;
  157.     }

  159.     /**
  160.      * Compute the Weierstrass Infinite Sum Series of Log Gamma Estimator
  161.      * 
  162.      * @param termCount Number of Terms in the Estimation
  163.      * 
  164.      * @return The Weierstrass Infinite Sum Series of Log Gamma Estimator
  165.      */

  167.     public static final InfiniteSumEstimator Weierstrass (
  168.         final int termCount)
  169.     {
  170.         try
  171.         {
  172.             return new InfiniteSumEstimator (
  173.                 org.drip.specialfunction.loggamma.InfiniteSumSeries.Weierstrass (termCount),
  174.                 null
  175.             )
  176.             {
  177.                 @Override public double evaluate (
  178.                     final double z)
  179.                     throws java.lang.Exception
  180.                 {
  181.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || z <= 0.)
  182.                     {
  183.                         throw new java.lang.Exception
  184.                             ("InfiniteSumEstimator::Weierstrass::evaluate => Invalid Inputs");
  185.                     }

  187.                     return infiniteSumSeries().evaluate (z) - java.lang.Math.log (z) -
  188.                         z * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI;
  189.                 }
  190.             };
  191.         }
  192.         catch (java.lang.Exception e)
  193.         {
  194.             e.printStackTrace();
  195.         }

  197.         return null;
  198.     }

  200.     /**
  201.      * Compute the Fourier Infinite Sum Series of Log Gamma Estimator
  202.      * 
  203.      * @param termCount Number of Terms in the Estimation
  204.      * 
  205.      * @return The Fourier Infinite Sum Series of Log Gamma Estimator
  206.      */

  208.     public static final InfiniteSumEstimator Fourier (
  209.         final int termCount)
  210.     {
  211.         try
  212.         {
  213.             return new InfiniteSumEstimator (
  214.                 org.drip.specialfunction.loggamma.InfiniteSumSeries.Fourier (termCount),
  215.                 null
  216.             )
  217.             {
  218.                 @Override public double evaluate (
  219.                     final double z)
  220.                     throws java.lang.Exception
  221.                 {
  222.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. >= z || 1. <= z)
  223.                     {
  224.                         throw new java.lang.Exception
  225.                             ("InfiniteSumEstimator::Fourier::evaluate => Invalid Inputs");
  226.                     }

  228.                     return (0.5 - z) * (org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI +
  229.                         java.lang.Math.log (2.)) + (1. - z) * java.lang.Math.log (java.lang.Math.PI) -
  230.                         0.5 * java.lang.Math.log (java.lang.Math.sin (java.lang.Math.PI * z)) +
  231.                         infiniteSumSeries().evaluate (z) / java.lang.Math.PI;
  232.                 }
  233.             };
  234.         }
  235.         catch (java.lang.Exception e)
  236.         {
  237.             e.printStackTrace();
  238.         }

  240.         return null;
  241.     }

  243.     /**
  244.      * Compute the Blagouchine (2015) Infinite Sum Series of Log Gamma Estimator
  245.      * 
  246.      * @param termCount Number of Terms in the Estimation
  247.      * 
  248.      * @return The Blagouchine (2015) Infinite Sum Series of Log Gamma Estimator
  249.      */

  251.     public static final InfiniteSumEstimator Blagouchine2015 (
  252.         final int termCount)
  253.     {
  254.         try
  255.         {
  256.             return new InfiniteSumEstimator (
  257.                 org.drip.specialfunction.loggamma.InfiniteSumSeries.Blagouchine2015 (termCount),
  258.                 null
  259.             )
  260.             {
  261.                 @Override public double evaluate (
  262.                     final double z)
  263.                     throws java.lang.Exception
  264.                 {
  265.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. >= z || 1. <= z || 0.5 == z)
  266.                     {
  267.                         throw new java.lang.Exception
  268.                             ("InfiniteSumEstimator::Blagouchine2015::evaluate => Invalid Inputs");
  269.                     }

  271.                     return (0.5 - z) * java.lang.Math.log (2. * java.lang.Math.PI) +
  272.                         0.5 * (
  273.                             java.lang.Math.log (java.lang.Math.PI) -
  274.                             java.lang.Math.log (java.lang.Math.sin (java.lang.Math.PI * z))
  275.                         ) +
  276.                         infiniteSumSeries().evaluate (z) / java.lang.Math.PI +
  277.                         org.drip.numerical.integration.NewtonCotesQuadratureGenerator.GaussLaguerreLeftDefinite (
  278.                             0.,
  279.                             100
  280.                         ).integrate (
  281.                             new org.drip.function.definition.R1ToR1 (null)
  282.                             {
  283.                                 @Override public double evaluate (
  284.                                     final double x)
  285.                                     throws java.lang.Exception
  286.                                 {
  287.                                     return 0. == x || java.lang.Double.isInfinite (x) ? 0. :
  288.                                         java.lang.Math.exp (-1. * termCount * x) *
  289.                                         java.lang.Math.log (x) / (
  290.                                             java.lang.Math.cosh (x) -
  291.                                             java.lang.Math.cos (2. * java.lang.Math.PI * z)
  292.                                         );
  293.                                 }
  294.                             }
  295.                         ) * java.lang.Math.sin (2. * java.lang.Math.PI * z) / (2. * java.lang.Math.PI);
  296.                 }
  297.             };
  298.         }
  299.         catch (java.lang.Exception e)
  300.         {
  301.             e.printStackTrace();
  302.         }

  304.         return null;
  305.     }

  307.     /**
  308.      * InfiniteSum Constructor
  309.      * 
  310.      * @param infiniteSumSeries R<sup>1</sup> To R<sup>1</sup> Infinite Sum Series
  311.      * @param dc Differential Control
  312.      * 
  313.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  314.      */

  316.     protected InfiniteSumEstimator (
  317.         final org.drip.numerical.estimation.R1ToR1Series infiniteSumSeries,
  318.         final org.drip.numerical.differentiation.DerivativeControl dc)
  319.         throws java.lang.Exception
  320.     {
  321.         super (dc);

  323.         _infiniteSumSeries = infiniteSumSeries;
  324.     }

  326.     /**
  327.      * Retrieve the Underlying Infinite Sum Series
  328.      * 
  329.      * @return The Underlying Infinite Sum Series
  330.      */

  332.     public org.drip.numerical.estimation.R1ToR1Series infiniteSumSeries()
  333.     {
  334.         return _infiniteSumSeries;
  335.     }

  337.     @Override public org.drip.numerical.estimation.R1Estimate seriesEstimateNative (
  338.         final double x)
  339.     {
  340.         return null == _infiniteSumSeries ? seriesEstimate (
  341.             x,
  342.             null,
  343.             null
  344.         ) : seriesEstimate (
  345.             x,
  346.             _infiniteSumSeries.termWeightMap(),
  347.             _infiniteSumSeries
  348.         );
  349.     }

  351.     @Override public org.drip.function.definition.PoleResidue poleResidue (
  352.         final double x)
  353.     {
  354.         if (!org.drip.numerical.common.NumberUtil.IsValid (x))
  355.         {
  356.             return null;
  357.         }

  359.         int n = (int) x;

  361.         if (0 != (x - n) || x >= 0.)
  362.         {
  363.             return org.drip.function.definition.PoleResidue.NotAPole (x);
  364.         }

  366.         n = -n;

  368.         try
  369.         {
  370.             return new org.drip.function.definition.PoleResidue (
  371.                 x,
  372.                 (1 == n % 2 ? -1. : 1.) /
  373.                     new org.drip.specialfunction.gamma.NemesAnalytic (null).evaluate (n + 1.)
  374.             );
  375.         }
  376.         catch (java.lang.Exception e)
  377.         {
  378.             e.printStackTrace();
  379.         }

  381.         return null;
  382.     }
  383. }
Created with JaCoCo 0.7.9.201702052155