IntegrandEstimator.java

  1. package org.drip.specialfunction.beta;

  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>IntegrandEstimator</i> implements the Beta Function using Integrand Estimation Schemes. The References
  79.  * 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/specialfunction/README.md">Special Function Implementation Analysis</a></li>
  108.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/beta/README.md">Estimation Techniques for Beta Function</a></li>
  109.  *  </ul>
  110.  *
  111.  * @author Lakshmi Krishnamurthy
  112.  */

  114. public abstract class IntegrandEstimator extends org.drip.specialfunction.definition.BetaEstimator
  115. {
  116.     private int _quadratureCount = -1;

  118.     /**
  119.      * Construct the Beta Estimator from the Trigonometric Integral
  120.      * 
  121.      * @param quadratureCount Count of the Integrand Quadrature
  122.      * 
  123.      * @return Beta Estimator from the Trigonometric Integral
  124.      */

  126.     public static final IntegrandEstimator Trigonometric (
  127.         final int quadratureCount)
  128.     {
  129.         try
  130.         {
  131.             return new IntegrandEstimator (quadratureCount)
  132.             {
  133.                 @Override public double evaluate (
  134.                     final double x,
  135.                     final double y)
  136.                     throws java.lang.Exception
  137.                 {
  138.                     if (!org.drip.numerical.common.NumberUtil.IsValid (x) ||
  139.                         !org.drip.numerical.common.NumberUtil.IsValid (y))
  140.                     {
  141.                         throw new java.lang.Exception
  142.                             ("IntegrandEstimator::Trigonometric::evaluate => Invalid Inputs");
  143.                     }

  145.                     return 2. * org.drip.numerical.integration.NewtonCotesQuadratureGenerator.Zero_PlusOne (
  146.                         0.,
  147.                         0.5 * java.lang.Math.PI,
  148.                         quadratureCount
  149.                     ).integrate (
  150.                         new org.drip.function.definition.R1ToR1 (null)
  151.                         {
  152.                             @Override public double evaluate (
  153.                                 final double theta)
  154.                                 throws java.lang.Exception
  155.                             {
  156.                                 return 0. == theta || 0.5 * java.lang.Math.PI == theta ? 0. :
  157.                                     java.lang.Math.pow (
  158.                                         java.lang.Math.sin (theta),
  159.                                         2. * x - 1.
  160.                                     ) * java.lang.Math.pow (
  161.                                         java.lang.Math.cos (theta),
  162.                                         2. * y - 1.
  163.                                     );
  164.                             }
  165.                         }
  166.                     );
  167.                 }
  168.             };
  169.         }
  170.         catch (java.lang.Exception e)
  171.         {
  172.             e.printStackTrace();
  173.         }

  175.         return null;
  176.     }

  178.     /**
  179.      * Construct the Beta Estimator from the Euler Integral of the First Kind
  180.      * 
  181.      * @param quadratureCount Count of the Integrand Quadrature
  182.      * 
  183.      * @return Beta Estimator from the Euler Integral of the First Kind
  184.      */

  186.     public static final IntegrandEstimator EulerFirst (
  187.         final int quadratureCount)
  188.     {
  189.         try
  190.         {
  191.             return new IntegrandEstimator (quadratureCount)
  192.             {
  193.                 @Override public double evaluate (
  194.                     final double x,
  195.                     final double y)
  196.                     throws java.lang.Exception
  197.                 {
  198.                     if (!org.drip.numerical.common.NumberUtil.IsValid (x) ||
  199.                         !org.drip.numerical.common.NumberUtil.IsValid (y))
  200.                     {
  201.                         throw new java.lang.Exception
  202.                             ("IntegrandEstimator::EulerFirst::evaluate => Invalid Inputs");
  203.                     }

  205.                     return org.drip.numerical.integration.NewtonCotesQuadratureGenerator.Zero_PlusOne (
  206.                         0.,
  207.                         1.,
  208.                         1000000
  209.                     ).integrate (
  210.                         new org.drip.function.definition.R1ToR1 (null)
  211.                         {
  212.                             @Override public double evaluate (
  213.                                 final double t)
  214.                                 throws java.lang.Exception
  215.                             {
  216.                                 return 0. == t || 1. == t ? 0. : java.lang.Math.pow (
  217.                                     t,
  218.                                     x - 1.
  219.                                 ) * java.lang.Math.pow (
  220.                                     1. - t,
  221.                                     y - 1.
  222.                                 );
  223.                             }
  224.                         }
  225.                     );
  226.                 }
  227.             };
  228.         }
  229.         catch (java.lang.Exception e)
  230.         {
  231.             e.printStackTrace();
  232.         }

  234.         return null;
  235.     }

  237.     /**
  238.      * Construct the Beta Estimator from the Euler Integral of the First Kind
  239.      * 
  240.      * @param quadratureCount Count of the Integrand Quadrature
  241.      * @param exponent Exponent
  242.      * 
  243.      * @return Beta Estimator from the Euler Integral of the First Kind
  244.      */

  246.     public static final IntegrandEstimator EulerFirstN (
  247.         final int quadratureCount,
  248.         final double exponent)
  249.     {
  250.         if (!org.drip.numerical.common.NumberUtil.IsValid (exponent) || 0. >= exponent)
  251.         {
  252.             return null;
  253.         }

  255.         try
  256.         {
  257.             return new IntegrandEstimator (quadratureCount)
  258.             {
  259.                 @Override public double evaluate (
  260.                     final double x,
  261.                     final double y)
  262.                     throws java.lang.Exception
  263.                 {
  264.                     if (!org.drip.numerical.common.NumberUtil.IsValid (x) ||
  265.                         !org.drip.numerical.common.NumberUtil.IsValid (y))
  266.                     {
  267.                         throw new java.lang.Exception
  268.                             ("IntegrandEstimator::EulerFirstN::evaluate => Invalid Inputs");
  269.                     }

  271.                     return exponent * org.drip.numerical.integration.NewtonCotesQuadratureGenerator.Zero_PlusOne (
  272.                         0.,
  273.                         1.,
  274.                         quadratureCount
  275.                     ).integrate (
  276.                         new org.drip.function.definition.R1ToR1 (null)
  277.                         {
  278.                             @Override public double evaluate (
  279.                                 final double t)
  280.                                 throws java.lang.Exception
  281.                             {
  282.                                 return 0. == t || 1. == t ? 0. : java.lang.Math.pow (
  283.                                     t,
  284.                                     exponent * x - 1.
  285.                                 ) * java.lang.Math.pow (
  286.                                     java.lang.Math.pow (
  287.                                         1. - t,
  288.                                         exponent
  289.                                     ),
  290.                                     y - 1.
  291.                                 );
  292.                             }
  293.                         }
  294.                     );
  295.                 }
  296.             };
  297.         }
  298.         catch (java.lang.Exception e)
  299.         {
  300.             e.printStackTrace();
  301.         }

  303.         return null;
  304.     }

  306.     /**
  307.      * Construct the Beta Estimator from the Euler Integral of the First Kind over the Right Half Plane
  308.      * 
  309.      * @param quadratureCount Count of the Integrand Quadrature
  310.      * 
  311.      * @return Beta Estimator from the Euler Integral of the First Kind over the Right Half Plane
  312.      */

  314.     public static final IntegrandEstimator EulerFirstRightPlane (
  315.         final int quadratureCount)
  316.     {
  317.         try
  318.         {
  319.             return new IntegrandEstimator (quadratureCount)
  320.             {
  321.                 @Override public double evaluate (
  322.                     final double x,
  323.                     final double y)
  324.                     throws java.lang.Exception
  325.                 {
  326.                     if (!org.drip.numerical.common.NumberUtil.IsValid (x) ||
  327.                         !org.drip.numerical.common.NumberUtil.IsValid (y))
  328.                     {
  329.                         throw new java.lang.Exception
  330.                             ("IntegrandEstimator::EulerFirstRightPlane::evaluate => Invalid Inputs");
  331.                     }

  333.                     return org.drip.numerical.integration.NewtonCotesQuadratureGenerator.GaussLaguerreLeftDefinite (
  334.                         0.,
  335.                         quadratureCount
  336.                     ).integrate (
  337.                         new org.drip.function.definition.R1ToR1 (null)
  338.                         {
  339.                             @Override public double evaluate (
  340.                                 final double t)
  341.                                 throws java.lang.Exception
  342.                             {
  343.                                 return 0. == t || java.lang.Double.isInfinite (t) ? 0. :
  344.                                     java.lang.Math.pow (
  345.                                         t,
  346.                                         x - 1.
  347.                                     ) / java.lang.Math.pow (
  348.                                         1. + t,
  349.                                         x + y
  350.                                     );
  351.                             }
  352.                         }
  353.                     );
  354.                 }
  355.             };
  356.         }
  357.         catch (java.lang.Exception e)
  358.         {
  359.             e.printStackTrace();
  360.         }

  362.         return null;
  363.     }

  365.     protected IntegrandEstimator (
  366.         final int quadratureCount)
  367.         throws java.lang.Exception
  368.     {
  369.         if (0 >= (_quadratureCount = quadratureCount))
  370.         {
  371.             throw new java.lang.Exception ("IntegrandEstimator Constructor => Invalid Inputs");
  372.         }
  373.     }

  375.     /**
  376.      * Retrieve the Quadrature Count
  377.      * 
  378.      * @return The Quadrature Count
  379.      */

  381.     public int quadratureCount()
  382.     {
  383.         return _quadratureCount;
  384.     }
  385. }
Created with JaCoCo 0.7.9.201702052155