GammaInequalityLemma.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>GammaInequalityLemma</i> contains the Verifiable Inequality Lemmas of the Gamma Function. The
  79.  * 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 GammaInequalityLemma
  116. {

  118.     /**
  119.      * Construct the Asymptotic Upper Approximate
  120.      * 
  121.      * @param alpha Alpha
  122.      * 
  123.      * @return The Asymptotic Upper Approximate
  124.      */

  126.     public static final org.drip.function.definition.R1ToR1Property AsymptoticUpperApproximate (
  127.         final double alpha)
  128.     {
  129.         if (!org.drip.numerical.common.NumberUtil.IsValid (alpha))
  130.         {
  131.             return null;
  132.         }

  134.         try
  135.         {
  136.             return new org.drip.function.definition.R1ToR1Property (
  137.                 org.drip.function.definition.R1ToR1Property.GTE,
  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.                                 ("GammaInequalityLemma::AsymptoticUpperApproximate::evaluate => Invalid Inputs");
  148.                         }

  150.                         return org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400).evaluate 
  151.                             (s + alpha);
  152.                     }
  153.                 },
  154.                 new org.drip.function.definition.R1ToR1 (null)
  155.                 {
  156.                     @Override public double evaluate (
  157.                         final double s)
  158.                         throws java.lang.Exception
  159.                     {
  160.                         if (!org.drip.numerical.common.NumberUtil.IsValid (s))
  161.                         {
  162.                             throw new java.lang.Exception
  163.                                 ("GammaInequalityLemma::AsymptoticUpperApproximate::evaluate => Invalid Inputs");
  164.                         }

  166.                         return alpha * java.lang.Math.log (s)  +
  167.                             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400).evaluate (s);
  168.                     }
  169.                 },
  170.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  171.             );
  172.         }
  173.         catch (java.lang.Exception e)
  174.         {
  175.             e.printStackTrace();
  176.         }

  178.         return null;
  179.     }

  181.     /**
  182.      * Generate the Exponentially Convex Inequality Verifier
  183.      * 
  184.      * @param z1 z1
  185.      * @param z2 z2
  186.      * 
  187.      * @return The Exponentially Convex Inequality Verifier
  188.      */

  190.     public static final org.drip.function.definition.R1ToR1Property ExponentiallyConvex (
  191.         final double z1,
  192.         final double z2)
  193.     {
  194.         if (!org.drip.numerical.common.NumberUtil.IsValid (z1) ||
  195.             !org.drip.numerical.common.NumberUtil.IsValid (z2))
  196.         {
  197.             return null;
  198.         }

  200.         try
  201.         {
  202.             return new org.drip.function.definition.R1ToR1Property (
  203.                 org.drip.function.definition.R1ToR1Property.LTE,
  204.                 new org.drip.function.definition.R1ToR1 (null)
  205.                 {
  206.                     @Override public double evaluate (
  207.                         final double t)
  208.                         throws java.lang.Exception
  209.                     {
  210.                         if (!org.drip.numerical.common.NumberUtil.IsValid (t) || 0. > t || 1. < t)
  211.                         {
  212.                             throw new java.lang.Exception
  213.                                 ("GammaInequalityLemma::ExponentiallyConvex::evaluate => Invalid Inputs");
  214.                         }

  216.                         return org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400).evaluate
  217.                             (t * z1 + (1. - t) * z2);
  218.                     }
  219.                 },
  220.                 new org.drip.function.definition.R1ToR1 (null)
  221.                 {
  222.                     @Override public double evaluate (
  223.                         final double t)
  224.                         throws java.lang.Exception
  225.                     {
  226.                         if (!org.drip.numerical.common.NumberUtil.IsValid (t) || 0. > t || 1. < t)
  227.                         {
  228.                             throw new java.lang.Exception
  229.                                 ("GammaInequalityLemma::ExponentiallyConvex::evaluate => Invalid Inputs");
  230.                         }

  232.                         org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  233.                             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  235.                         return t * weierStrass.evaluate (z1) + (1. - t) * weierStrass.evaluate (z2);
  236.                     }
  237.                 },
  238.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  239.             );
  240.         }
  241.         catch (java.lang.Exception e)
  242.         {
  243.             e.printStackTrace();
  244.         }

  246.         return null;
  247.     }

  249.     /**
  250.      * Generate the Spaced Point Convex Inequality Verifier
  251.      * 
  252.      * @param y y
  253.      * 
  254.      * @return The Spaced Point Convex Inequality Verifier
  255.      */

  257.     public static final org.drip.function.definition.R1ToR1Property SpacedPointConvex (
  258.         final double y)
  259.     {
  260.         if (!org.drip.numerical.common.NumberUtil.IsValid (y))
  261.         {
  262.             return null;
  263.         }

  265.         final org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  266.             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  268.         try
  269.         {
  270.             final double logGammaY = weierStrass.evaluate (y);

  272.             return new org.drip.function.definition.R1ToR1Property (
  273.                 org.drip.function.definition.R1ToR1Property.GT,
  274.                 new org.drip.function.definition.R1ToR1 (null)
  275.                 {
  276.                     @Override public double evaluate (
  277.                         final double x)
  278.                         throws java.lang.Exception
  279.                     {
  280.                         if (!org.drip.numerical.common.NumberUtil.IsValid (x) || x >= y)
  281.                         {
  282.                             throw new java.lang.Exception
  283.                                 ("GammaInequalityLemma::SpacedPointConvex::evaluate => Invalid Inputs");
  284.                         }

  286.                         return (logGammaY - weierStrass.evaluate (x)) / (y - x);
  287.                     }
  288.                 },
  289.                 new org.drip.function.definition.R1ToR1 (null)
  290.                 {
  291.                     @Override public double evaluate (
  292.                         final double x)
  293.                         throws java.lang.Exception
  294.                     {
  295.                         if (!org.drip.numerical.common.NumberUtil.IsValid (x))
  296.                         {
  297.                             throw new java.lang.Exception
  298.                                 ("GammaInequalityLemma::SpacedPointConvex::evaluate => Invalid Inputs");
  299.                         }

  301.                         org.drip.specialfunction.gamma.EulerIntegralSecondKind eulerIntegralSecondKind =
  302.                             new org.drip.specialfunction.gamma.EulerIntegralSecondKind (null);

  304.                         return eulerIntegralSecondKind.derivative (
  305.                             x,
  306.                             1
  307.                         ) - weierStrass.evaluate (x);
  308.                     }
  309.                 },
  310.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  311.             );
  312.         }
  313.         catch (java.lang.Exception e)
  314.         {
  315.             e.printStackTrace();
  316.         }

  318.         return null;
  319.     }

  321.     /**
  322.      * Generate the Logarithmically Convex Inequality Verifier
  323.      * 
  324.      * @return The Logarithmically Convex Inequality Verifier
  325.      */

  327.     public static final org.drip.function.definition.R1ToR1Property LogarithmicConvex()
  328.     {
  329.         final org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  330.             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  332.         try
  333.         {
  334.             return new org.drip.function.definition.R1ToR1Property (
  335.                 org.drip.function.definition.R1ToR1Property.GT,
  336.                 new org.drip.function.definition.R1ToR1 (null)
  337.                 {
  338.                     @Override public double evaluate (
  339.                         final double z)
  340.                         throws java.lang.Exception
  341.                     {
  342.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  343.                         {
  344.                             throw new java.lang.Exception
  345.                                 ("GammaInequalityLemma::LogarithmicConvex::evaluate => Invalid Inputs");
  346.                         }

  348.                         return java.lang.Math.log (
  349.                             new org.drip.specialfunction.gamma.EulerIntegralSecondKind (null).derivative (
  350.                                 z,
  351.                                 2
  352.                             )
  353.                         ) + weierStrass.evaluate (z);
  354.                     }
  355.                 },
  356.                 new org.drip.function.definition.R1ToR1 (null)
  357.                 {
  358.                     @Override public double evaluate (
  359.                         final double z)
  360.                         throws java.lang.Exception
  361.                     {
  362.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  363.                         {
  364.                             throw new java.lang.Exception
  365.                                 ("GammaInequalityLemma::LogarithmicConvex::evaluate => Invalid Inputs");
  366.                         }

  368.                         return java.lang.Math.log (
  369.                             new org.drip.specialfunction.gamma.EulerIntegralSecondKind (null).derivative (
  370.                                 z,
  371.                                 1
  372.                             )
  373.                         );
  374.                     }
  375.                 },
  376.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  377.             );
  378.         }
  379.         catch (java.lang.Exception e)
  380.         {
  381.             e.printStackTrace();
  382.         }

  384.         return null;
  385.     }

  387.     /**
  388.      * Generate the Gautschi Left Inequality Verifier
  389.      * 
  390.      * @param s s
  391.      * 
  392.      * @return The Gautschi Left Inequality Verifier
  393.      */

  395.     public static final org.drip.function.definition.R1ToR1Property GautschiLeft (
  396.         final double s)
  397.     {
  398.         if (!org.drip.numerical.common.NumberUtil.IsValid (s) || 0. >= s || 1. <= s)
  399.         {
  400.             return null;
  401.         }

  403.         final org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  404.             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  406.         try
  407.         {
  408.             return new org.drip.function.definition.R1ToR1Property (
  409.                 org.drip.function.definition.R1ToR1Property.LT,
  410.                 new org.drip.function.definition.R1ToR1 (null)
  411.                 {
  412.                     @Override public double evaluate (
  413.                         final double z)
  414.                         throws java.lang.Exception
  415.                     {
  416.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  417.                         {
  418.                             throw new java.lang.Exception
  419.                                 ("GammaInequalityLemma::GautschiLeft::evaluate => Invalid Inputs");
  420.                         }

  422.                         return (1. - s) * java.lang.Math.log (z);
  423.                     }
  424.                 },
  425.                 new org.drip.function.definition.R1ToR1 (null)
  426.                 {
  427.                     @Override public double evaluate (
  428.                         final double z)
  429.                         throws java.lang.Exception
  430.                     {
  431.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  432.                         {
  433.                             throw new java.lang.Exception
  434.                                 ("GammaInequalityLemma::GautschiLeft::evaluate => Invalid Inputs");
  435.                         }

  437.                         return weierStrass.evaluate (z + 1) - weierStrass.evaluate (z + s);
  438.                     }
  439.                 },
  440.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  441.             );
  442.         }
  443.         catch (java.lang.Exception e)
  444.         {
  445.             e.printStackTrace();
  446.         }

  448.         return null;
  449.     }

  451.     /**
  452.      * Generate the Gautschi Right Inequality Verifier
  453.      * 
  454.      * @param s s
  455.      * 
  456.      * @return The Gautschi Right Inequality Verifier
  457.      */

  459.     public static final org.drip.function.definition.R1ToR1Property GautschiRight (
  460.         final double s)
  461.     {
  462.         if (!org.drip.numerical.common.NumberUtil.IsValid (s) || 0. >= s || 1. <= s)
  463.         {
  464.             return null;
  465.         }

  467.         final org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  468.             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  470.         try
  471.         {
  472.             return new org.drip.function.definition.R1ToR1Property (
  473.                 org.drip.function.definition.R1ToR1Property.LT,
  474.                 new org.drip.function.definition.R1ToR1 (null)
  475.                 {
  476.                     @Override public double evaluate (
  477.                         final double z)
  478.                         throws java.lang.Exception
  479.                     {
  480.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  481.                         {
  482.                             throw new java.lang.Exception
  483.                                 ("GammaInequalityLemma::GautschiRight::evaluate => Invalid Inputs");
  484.                         }

  486.                         return weierStrass.evaluate (z + 1) - weierStrass.evaluate (z + s);
  487.                     }
  488.                 },
  489.                 new org.drip.function.definition.R1ToR1 (null)
  490.                 {
  491.                     @Override public double evaluate (
  492.                         final double z)
  493.                         throws java.lang.Exception
  494.                     {
  495.                         if (!org.drip.numerical.common.NumberUtil.IsValid (z))
  496.                         {
  497.                             throw new java.lang.Exception
  498.                                 ("GammaInequalityLemma::GautschiRight::evaluate => Invalid Inputs");
  499.                         }

  501.                         return (1. - s) * java.lang.Math.log (z + 1.);
  502.                     }
  503.                 },
  504.                 org.drip.function.definition.R1ToR1Property.MISMATCH_TOLERANCE
  505.             );
  506.         }
  507.         catch (java.lang.Exception e)
  508.         {
  509.             e.printStackTrace();
  510.         }

  512.         return null;
  513.     }

  515.     /**
  516.      * Generate the Jensen Multi-Point Interpolant Convexity Verification
  517.      * 
  518.      * @param multiPoint2D Multi-Point 2D
  519.      * 
  520.      * @return Jensen Multi-Point Interpolant Convexity Verification
  521.      */

  523.     public static final org.drip.function.definition.R1PropertyVerification JensenMultiPointInterpolant (
  524.         final org.drip.numerical.common.Array2D multiPoint2D)
  525.     {
  526.         if (null == multiPoint2D)
  527.         {
  528.             return null;
  529.         }

  531.         final org.drip.specialfunction.loggamma.InfiniteSumEstimator weierStrass =
  532.             org.drip.specialfunction.loggamma.InfiniteSumEstimator.Weierstrass (1638400);

  534.         double[] xArray = multiPoint2D.x();

  536.         double[] aArray = multiPoint2D.y();

  538.         double interpolantDenominator = 0.;
  539.         double interpolantNumerator = 0.;
  540.         int count = aArray.length;
  541.         double rValue = 0.;

  543.         for (int index = 0; index < count; ++index)
  544.         {
  545.             interpolantNumerator = interpolantNumerator + aArray[index] * xArray[index];
  546.             interpolantDenominator = interpolantDenominator + aArray[index];
  547.         }

  549.         double interpolantDenominatorInverse = 1. / interpolantDenominator;

  551.         try
  552.         {
  553.             double lValue = weierStrass.evaluate (interpolantNumerator* interpolantDenominatorInverse);

  555.             for (int index = 0; index < count; ++index)
  556.             {
  557.                 rValue = rValue + aArray[index] * weierStrass.evaluate (xArray[index]);
  558.             }

  560.             return new org.drip.function.definition.R1PropertyVerification (
  561.                 lValue,
  562.                 rValue = rValue * interpolantDenominatorInverse,
  563.                 lValue <= rValue
  564.             );
  565.         }
  566.         catch (java.lang.Exception e)
  567.         {
  568.             e.printStackTrace();
  569.         }

  571.         return null;
  572.     }
  573. }
Created with JaCoCo 0.7.9.201702052155