CumulativeSeriesEstimator.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>CumulativeSeriesEstimator</i> implements the Cumulative Series Based Digamma Estimation. The References
  79.  * 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 abstract class CumulativeSeriesEstimator extends org.drip.numerical.estimation.R1ToR1Estimator
  116. {
  117.     private org.drip.numerical.estimation.R1ToR1Series _cumulativeSeries = null;

  119.     /**
  120.      * Compute the Abramowitz-Stegun (2007) Cumulative Series of Digamma Estimator
  121.      * 
  122.      * @param termCount Number of Terms in the Estimation
  123.      * 
  124.      * @return The Abramowitz-Stegun (2007) Cumulative Series of Digamma Estimator
  125.      */

  127.     public static final CumulativeSeriesEstimator AbramowitzStegun2007 (
  128.         final int termCount)
  129.     {
  130.         try
  131.         {
  132.             return new CumulativeSeriesEstimator (
  133.                 org.drip.specialfunction.digamma.CumulativeSeries.AbramowitzStegun2007 (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))
  142.                     {
  143.                         throw new java.lang.Exception
  144.                             ("CumulativeSeriesEstimator::AbramowitzStegun2007::evaluate => Invalid Inputs");
  145.                     }

  147.                     return cumulativeSeries().evaluate (z - 1.) -
  148.                         org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI;
  149.                 }
  150.             };
  151.         }
  152.         catch (java.lang.Exception e)
  153.         {
  154.             e.printStackTrace();
  155.         }

  157.         return null;
  158.     }

  160.     /**
  161.      * Compute the Harmonic Cumulative Series of Digamma Estimator
  162.      * 
  163.      * @return The Harmonic Cumulative Series of Digamma Estimator
  164.      */

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

  185.                     double harmonicEstimate = 0.;

  187.                     for (int i = 1; i < (int) z; ++i)
  188.                     {
  189.                         harmonicEstimate = harmonicEstimate + (1. / i);
  190.                     }

  192.                     return harmonicEstimate - org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI;
  193.                 }
  194.             };
  195.         }
  196.         catch (java.lang.Exception e)
  197.         {
  198.             e.printStackTrace();
  199.         }

  201.         return null;
  202.     }

  204.     /**
  205.      * Compute the Half-Integer Cumulative Series of Digamma Estimator
  206.      * 
  207.      * @return The Half-Integer Cumulative Series of Digamma Estimator
  208.      */

  210.     public static final CumulativeSeriesEstimator HalfInteger()
  211.     {
  212.         try
  213.         {
  214.             return new CumulativeSeriesEstimator (
  215.                 null,
  216.                 null
  217.             )
  218.             {
  219.                 @Override public double evaluate (
  220.                     final double z)
  221.                     throws java.lang.Exception
  222.                 {
  223.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z || 0.5 != z - (int) z)
  224.                     {
  225.                         throw new java.lang.Exception
  226.                             ("CumulativeSeriesEstimator::HalfInteger::evaluate => Invalid Inputs");
  227.                     }

  229.                     double halfIntegerEstimate = 0.;

  231.                     for (int i = 1; i <= (int) z; ++i)
  232.                     {
  233.                         halfIntegerEstimate = halfIntegerEstimate + (1. / (-0.5 + i));
  234.                     }

  236.                     return halfIntegerEstimate - org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI
  237.                         - java.lang.Math.log (4.);
  238.                 }
  239.             };
  240.         }
  241.         catch (java.lang.Exception e)
  242.         {
  243.             e.printStackTrace();
  244.         }

  246.         return null;
  247.     }

  249.     /**
  250.      * Compute the Saddle-Point Cumulative Series of Digamma Estimator
  251.      * 
  252.      * @param logGammaEstimator The Log Gamma Estimator
  253.      * @param saddlePointFunction The Saddle Point Generation Function
  254.      * @param saddlePointCount The Saddle Point Count
  255.      * 
  256.      * @return The Saddle-Point Cumulative Series of Digamma Estimator
  257.      */

  259.     public static final CumulativeSeriesEstimator MezoHoffman2017 (
  260.         final org.drip.function.definition.R1ToR1 logGammaEstimator,
  261.         final org.drip.function.definition.R1ToR1 saddlePointFunction,
  262.         final int saddlePointCount)
  263.     {
  264.         if (null == logGammaEstimator)
  265.         {
  266.             return null;
  267.         }

  269.         try
  270.         {
  271.             return new CumulativeSeriesEstimator (
  272.                 org.drip.specialfunction.digamma.CumulativeSeries.MezoHoffman2017 (
  273.                     saddlePointFunction,
  274.                     saddlePointCount
  275.                 ),
  276.                 null
  277.             )
  278.             {
  279.                 @Override public double evaluate (
  280.                     final double z)
  281.                     throws java.lang.Exception
  282.                 {
  283.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  284.                     {
  285.                         throw new java.lang.Exception
  286.                             ("CumulativeSeriesEstimator::MezoHoffman2017::evaluate => Invalid Inputs");
  287.                     }

  289.                     return -1. * java.lang.Math.exp (
  290.                         logGammaEstimator.evaluate (z) + 
  291.                         cumulativeSeries().evaluate (z) +
  292.                         2. * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI * z
  293.                     );
  294.                 }
  295.             };
  296.         }
  297.         catch (java.lang.Exception e)
  298.         {
  299.             e.printStackTrace();
  300.         }

  302.         return null;
  303.     }

  305.     /**
  306.      * Compute the Gauss Cumulative Series of Digamma Estimator
  307.      * 
  308.      * @param termCount Term Count
  309.      * 
  310.      * @return The Gauss Cumulative Series of Digamma Estimator
  311.      */

  313.     public static final CumulativeSeriesEstimator Gauss (
  314.         final int termCount)
  315.     {
  316.         try
  317.         {
  318.             return new CumulativeSeriesEstimator (
  319.                 org.drip.specialfunction.digamma.CumulativeSeries.Gauss (termCount),
  320.                 null
  321.             )
  322.             {
  323.                 @Override public double evaluate (
  324.                     final double z)
  325.                     throws java.lang.Exception
  326.                 {
  327.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z || 1. < z)
  328.                     {
  329.                         throw new java.lang.Exception
  330.                             ("CumulativeSeriesEstimator::Gauss::evaluate => Invalid Inputs");
  331.                     }

  333.                     return 2. * cumulativeSeries().evaluate (z) -
  334.                         org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI -
  335.                         java.lang.Math.log (2. * termCount) -
  336.                         0.5 * java.lang.Math.PI / java.lang.Math.tan (java.lang.Math.PI * z);
  337.                 }
  338.             };
  339.         }
  340.         catch (java.lang.Exception e)
  341.         {
  342.             e.printStackTrace();
  343.         }

  345.         return null;
  346.     }

  348.     /**
  349.      * Compute the Asymptotic Cumulative Series of Digamma Estimator
  350.      * 
  351.      * @return The Asymptotic Cumulative Series of Digamma Estimator
  352.      */

  354.     public static final CumulativeSeriesEstimator Asymptotic()
  355.     {
  356.         try
  357.         {
  358.             return new CumulativeSeriesEstimator (
  359.                 org.drip.specialfunction.digamma.CumulativeSeries.Asymptotic(),
  360.                 null
  361.             )
  362.             {
  363.                 @Override public double evaluate (
  364.                     final double z)
  365.                     throws java.lang.Exception
  366.                 {
  367.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z)
  368.                     {
  369.                         throw new java.lang.Exception
  370.                             ("CumulativeSeriesEstimator::Asymptotic::evaluate => Invalid Inputs");
  371.                     }

  373.                     return java.lang.Math.log (z) - 0.5 / z + cumulativeSeries().evaluate (z);
  374.                 }
  375.             };
  376.         }
  377.         catch (java.lang.Exception e)
  378.         {
  379.             e.printStackTrace();
  380.         }

  382.         return null;
  383.     }

  385.     /**
  386.      * Compute the Exponential Asymptotic Cumulative Series of Digamma Estimator
  387.      * 
  388.      * @return The Exponential Asymptotic Cumulative Series of Digamma Estimator
  389.      */

  391.     public static final CumulativeSeriesEstimator ExponentialAsymptote()
  392.     {
  393.         try
  394.         {
  395.             return new CumulativeSeriesEstimator (
  396.                 org.drip.specialfunction.digamma.CumulativeSeries.ExponentialAsymptote(),
  397.                 null
  398.             )
  399.             {
  400.                 @Override public double evaluate (
  401.                     final double z)
  402.                     throws java.lang.Exception
  403.                 {
  404.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z)
  405.                     {
  406.                         throw new java.lang.Exception
  407.                             ("CumulativeSeriesEstimator::ExponentialAsymptote::evaluate => Invalid Inputs");
  408.                     }

  410.                     return cumulativeSeries().evaluate (z);
  411.                 }
  412.             };
  413.         }
  414.         catch (java.lang.Exception e)
  415.         {
  416.             e.printStackTrace();
  417.         }

  419.         return null;
  420.     }

  422.     /**
  423.      * Compute the Exponential Asymptotic Cumulative Series of Digamma + 0.5 Estimator
  424.      * 
  425.      * @return The Exponential Asymptotic Cumulative Series of Digamma + 0.5 Estimator
  426.      */

  428.     public static final CumulativeSeriesEstimator ExponentialAsymptoteHalfShifted()
  429.     {
  430.         try
  431.         {
  432.             return new CumulativeSeriesEstimator (
  433.                 org.drip.specialfunction.digamma.CumulativeSeries.ExponentialAsymptoteHalfShifted(),
  434.                 null
  435.             )
  436.             {
  437.                 @Override public double evaluate (
  438.                     final double z)
  439.                     throws java.lang.Exception
  440.                 {
  441.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  442.                     {
  443.                         throw new java.lang.Exception
  444.                             ("CumulativeSeriesEstimator::ExponentialAsymptoteHalfShifted::evaluate => Invalid Inputs");
  445.                     }

  447.                     return z - 0.5 + cumulativeSeries().evaluate (z - 0.5);
  448.                 }
  449.             };
  450.         }
  451.         catch (java.lang.Exception e)
  452.         {
  453.             e.printStackTrace();
  454.         }

  456.         return null;
  457.     }

  459.     /**
  460.      * Compute the Taylor-Riemann Zeta Cumulative Series of Digamma Estimator
  461.      * 
  462.      * @param riemannZetaEstimator The Riemann-Zeta Estimator
  463.      * @param termCount Term Count
  464.      * 
  465.      * @return The Taylor-Riemann Zeta Cumulative Series of Digamma Estimator
  466.      */

  468.     public static final CumulativeSeriesEstimator TaylorRiemannZeta (
  469.         final org.drip.function.definition.R1ToR1 riemannZetaEstimator,
  470.         final int termCount)
  471.     {
  472.         try
  473.         {
  474.             return new CumulativeSeriesEstimator (
  475.                 org.drip.specialfunction.digamma.CumulativeSeries.TaylorRiemannZeta (
  476.                     riemannZetaEstimator,
  477.                     termCount
  478.                 ),
  479.                 null
  480.             )
  481.             {
  482.                 @Override public double evaluate (
  483.                     final double z)
  484.                     throws java.lang.Exception
  485.                 {
  486.                     if (!org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z)
  487.                     {
  488.                         throw new java.lang.Exception
  489.                             ("CumulativeSeriesEstimator::TaylorRiemannZeta::evaluate => Invalid Inputs");
  490.                     }

  492.                     return -1. * cumulativeSeries().evaluate (z - 1.) -
  493.                         org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI;
  494.                 }
  495.             };
  496.         }
  497.         catch (java.lang.Exception e)
  498.         {
  499.             e.printStackTrace();
  500.         }

  502.         return null;
  503.     }

  505.     protected CumulativeSeriesEstimator (
  506.         final org.drip.numerical.estimation.R1ToR1Series cumulativeSeries,
  507.         final org.drip.numerical.differentiation.DerivativeControl dc)
  508.         throws java.lang.Exception
  509.     {
  510.         super (dc);

  512.         _cumulativeSeries = cumulativeSeries;
  513.     }

  515.     /**
  516.      * Retrieve the Underlying Cumulative Series
  517.      * 
  518.      * @return The Underlying Cumulative Series
  519.      */

  521.     public org.drip.numerical.estimation.R1ToR1Series cumulativeSeries()
  522.     {
  523.         return _cumulativeSeries;
  524.     }
  525. }
Created with JaCoCo 0.7.9.201702052155