CumulativeSeriesTerm.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>CumulativeSeriesTerm</i> implements a Single Term in the Cumulative Series for Digamma Estimation. The
  79.  * 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 CumulativeSeriesTerm
  116. {

  118.     /**
  119.      * Construct the Abramowitz-Stegun (2007) Cumulative Sum Series Term for DiGamma
  120.      * 
  121.      * @return The Abramowitz-Stegun (2007) Cumulative Sum Series Term for DiGamma
  122.      */

  124.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm AbramowitzStegun2007()
  125.     {
  126.         try
  127.         {
  128.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  129.             {
  130.                 @Override public double value (
  131.                     final int order,
  132.                     final double z)
  133.                     throws java.lang.Exception
  134.                 {
  135.                     if (0 >= order ||
  136.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || order == -z)
  137.                     {
  138.                         throw new java.lang.Exception
  139.                             ("CumulativeSeriesTerm::AbramowitzStegun2007::value => Invalid Inputs");
  140.                     }

  142.                     return z / (order * (order + z));
  143.                 }
  144.             };
  145.         }
  146.         catch (java.lang.Exception e)
  147.         {
  148.             e.printStackTrace();
  149.         }

  151.         return null;
  152.     }

  154.     /**
  155.      * Construct the Mezo-Hoffman (2017) Cumulative Sum Series Term for DiGamma
  156.      * 
  157.      * @param saddlePointArray Array of the Saddle Points
  158.      * 
  159.      * @return The Mezo-Hoffman (2017) Cumulative Sum Series Term for DiGamma
  160.      */

  162.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm MezoHoffman2017 (
  163.         final double[] saddlePointArray)
  164.     {
  165.         if (null == saddlePointArray)
  166.         {
  167.             return null;
  168.         }

  170.         final int saddlePointCount = saddlePointArray.length;

  172.         if (0 == saddlePointCount || !org.drip.numerical.common.NumberUtil.IsValid (saddlePointArray))
  173.         {
  174.             return null;
  175.         }

  177.         try
  178.         {
  179.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  180.             {
  181.                 @Override public double value (
  182.                     final int order,
  183.                     final double z)
  184.                     throws java.lang.Exception
  185.                 {
  186.                     if (0 > order || order >= saddlePointCount ||
  187.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || 0. >= z)
  188.                     {
  189.                         throw new java.lang.Exception
  190.                             ("CumulativeSeriesTerm::MezoHoffman2017::value => Invalid Inputs");
  191.                     }

  193.                     double zOverSaddlePoint = z / saddlePointArray[order];

  195.                     return zOverSaddlePoint * java.lang.Math.log (1. - zOverSaddlePoint);
  196.                 }
  197.             };
  198.         }
  199.         catch (java.lang.Exception e)
  200.         {
  201.             e.printStackTrace();
  202.         }

  204.         return null;
  205.     }

  207.     /**
  208.      * Construct the Gauss Cumulative Sum Series Term for DiGamma
  209.      * 
  210.      * @param termCount Term Count
  211.      * 
  212.      * @return The Gauss Cumulative Sum Series Term for DiGamma
  213.      */

  215.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm Gauss (
  216.         final int termCount)
  217.     {
  218.         try
  219.         {
  220.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  221.             {
  222.                 @Override public double value (
  223.                     final int order,
  224.                     final double z)
  225.                     throws java.lang.Exception
  226.                 {
  227.                     if (1 > order ||
  228.                         !org.drip.numerical.common.NumberUtil.IsValid (z))
  229.                     {
  230.                         throw new java.lang.Exception
  231.                             ("CumulativeSeriesTerm::Gauss::value => Invalid Inputs");
  232.                     }

  234.                     return java.lang.Math.cos (2. * java.lang.Math.PI * order * z) *
  235.                         java.lang.Math.log (java.lang.Math.sin (java.lang.Math.PI * order / termCount));
  236.                 }
  237.             };
  238.         }
  239.         catch (java.lang.Exception e)
  240.         {
  241.             e.printStackTrace();
  242.         }

  244.         return null;
  245.     }

  247.     /**
  248.      * Construct the Asymptotic Cumulative Sum Series Term for DiGamma
  249.      * 
  250.      * @return The Asymptotic Cumulative Sum Series Term for DiGamma
  251.      */

  253.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm Asymptotic()
  254.     {
  255.         try
  256.         {
  257.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  258.             {
  259.                 @Override public double value (
  260.                     final int order,
  261.                     final double z)
  262.                     throws java.lang.Exception
  263.                 {
  264.                     if (0 >= order ||
  265.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || 0 == z)
  266.                     {
  267.                         throw new java.lang.Exception
  268.                             ("CumulativeSeriesTerm::Asymptotic::value => Invalid Inputs");
  269.                     }

  271.                     return java.lang.Math.pow (
  272.                         z,
  273.                         -2 * order
  274.                     );
  275.                 }
  276.             };
  277.         }
  278.         catch (java.lang.Exception e)
  279.         {
  280.             e.printStackTrace();
  281.         }

  283.         return null;
  284.     }

  286.     /**
  287.      * Construct the Asymptotic Cumulative Sum Series Term for exp (-diGamma)
  288.      * 
  289.      * @return The Asymptotic Cumulative Sum Series Term for exp (-diGamma)
  290.      */

  292.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm ExponentialAsymptote()
  293.     {
  294.         try
  295.         {
  296.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  297.             {
  298.                 @Override public double value (
  299.                     final int order,
  300.                     final double z)
  301.                     throws java.lang.Exception
  302.                 {
  303.                     if (0 >= order ||
  304.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || 0 == z)
  305.                     {
  306.                         throw new java.lang.Exception
  307.                             ("CumulativeSeriesTerm::ExponentialAsymptote::value => Invalid Inputs");
  308.                     }

  310.                     return java.lang.Math.pow (
  311.                         z,
  312.                         -1 * order
  313.                     );
  314.                 }
  315.             };
  316.         }
  317.         catch (java.lang.Exception e)
  318.         {
  319.             e.printStackTrace();
  320.         }

  322.         return null;
  323.     }

  325.     /**
  326.      * Construct the Asymptotic Cumulative Sum Series Term for exp (diGamma + 0.5)
  327.      * 
  328.      * @return The Asymptotic Cumulative Sum Series Term for exp (-diGamma + 0.5)
  329.      */

  331.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm ExponentialAsymptoteHalfShifted()
  332.     {
  333.         try
  334.         {
  335.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  336.             {
  337.                 @Override public double value (
  338.                     final int order,
  339.                     final double z)
  340.                     throws java.lang.Exception
  341.                 {
  342.                     if (0 >= order ||
  343.                         !org.drip.numerical.common.NumberUtil.IsValid (z))
  344.                     {
  345.                         throw new java.lang.Exception
  346.                             ("CumulativeSeriesTerm::ExponentialAsymptoteHalfShifted::value => Invalid Inputs");
  347.                     }

  349.                     return java.lang.Math.pow (
  350.                         z,
  351.                         1 - 2 * order
  352.                     );
  353.                 }
  354.             };
  355.         }
  356.         catch (java.lang.Exception e)
  357.         {
  358.             e.printStackTrace();
  359.         }

  361.         return null;
  362.     }

  364.     /**
  365.      * Construct the Taylor-Riemann Zeta Series Term for Digamma
  366.      * 
  367.      * @param riemannZetaEstimator The Riemann-Zeta Estimator
  368.      * 
  369.      * @return The Taylor-Riemann Zeta Series Term for Digamma
  370.      */

  372.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm TaylorRiemannZeta (
  373.         final org.drip.function.definition.R1ToR1 riemannZetaEstimator)
  374.     {
  375.         if (null == riemannZetaEstimator)
  376.         {
  377.             return null;
  378.         }

  380.         try
  381.         {
  382.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  383.             {
  384.                 @Override public double value (
  385.                     final int order,
  386.                     final double z)
  387.                     throws java.lang.Exception
  388.                 {
  389.                     if (0 >= order ||
  390.                         !org.drip.numerical.common.NumberUtil.IsValid (z))
  391.                     {
  392.                         throw new java.lang.Exception
  393.                             ("CumulativeSeriesTerm::TaylorRiemannZeta::value => Invalid Inputs");
  394.                     }

  396.                     return (1 == order % 2 ? -1. : 1.) *
  397.                         riemannZetaEstimator.evaluate (order + 1) * java.lang.Math.pow (
  398.                             z,
  399.                             order
  400.                         );
  401.                 }
  402.             };
  403.         }
  404.         catch (java.lang.Exception e)
  405.         {
  406.             e.printStackTrace();
  407.         }

  409.         return null;
  410.     }

  412.     /**
  413.      * Construct the Newton-Stern Series Term for Digamma
  414.      * 
  415.      * @return The Newton-Stern Series Term for Digamma
  416.      */

  418.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm NewtonStern()
  419.     {
  420.         try
  421.         {
  422.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  423.             {
  424.                 @Override public double value (
  425.                     final int order,
  426.                     final double z)
  427.                     throws java.lang.Exception
  428.                 {
  429.                     if (0 >= order ||
  430.                         !org.drip.numerical.common.NumberUtil.IsValid (z))
  431.                     {
  432.                         throw new java.lang.Exception
  433.                             ("CumulativeSeriesTerm::TaylorRiemannZeta::value => Invalid Inputs");
  434.                     }

  436.                     return (1 == order % 2 ? -1. : 1.) * org.drip.numerical.common.NumberUtil.NCK (
  437.                         (int) z,
  438.                         order
  439.                     ) / order;
  440.                 }
  441.             };
  442.         }
  443.         catch (java.lang.Exception e)
  444.         {
  445.             e.printStackTrace();
  446.         }

  448.         return null;
  449.     }
  450. }
Created with JaCoCo 0.7.9.201702052155