IncompleteIdentityProperty5.java

  1. package org.drip.sample.beta;

  2. import org.drip.function.definition.R1PropertyVerification;
  3. import org.drip.numerical.common.FormatUtil;
  4. import org.drip.service.env.EnvManager;
  5. import org.drip.specialfunction.property.IncompleteBetaEqualityLemma;

  6. /*
  7.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  8.  */

  9. /*!
  10.  * Copyright (C) 2020 Lakshmi Krishnamurthy
  11.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  12.  *
  13.  *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
  14.  *      asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
  15.  *      analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
  16.  *      equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
  17.  *      numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
  18.  *      and computational support.
  19.  *  
  20.  *      https://lakshmidrip.github.io/DROP/
  21.  *  
  22.  *  DROP is composed of three modules:
  23.  *  
  24.  *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
  25.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  26.  *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
  27.  *
  28.  *  DROP Product Core implements libraries for the following:
  29.  *  - Fixed Income Analytics
  30.  *  - Loan Analytics
  31.  *  - Transaction Cost Analytics
  32.  *
  33.  *  DROP Portfolio Core implements libraries for the following:
  34.  *  - Asset Allocation Analytics
  35.  *  - Asset Liability Management Analytics
  36.  *  - Capital Estimation Analytics
  37.  *  - Exposure Analytics
  38.  *  - Margin Analytics
  39.  *  - XVA Analytics
  40.  *
  41.  *  DROP Computational Core implements libraries for the following:
  42.  *  - Algorithm Support
  43.  *  - Computation Support
  44.  *  - Function Analysis
  45.  *  - Model Validation
  46.  *  - Numerical Analysis
  47.  *  - Numerical Optimizer
  48.  *  - Spline Builder
  49.  *  - Statistical Learning
  50.  *
  51.  *  Documentation for DROP is Spread Over:
  52.  *
  53.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  54.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  55.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  56.  *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
  57.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  58.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  59.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  60.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  61.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  62.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  63.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  64.  *
  65.  *  Licensed under the Apache License, Version 2.0 (the "License");
  66.  *      you may not use this file except in compliance with the License.
  67.  *  
  68.  *  You may obtain a copy of the License at
  69.  *      http://www.apache.org/licenses/LICENSE-2.0
  70.  *  
  71.  *  Unless required by applicable law or agreed to in writing, software
  72.  *      distributed under the License is distributed on an "AS IS" BASIS,
  73.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  74.  *  
  75.  *  See the License for the specific language governing permissions and
  76.  *      limitations under the License.
  77.  */

  78. /**
  79.  * <i>IncompleteIdentityProperty5</i> illustrates the Incomplete Beta Function Identity Property
  80.  * Verification. The References are:
  81.  *
  82.  * <br><br>
  83.  *  <ul>
  84.  *      <li>
  85.  *          Abramowitz, M., and I. A. Stegun (2007): <i>Handbook of Mathematics Functions</i> <b>Dover Book
  86.  *              on Mathematics</b>
  87.  *      </li>
  88.  *      <li>
  89.  *          Davis, P. J. (1959): Leonhard Euler's Integral: A Historical Profile of the Gamma Function
  90.  *              <i>American Mathematical Monthly</i> <b>66 (10)</b> 849-869
  91.  *      </li>
  92.  *      <li>
  93.  *          Whitaker, E. T., and G. N. Watson (1996): <i>A Course on Modern Analysis</i> <b>Cambridge
  94.  *              University Press</b> New York
  95.  *      </li>
  96.  *      <li>
  97.  *          Wikipedia (2019): Beta Function https://en.wikipedia.org/wiki/Beta_function
  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/sample/README.md">DROP API Construction and Usage</a></li>
  109.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/beta/README.md">Estimates of the Beta Functions</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  114. public class IncompleteIdentityProperty5
  115. {

  116.     private static final void Verifier (
  117.         final double x,
  118.         final double a,
  119.         final double b)
  120.         throws Exception
  121.     {
  122.         R1PropertyVerification verification = IncompleteBetaEqualityLemma.Identity5().verify (
  123.             x,
  124.             a,
  125.             b
  126.         );

  127.         System.out.println (
  128.             "\t|[" + FormatUtil.FormatDouble (x, 1, 2, 1., false) + "; " +
  129.             FormatUtil.FormatDouble (a, 1, 2, 1., false) + ", " +
  130.             FormatUtil.FormatDouble (b, 1, 2, 1., false) + "] => " +
  131.             FormatUtil.FormatDouble (verification.lValue(), 2, 10, 1.) + " | " +
  132.             FormatUtil.FormatDouble (verification.rValue(), 2, 10, 1.) + " | " +
  133.             verification.verified() + " ||"
  134.         );
  135.     }

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

  141.         double[] xArray =
  142.         {
  143.             0.2,
  144.             0.4,
  145.             0.6,
  146.             0.8,
  147.         };
  148.         double[] aArray =
  149.         {
  150.             1.0,
  151.             2.0,
  152.             3.0,
  153.             4.0,
  154.             5.0,
  155.             6.0,
  156.         };
  157.         double[] bArray =
  158.         {
  159.             1.0,
  160.             2.0,
  161.             3.0,
  162.             4.0,
  163.             5.0,
  164.             6.0,
  165.         };

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

  167.         System.out.println ("\t|          INCOMPLETE BETA FUNCTION IDENTITY PROPERTY         ||");

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

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

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

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

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

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

  174.         System.out.println ("\t|                - RHS Value                                  ||");

  175.         System.out.println ("\t|                - Verification Success?                      ||");

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

  177.         for (double x : xArray)
  178.         {
  179.             for (double a : aArray)
  180.             {
  181.                 for (double b : bArray)
  182.                 {
  183.                     Verifier (
  184.                         x,
  185.                         a,
  186.                         b
  187.                     );
  188.                 }
  189.             }
  190.         }

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

  192.         EnvManager.TerminateEnv();
  193.     }
  194. }