DigammaSaddlePointEqualityLemma.java

  1. package org.drip.specialfunction.property;

  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>DigammaSaddlePointEqualityLemma</i> contains the Verifiable Equality Lemmas for the Digamma Saddle
  79.  * Points. The References 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/property/README.md">Special Function Property Lemma Verifiers</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  115. public class DigammaSaddlePointEqualityLemma
  116. {

  118.     /**
  119.      * Construct the Quadratic Reciprocal Sum Verifier
  120.      * 
  121.      * @param digammaSaddlePointsFunction Digamma Saddle Points Function
  122.      * 
  123.      * @return The Quadratic Reciprocal Sum Verifier
  124.      */

  126.     public static final org.drip.function.definition.R1ToR1Property QuadraticReciprocalSum (
  127.         final org.drip.function.definition.R1ToR1 digammaSaddlePointsFunction)
  128.     {
  129.         if (null == digammaSaddlePointsFunction)
  130.         {
  131.             return null;
  132.         }

  134.         try
  135.         {
  136.             return new org.drip.function.definition.R1ToR1Property (
  137.                 org.drip.function.definition.R1ToR1Property.EQ,
  138.                 new org.drip.function.definition.R1ToR1 (null)
  139.                 {
  140.                     @Override public double evaluate (
  141.                         final double s)
  142.                         throws java.lang.Exception
  143.                     {
  144.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  145.                         {
  146.                             throw new java.lang.Exception
  147.                                 ("DigammaSaddlePointEqualityLemma::QuadraticReciprocalSum::evaluate => Invalid Inputs");
  148.                         }

  150.                         double quadraticReciprocalSum = 1. / (
  151.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  152.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION
  153.                         );

  155.                         for (int saddlePointIndex = 1; saddlePointIndex <= s; ++saddlePointIndex)
  156.                         {
  157.                             double saddlePoint = digammaSaddlePointsFunction.evaluate (saddlePointIndex);

  159.                             quadraticReciprocalSum = quadraticReciprocalSum + 1. / (
  160.                                 saddlePoint * saddlePoint
  161.                             );
  162.                         }

  164.                         return quadraticReciprocalSum;
  165.                     }
  166.                 },
  167.                 new org.drip.function.definition.R1ToR1 (null)
  168.                 {
  169.                     @Override public double evaluate (
  170.                         final double s)
  171.                         throws java.lang.Exception
  172.                     {
  173.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  174.                         {
  175.                             throw new java.lang.Exception
  176.                                 ("DigammaSaddlePointEqualityLemma::QuadraticReciprocalSum::evaluate => Invalid Inputs");
  177.                         }

  179.                         return org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  180.                             org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI +
  181.                             0.5 * java.lang.Math.PI * java.lang.Math.PI;
  182.                     }
  183.                 },
  184.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  185.             );
  186.         }
  187.         catch (java.lang.Exception e)
  188.         {
  189.             e.printStackTrace();
  190.         }

  192.         return null;
  193.     }

  195.     /**
  196.      * Construct the Cubic Reciprocal Sum Verifier
  197.      * 
  198.      * @param digammaSaddlePointsFunction Digamma Saddle Points Function
  199.      * 
  200.      * @return The Cubic Reciprocal Sum Verifier
  201.      */

  203.     public static final org.drip.function.definition.R1ToR1Property CubicReciprocalSum (
  204.         final org.drip.function.definition.R1ToR1 digammaSaddlePointsFunction)
  205.     {
  206.         if (null == digammaSaddlePointsFunction)
  207.         {
  208.             return null;
  209.         }

  211.         try
  212.         {
  213.             return new org.drip.function.definition.R1ToR1Property (
  214.                 org.drip.function.definition.R1ToR1Property.EQ,
  215.                 new org.drip.function.definition.R1ToR1 (null)
  216.                 {
  217.                     @Override public double evaluate (
  218.                         final double s)
  219.                         throws java.lang.Exception
  220.                     {
  221.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  222.                         {
  223.                             throw new java.lang.Exception
  224.                                 ("DigammaSaddlePointEqualityLemma::CubicReciprocalSum::evaluate => Invalid Inputs");
  225.                         }

  227.                         double cubicReciprocalSum = 1. / (
  228.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  229.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  230.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION
  231.                         );

  233.                         for (int saddlePointIndex = 1; saddlePointIndex <= s; ++saddlePointIndex)
  234.                         {
  235.                             double saddlePoint = digammaSaddlePointsFunction.evaluate (saddlePointIndex);

  237.                             cubicReciprocalSum = cubicReciprocalSum + 1. / (
  238.                                 saddlePoint * saddlePoint * saddlePoint
  239.                             );
  240.                         }

  242.                         return cubicReciprocalSum;
  243.                     }
  244.                 },
  245.                 new org.drip.function.definition.R1ToR1 (null)
  246.                 {
  247.                     @Override public double evaluate (
  248.                         final double s)
  249.                         throws java.lang.Exception
  250.                     {
  251.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  252.                         {
  253.                             throw new java.lang.Exception
  254.                                 ("DigammaSaddlePointEqualityLemma::CubicReciprocalSum::evaluate => Invalid Inputs");
  255.                         }

  257.                         return -4. * new org.drip.specialfunction.derived.RiemannZeta (
  258.                             null,
  259.                             new org.drip.specialfunction.gamma.WindschitlTothAnalytic (null)
  260.                         ).evaluate (3.) -
  261.                             org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  262.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  263.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI -
  264.                             0.5 * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  265.                                 java.lang.Math.PI * java.lang.Math.PI;
  266.                     }
  267.                 },
  268.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  269.             );
  270.         }
  271.         catch (java.lang.Exception e)
  272.         {
  273.             e.printStackTrace();
  274.         }

  276.         return null;
  277.     }

  279.     /**
  280.      * Construct the Quartic Reciprocal Sum Verifier
  281.      * 
  282.      * @param digammaSaddlePointsFunction Digamma Saddle Points Function
  283.      * 
  284.      * @return The Quartic Reciprocal Sum Verifier
  285.      */

  287.     public static final org.drip.function.definition.R1ToR1Property QuarticReciprocalSum (
  288.         final org.drip.function.definition.R1ToR1 digammaSaddlePointsFunction)
  289.     {
  290.         if (null == digammaSaddlePointsFunction)
  291.         {
  292.             return null;
  293.         }

  295.         try
  296.         {
  297.             return new org.drip.function.definition.R1ToR1Property (
  298.                 org.drip.function.definition.R1ToR1Property.EQ,
  299.                 new org.drip.function.definition.R1ToR1 (null)
  300.                 {
  301.                     @Override public double evaluate (
  302.                         final double s)
  303.                         throws java.lang.Exception
  304.                     {
  305.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  306.                         {
  307.                             throw new java.lang.Exception
  308.                                 ("DigammaSaddlePointEqualityLemma::QuarticReciprocalSum::evaluate => Invalid Inputs");
  309.                         }

  311.                         double quarticReciprocalSum = 1. / (
  312.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  313.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  314.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  315.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION
  316.                         );

  318.                         for (int saddlePointIndex = 1; saddlePointIndex <= s; ++saddlePointIndex)
  319.                         {
  320.                             double saddlePoint = digammaSaddlePointsFunction.evaluate (saddlePointIndex);

  322.                             quarticReciprocalSum = quarticReciprocalSum + 1. / (
  323.                                 saddlePoint * saddlePoint * saddlePoint * saddlePoint
  324.                             );
  325.                         }

  327.                         return quarticReciprocalSum;
  328.                     }
  329.                 },
  330.                 new org.drip.function.definition.R1ToR1 (null)
  331.                 {
  332.                     @Override public double evaluate (
  333.                         final double s)
  334.                         throws java.lang.Exception
  335.                     {
  336.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  337.                         {
  338.                             throw new java.lang.Exception
  339.                                 ("DigammaSaddlePointEqualityLemma::QuarticReciprocalSum::evaluate => Invalid Inputs");
  340.                         }

  342.                         return
  343.                             org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  344.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  345.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  346.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI +
  347.                             java.lang.Math.PI * java.lang.Math.PI * java.lang.Math.PI * java.lang.Math.PI /
  348.                                 9. +
  349.                             2. * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  350.                                 org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  351.                                 java.lang.Math.PI * java.lang.Math.PI / 3. +
  352.                             4. * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI *
  353.                                 new org.drip.specialfunction.derived.RiemannZeta (
  354.                                     null,
  355.                                     new org.drip.specialfunction.gamma.WindschitlTothAnalytic (null)
  356.                                 ).evaluate (3.);
  357.                     }
  358.                 },
  359.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  360.             );
  361.         }
  362.         catch (java.lang.Exception e)
  363.         {
  364.             e.printStackTrace();
  365.         }

  367.         return null;
  368.     }

  370.     /**
  371.      * Construct the First Quadratic Polynomial Reciprocal Sum Verifier
  372.      * 
  373.      * @param digammaSaddlePointsFunction Digamma Saddle Points Function
  374.      * 
  375.      * @return The First Quadratic Polynomial Reciprocal Sum Verifier
  376.      */

  378.     public static final org.drip.function.definition.R1ToR1Property QuadraticPolynomialReciprocalSum1 (
  379.         final org.drip.function.definition.R1ToR1 digammaSaddlePointsFunction)
  380.     {
  381.         if (null == digammaSaddlePointsFunction)
  382.         {
  383.             return null;
  384.         }

  386.         try
  387.         {
  388.             return new org.drip.function.definition.R1ToR1Property (
  389.                 org.drip.function.definition.R1ToR1Property.EQ,
  390.                 new org.drip.function.definition.R1ToR1 (null)
  391.                 {
  392.                     @Override public double evaluate (
  393.                         final double s)
  394.                         throws java.lang.Exception
  395.                     {
  396.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  397.                         {
  398.                             throw new java.lang.Exception
  399.                                 ("DigammaSaddlePointEqualityLemma::QuadraticPolynomialReciprocalSum1::evaluate => Invalid Inputs");
  400.                         }

  402.                         double quadraticReciprocalSum = 1. / (
  403.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  404.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION +
  405.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION
  406.                         );

  408.                         for (int saddlePointIndex = 1; saddlePointIndex <= s; ++saddlePointIndex)
  409.                         {
  410.                             double saddlePoint = digammaSaddlePointsFunction.evaluate (saddlePointIndex);

  412.                             quadraticReciprocalSum = quadraticReciprocalSum + 1. / (
  413.                                 saddlePoint * saddlePoint + saddlePoint
  414.                             );
  415.                         }

  417.                         return quadraticReciprocalSum;
  418.                     }
  419.                 },
  420.                 new org.drip.function.definition.R1ToR1 (null)
  421.                 {
  422.                     @Override public double evaluate (
  423.                         final double s)
  424.                         throws java.lang.Exception
  425.                     {
  426.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  427.                         {
  428.                             throw new java.lang.Exception
  429.                                 ("DigammaSaddlePointEqualityLemma::QuadraticPolynomialReciprocalSum1::evaluate => Invalid Inputs");
  430.                         }

  432.                         return -2.;
  433.                     }
  434.                 },
  435.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  436.             );
  437.         }
  438.         catch (java.lang.Exception e)
  439.         {
  440.             e.printStackTrace();
  441.         }

  443.         return null;
  444.     }

  446.     /**
  447.      * Construct the Second Quadratic Polynomial Reciprocal Sum Verifier
  448.      * 
  449.      * @param digammaSaddlePointsFunction Digamma Saddle Points Function
  450.      * 
  451.      * @return The Second Quadratic Polynomial Reciprocal Sum Verifier
  452.      */

  454.     public static final org.drip.function.definition.R1ToR1Property QuadraticPolynomialReciprocalSum2 (
  455.         final org.drip.function.definition.R1ToR1 digammaSaddlePointsFunction)
  456.     {
  457.         if (null == digammaSaddlePointsFunction)
  458.         {
  459.             return null;
  460.         }

  462.         try
  463.         {
  464.             return new org.drip.function.definition.R1ToR1Property (
  465.                 org.drip.function.definition.R1ToR1Property.EQ,
  466.                 new org.drip.function.definition.R1ToR1 (null)
  467.                 {
  468.                     @Override public double evaluate (
  469.                         final double s)
  470.                         throws java.lang.Exception
  471.                     {
  472.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  473.                         {
  474.                             throw new java.lang.Exception
  475.                                 ("DigammaSaddlePointEqualityLemma::QuadraticPolynomialReciprocalSum2::evaluate => Invalid Inputs");
  476.                         }

  478.                         double quadraticReciprocalSum = 1. / (
  479.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION *
  480.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION -
  481.                             org.drip.specialfunction.gamma.Definitions.MINIMUM_VARIATE_LOCATION
  482.                         );

  484.                         for (int saddlePointIndex = 1; saddlePointIndex <= s; ++saddlePointIndex)
  485.                         {
  486.                             double saddlePoint = digammaSaddlePointsFunction.evaluate (saddlePointIndex);

  488.                             quadraticReciprocalSum = quadraticReciprocalSum + 1. / (
  489.                                 saddlePoint * saddlePoint - saddlePoint
  490.                             );
  491.                         }

  493.                         return quadraticReciprocalSum;
  494.                     }
  495.                 },
  496.                 new org.drip.function.definition.R1ToR1 (null)
  497.                 {
  498.                     @Override public double evaluate (
  499.                         final double s)
  500.                         throws java.lang.Exception
  501.                     {
  502.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  503.                         {
  504.                             throw new java.lang.Exception
  505.                                 ("DigammaSaddlePointEqualityLemma::QuadraticPolynomialReciprocalSum2::evaluate => Invalid Inputs");
  506.                         }

  508.                         return org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI + 
  509.                             (java.lang.Math.PI * java.lang.Math.PI /
  510.                                 (6. * org.drip.specialfunction.gamma.Definitions.EULER_MASCHERONI));
  511.                     }
  512.                 },
  513.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  514.             );
  515.         }
  516.         catch (java.lang.Exception e)
  517.         {
  518.             e.printStackTrace();
  519.         }

  521.         return null;
  522.     }
  523. }
Created with JaCoCo 0.7.9.201702052155