EllipticKIntegralEstimate.java

  1. package org.drip.sample.hypergeometric;

  3. import org.drip.function.definition.R2ToR1;
  4. import org.drip.numerical.common.FormatUtil;
  5. import org.drip.service.env.EnvManager;
  6. import org.drip.specialfunction.beta.LogGammaEstimator;
  7. import org.drip.specialfunction.definition.EllipticKIntegralEstimator;
  8. import org.drip.specialfunction.derived.EllipticKIntegral;

  10. /*
  11.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  12.  */

  14. /*!
  15.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  16.  * 
  17.  *  This file is part of DROP, an open-source library targeting risk, transaction costs, exposure, margin
  18.  *      calculations, and portfolio construction within and across fixed income, credit, commodity, equity,
  19.  *      FX, and structured products.
  20.  *  
  21.  *      https://lakshmidrip.github.io/DROP/
  22.  *  
  23.  *  DROP is composed of three main modules:
  24.  *  
  25.  *  - DROP Analytics Core - https://lakshmidrip.github.io/DROP-Analytics-Core/
  26.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  27.  *  - DROP Numerical Core - https://lakshmidrip.github.io/DROP-Numerical-Core/
  28.  * 
  29.  *  DROP Analytics Core implements libraries for the following:
  30.  *  - Fixed Income Analytics
  31.  *  - Asset Backed Analytics
  32.  *  - XVA Analytics
  33.  *  - Exposure and Margin Analytics
  34.  * 
  35.  *  DROP Portfolio Core implements libraries for the following:
  36.  *  - Asset Allocation Analytics
  37.  *  - Transaction Cost Analytics
  38.  * 
  39.  *  DROP Numerical Core implements libraries for the following:
  40.  *  - Statistical Learning Library
  41.  *  - Numerical Optimizer Library
  42.  *  - Machine Learning Library
  43.  *  - Spline Builder Library
  44.  * 
  45.  *  Documentation for DROP is Spread Over:
  46.  * 
  47.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  48.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  49.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  50.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  51.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  52.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  53.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  54.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  55.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  56.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  57.  * 
  58.  *  Licensed under the Apache License, Version 2.0 (the "License");
  59.  *      you may not use this file except in compliance with the License.
  60.  *   
  61.  *  You may obtain a copy of the License at
  62.  *      http://www.apache.org/licenses/LICENSE-2.0
  63.  *  
  64.  *  Unless required by applicable law or agreed to in writing, software
  65.  *      distributed under the License is distributed on an "AS IS" BASIS,
  66.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  67.  *  
  68.  *  See the License for the specific language governing permissions and
  69.  *      limitations under the License.
  70.  */

  72. /**
  73.  * <i>EllipticKIntegralEstimate</i> estimates the Elliptic K-Integral Function using the 2F1 Hyper-geometric
  74.  * Function. The References are:
  75.  * 
  76.  * <br><br>
  77.  *  <ul>
  78.  *      <li>
  79.  *          Gessel, I., and D. Stanton (1982): Strange Evaluations of Hyper-geometric Series <i>SIAM Journal
  80.  *              on Mathematical Analysis</i> <b>13 (2)</b> 295-308
  81.  *      </li>
  82.  *      <li>
  83.  *          Koepf, W (1995): Algorithms for m-fold Hyper-geometric Summation <i>Journal of Symbolic
  84.  *              Computation</i> <b>20 (4)</b> 399-417
  85.  *      </li>
  86.  *      <li>
  87.  *          Lavoie, J. L., F. Grondin, and A. K. Rathie (1996): Generalization of Whipple’s Theorem on the
  88.  *              Sum of a (_2^3)F(a,b;c;z) <i>Journal of Computational and Applied Mathematics</i> <b>72</b>
  89.  *              293-300
  90.  *      </li>
  91.  *      <li>
  92.  *          National Institute of Standards and Technology (2019): Hyper-geometric Function
  93.  *              https://dlmf.nist.gov/15
  94.  *      </li>
  95.  *      <li>
  96.  *          Wikipedia (2019): Hyper-geometric Function https://en.wikipedia.org/wiki/Hypergeometric_function
  97.  *      </li>
  98.  *  </ul>
  99.  *
  100.  *  <br><br>
  101.  *  <ul>
  102.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalCore.md">Numerical Core Module</a></li>
  103.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalOptimizerLibrary.md">Numerical Optimizer</a></li>
  104.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/README.md">Function</a></li>
  105.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/hypergeometric/README.md">Estimates of Hyper-geometric Function</a></li>
  106.  *  </ul>
  107.  *
  108.  * @author Lakshmi Krishnamurthy
  109.  */

  111. public class EllipticKIntegralEstimate
  112. {

  114.     private static final void EllipticKIntegral (
  115.         final R2ToR1 logBetaEstimator,
  116.         final int quadratureCount,
  117.         final double[] zArray)
  118.         throws Exception
  119.     {
  120.         EllipticKIntegralEstimator ellipticKIntegralEstimator = new EllipticKIntegral (
  121.             logBetaEstimator,
  122.             quadratureCount
  123.         );

  125.         for (double z : zArray)
  126.         {
  127.             System.out.println ("\t| {z=" +
  128.                 FormatUtil.FormatDouble (z, 1, 2, 1.) + "} => " +
  129.                 FormatUtil.FormatDouble (ellipticKIntegralEstimator.evaluate (z), 1, 10, 1., false) + " ||"
  130.             );
  131.         }
  132.     }

  134.     public static final void main (
  135.         final String[] argumentArray)
  136.         throws Exception
  137.     {
  138.         EnvManager.InitEnv ("");

  140.         double[] zArray =
  141.         {
  142.             -1.00,
  143.             -0.90,
  144.             -0.80,
  145.             -0.70,
  146.             -0.60,
  147.             -0.50,
  148.             -0.40,
  149.             -0.30,
  150.             -0.20,
  151.             -0.10,
  152.              0.00,
  153.              0.10,
  154.              0.20,
  155.              0.30,
  156.              0.40,
  157.              0.50,
  158.              0.60,
  159.              0.70,
  160.              0.80,
  161.              0.90,
  162.              1.00
  163.         };
  164.         int logBetaTermCount = 1000;
  165.         int hypergeometricQuadratureCount = 10000;

  167.         R2ToR1 logBetaEstimator = LogGammaEstimator.Weierstrass (logBetaTermCount);

  169.         System.out.println ("\t|---------------------------||");

  171.         System.out.println ("\t|    ELLIPTIC K INTEGRAL    ||");

  173.         System.out.println ("\t|---------------------------||");

  175.         System.out.println ("\t|        L -> R:            ||");

  177.         System.out.println ("\t|                - k        ||");

  179.         System.out.println ("\t|                - Estimate ||");

  181.         System.out.println ("\t|---------------------------||");

  183.         EllipticKIntegral (
  184.             logBetaEstimator,
  185.             hypergeometricQuadratureCount,
  186.             zArray
  187.         );

  189.         System.out.println ("\t|---------------------------||");

  191.         EnvManager.TerminateEnv();
  192.     }
  193. }
Created with JaCoCo 0.7.9.201702052155