UpperSFixedSeriesTerm.java

  1. package org.drip.specialfunction.incompletegamma;

  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>UpperSFixedSeriesTerm</i> implements a Single Term in the Upper Incomplete Gamma Expansion Series for a
  79.  * Fixed s, starting from s = 0 if Recurrence is used. The References are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Geddes, K. O., M. L. Glasser, R. A. Moore, and T. C. Scott (1990): Evaluation of Classes of
  85.  *              Definite Integrals involving Elementary Functions via Differentiation of Special Functions
  86.  *              <i>Applicable Algebra in Engineering, Communications, and </i> <b>1 (2)</b> 149-165
  87.  *      </li>
  88.  *      <li>
  89.  *          Gradshteyn, I. S., I. M. Ryzhik, Y. V. Geronimus, M. Y. Tseytlin, and A. Jeffrey (2015):
  90.  *              <i>Tables of Integrals, Series, and Products</i> <b>Academic Press</b>
  91.  *      </li>
  92.  *      <li>
  93.  *          Mathar, R. J. (2010): Numerical Evaluation of the Oscillatory Integral over
  94.  *              e<sup>iÏ€x</sup> x<sup>(1/x)</sup> between 1 and ∞
  95.  *              https://arxiv.org/pdf/0912.3844.pdf <b>arXiV</b>
  96.  *      </li>
  97.  *      <li>
  98.  *          National Institute of Standards and Technology (2019): Incomplete Gamma and Related Functions
  99.  *              https://dlmf.nist.gov/8
  100.  *      </li>
  101.  *      <li>
  102.  *          Wikipedia (2019): Incomplete Gamma Function
  103.  *              https://en.wikipedia.org/wiki/Incomplete_gamma_function
  104.  *      </li>
  105.  *  </ul>
  106.  *
  107.  *  <br><br>
  108.  *  <ul>
  109.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  110.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FunctionAnalysisLibrary.md">Function Analysis Library</a></li>
  111.  *      <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>
  112.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/gammaincomplete/README.md">Upper/Lower Incomplete Gamma Functions</a></li>
  113.  *  </ul>
  114.  *
  115.  * @author Lakshmi Krishnamurthy
  116.  */

  118. public class UpperSFixedSeriesTerm
  119. {

  121.     /**
  122.      * Construct the NIST (2019) Limit Version of the Upper s = 0 Term
  123.      * 
  124.      * @return The NIST (2019) Limit Version of the Upper s = 0 Term 
  125.      */

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

  145.                     return 0. == z ? (0 == order ? 1. : 0.) : (order % 2 == 0 ? 1. : -1.) *
  146.                         java.lang.Math.exp (
  147.                             order * java.lang.Math.log (z) - java.lang.Math.log (order) -
  148.                             new org.drip.specialfunction.loggamma.NemesAnalyticEstimator (null).evaluate (order + 1)
  149.                         );
  150.                 }
  151.             };
  152.         }
  153.         catch (java.lang.Exception e)
  154.         {
  155.             e.printStackTrace();
  156.         }

  158.         return null;
  159.     }

  161.     /**
  162.      * Construct the NIST (2019) Limit Version of the Upper s = -n Term
  163.      * 
  164.      * @param n n
  165.      * 
  166.      * @return The NIST (2019) Limit Version of the Upper s = -n Term 
  167.      */

  169.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm NIST2019 (
  170.         final int n)
  171.     {
  172.         if (0 >= n)
  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 ||
  187.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z)
  188.                     {
  189.                         throw new java.lang.Exception
  190.                             ("UpperSFixedSeriesTerm::NIST2019::value => Invalid Inputs");
  191.                     }

  193.                     return 0. == z || n <= order + 1 ? 0. : (order % 2 == 0 ? 1. : -1.) *
  194.                         java.lang.Math.exp (
  195.                             order * java.lang.Math.log (z) +
  196.                             new org.drip.specialfunction.loggamma.NemesAnalyticEstimator (null).evaluate (n - order)
  197.                         );
  198.                 }
  199.             };
  200.         }
  201.         catch (java.lang.Exception e)
  202.         {
  203.             e.printStackTrace();
  204.         }

  206.         return null;
  207.     }

  209.     /**
  210.      * Construct the Weisstein Version of the Upper s .gt. 0 Term
  211.      * 
  212.      * @param s s
  213.      * 
  214.      * @return The Weisstein Version of the Upper s .gt. 0 Term 
  215.      */

  217.     public static final org.drip.numerical.estimation.R1ToR1SeriesTerm Weisstein (
  218.         final int s)
  219.     {
  220.         if (0 >= s)
  221.         {
  222.             return null;
  223.         }

  225.         try
  226.         {
  227.             return new org.drip.numerical.estimation.R1ToR1SeriesTerm()
  228.             {
  229.                 @Override public double value (
  230.                     final int order,
  231.                     final double z)
  232.                     throws java.lang.Exception
  233.                 {
  234.                     if (0 > order ||
  235.                         !org.drip.numerical.common.NumberUtil.IsValid (z) || 0. > z)
  236.                     {
  237.                         throw new java.lang.Exception
  238.                             ("UpperSFixedSeriesTerm::Weisstein::value => Invalid Inputs");
  239.                     }

  241.                     return 0. == z ? (0 == order ? 1. : 0.) : java.lang.Math.pow (
  242.                         z,
  243.                         order
  244.                     ) * java.lang.Math.exp (-z) /
  245.                         new org.drip.specialfunction.gamma.NemesAnalytic (null).evaluate (order + 1);
  246.                 }
  247.             };
  248.         }
  249.         catch (java.lang.Exception e)
  250.         {
  251.             e.printStackTrace();
  252.         }

  254.         return null;
  255.     }
  256. }
Created with JaCoCo 0.7.9.201702052155