UpperSFixedSeries.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>UpperSFixedSeries</i> implements Upper Incomplete Gamma Expansion Series, starting with s = 0 if
  79.  * Recurrence is employed. 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 UpperSFixedSeries
  119. {

  121.     /**
  122.      * Construct the R<sup>1</sup> To R<sup>1</sup> NIST (2019) Limit Series
  123.      * 
  124.      * @param termCount Count of the Number of Terms
  125.      * 
  126.      * @return The R<sup>1</sup> To R<sup>1</sup> NIST (2019) Limit Series
  127.      */

  129.     public static final org.drip.numerical.estimation.R1ToR1Series NIST2019 (
  130.         final int termCount)
  131.     {
  132.         try
  133.         {
  134.             java.util.TreeMap<java.lang.Integer, java.lang.Double> termWeightMap = new
  135.                 java.util.TreeMap<java.lang.Integer, java.lang.Double>();

  137.             for (int termIndex = 1; termIndex <= termCount; ++termIndex)
  138.             {
  139.                 termWeightMap.put (
  140.                     termIndex,
  141.                     1.
  142.                 );
  143.             }

  145.             return new org.drip.numerical.estimation.R1ToR1Series (
  146.                 org.drip.specialfunction.incompletegamma.UpperSFixedSeriesTerm.NIST2019(),
  147.                 false,
  148.                 termWeightMap
  149.             );
  150.         }
  151.         catch (java.lang.Exception e)
  152.         {
  153.             e.printStackTrace();
  154.         }

  156.         return null;
  157.     }

  159.     /**
  160.      * Construct the R<sup>1</sup> To R<sup>1</sup> NIST (2019) Recursive Limit Series
  161.      * 
  162.      * @param n n
  163.      * 
  164.      * @return The R<sup>1</sup> To R<sup>1</sup> NIST (2019) Recursive Limit Series
  165.      */

  167.     public static final org.drip.numerical.estimation.R1ToR1Series NIST2019Recursive (
  168.         final int n)
  169.     {
  170.         try
  171.         {
  172.             java.util.TreeMap<java.lang.Integer, java.lang.Double> termWeightMap = new
  173.                 java.util.TreeMap<java.lang.Integer, java.lang.Double>();

  175.             for (int termIndex = 0; termIndex < n; ++termIndex)
  176.             {
  177.                 termWeightMap.put (
  178.                     termIndex,
  179.                     1.
  180.                 );
  181.             }

  183.             return new org.drip.numerical.estimation.R1ToR1Series (
  184.                 org.drip.specialfunction.incompletegamma.UpperSFixedSeriesTerm.NIST2019 (n),
  185.                 false,
  186.                 termWeightMap
  187.             );
  188.         }
  189.         catch (java.lang.Exception e)
  190.         {
  191.             e.printStackTrace();
  192.         }

  194.         return null;
  195.     }

  197.     /**
  198.      * Construct the R<sup>1</sup> To R<sup>1</sup> Weisstein Limit Series
  199.      * 
  200.      * @param s s
  201.      * 
  202.      * @return The R<sup>1</sup> To R<sup>1</sup> Weisstein Limit Series
  203.      */

  205.     public static final org.drip.numerical.estimation.R1ToR1Series Weisstein (
  206.         final int s)
  207.     {
  208.         try
  209.         {
  210.             java.util.TreeMap<java.lang.Integer, java.lang.Double> termWeightMap = new
  211.                 java.util.TreeMap<java.lang.Integer, java.lang.Double>();

  213.             for (int termIndex = 0; termIndex < s; ++termIndex)
  214.             {
  215.                 termWeightMap.put (
  216.                     termIndex,
  217.                     1.
  218.                 );
  219.             }

  221.             return new org.drip.numerical.estimation.R1ToR1Series (
  222.                 org.drip.specialfunction.incompletegamma.UpperSFixedSeriesTerm.Weisstein (s),
  223.                 false,
  224.                 termWeightMap
  225.             );
  226.         }
  227.         catch (java.lang.Exception e)
  228.         {
  229.             e.printStackTrace();
  230.         }

  232.         return null;
  233.     }
  234. }
Created with JaCoCo 0.7.9.201702052155