IdentityProperty5.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.BetaEqualityLemma;

  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>IdentityProperty5</i> illustrates the Beta Function Identity Property Verification. The References are:
  80.  *
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Abramowitz, M., and I. A. Stegun (2007): <i>Handbook of Mathematics Functions</i> <b>Dover Book
  85.  *              on Mathematics</b>
  86.  *      </li>
  87.  *      <li>
  88.  *          Davis, P. J. (1959): Leonhard Euler's Integral: A Historical Profile of the Gamma Function
  89.  *              <i>American Mathematical Monthly</i> <b>66 (10)</b> 849-869
  90.  *      </li>
  91.  *      <li>
  92.  *          Whitaker, E. T., and G. N. Watson (1996): <i>A Course on Modern Analysis</i> <b>Cambridge
  93.  *              University Press</b> New York
  94.  *      </li>
  95.  *      <li>
  96.  *          Wikipedia (2019): Beta Function https://en.wikipedia.org/wiki/Beta_function
  97.  *      </li>
  98.  *      <li>
  99.  *          Wikipedia (2019): Gamma Function https://en.wikipedia.org/wiki/Gamma_function
  100.  *      </li>
  101.  *  </ul>
  102.  *
  103.  *  <br><br>
  104.  *  <ul>
  105.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  106.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FunctionAnalysisLibrary.md">Function Analysis Library</a></li>
  107.  *      <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>
  108.  *      <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>
  109.  *  </ul>
  110.  *
  111.  * @author Lakshmi Krishnamurthy
  112.  */

  113. public class IdentityProperty5
  114. {

  115.     private static final void Verifier (
  116.         final double x)
  117.         throws Exception
  118.     {
  119.         R1PropertyVerification verification = BetaEqualityLemma.Identity5().verify (x);

  120.         System.out.println (
  121.             "\t|" + FormatUtil.FormatDouble (x, 1, 1, 1.) + " => " +
  122.             FormatUtil.FormatDouble (verification.lValue(), 1, 10, 1.) + " | " +
  123.             FormatUtil.FormatDouble (verification.rValue(), 1, 10, 1.) + " | " +
  124.             verification.verified() + " ||"
  125.         );
  126.     }

  127.     public static final void main (
  128.         final String[] argumentArray)
  129.         throws Exception
  130.     {
  131.         EnvManager.InitEnv ("");

  132.         double[] xArray =
  133.         {
  134.             0.1,
  135.             0.2,
  136.             0.3,
  137.             0.4,
  138.             0.5,
  139.             0.6,
  140.             0.7,
  141.             0.8,
  142.             0.9,
  143.         };

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

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

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

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

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

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

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

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

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

  153.         for (double x : xArray)
  154.         {
  155.             Verifier (x);
  156.         }

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

  158.         EnvManager.TerminateEnv();
  159.     }
  160. }