NonCentralPDFEstimate.java

  1. package org.drip.sample.chisquaredistribution;

  3. import org.drip.function.definition.R1ToR1;
  4. import org.drip.function.definition.R2ToR1;
  5. import org.drip.measure.chisquare.R1NonCentral;
  6. import org.drip.numerical.common.FormatUtil;
  7. import org.drip.service.env.EnvManager;
  8. import org.drip.specialfunction.bessel.ModifiedFirstFrobeniusSeriesEstimator;
  9. import org.drip.specialfunction.definition.ModifiedBesselFirstKindEstimator;
  10. import org.drip.specialfunction.digamma.CumulativeSeriesEstimator;
  11. import org.drip.specialfunction.gamma.EulerIntegralSecondKind;
  12. import org.drip.specialfunction.incompletegamma.LowerEulerIntegral;

  14. /*
  15.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  16.  */

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

  88. /**
  89.  * <i>NonCentralPDFEstimate</i> implements the PDF for the Non-central Chi-Square Distribution. The
  90.  * References are:
  91.  * 
  92.  * <br><br>
  93.  *  <ul>
  94.  *      <li>
  95.  *          Johnson, N. L., S. Kotz, and N. Balakrishnan (1995): <i>Continuous Univariate Distributions
  96.  *              2<sup>nd</sup> Edition</i> <b>John Wiley and Sons</b>
  97.  *      </li>
  98.  *      <li>
  99.  *          Muirhead, R. (2005): <i>Aspects of Multivariate Statistical Theory 2<sup>nd</sup> Edition</i>
  100.  *              <b>Wiley</b>
  101.  *      </li>
  102.  *      <li>
  103.  *          Non-central Chi-Squared Distribution (2019): Chi-Squared Function
  104.  *              https://en.wikipedia.org/wiki/Noncentral_chi-squared_distribution
  105.  *      </li>
  106.  *      <li>
  107.  *          Sankaran, M. (1963): Approximations to the Non-Central Chi-Square Distribution <i>Biometrika</i>
  108.  *              <b>50 (1-2)</b> 199-204
  109.  *      </li>
  110.  *      <li>
  111.  *          Young, D. S. (2010): tolerance: An R Package for Estimating Tolerance Intervals <i>Journal of
  112.  *              Statistical Software</i> <b>36 (5)</b> 1-39
  113.  *      </li>
  114.  *  </ul>
  115.  *
  116.  *  <br><br>
  117.  *  <ul>
  118.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  119.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalAnalysisLibrary.md">Numerical Analysis Library</a></li>
  120.  *      <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>
  121.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/chisquaredistribution/README.md">Chi-Square Distribution Usage/Properties</a></li>
  122.  *  </ul>
  123.  *
  124.  * @author Lakshmi Krishnamurthy
  125.  */

  127. public class NonCentralPDFEstimate
  128. {

  130.     private static final R2ToR1 LowerIncompleteGamma()
  131.         throws Exception
  132.     {
  133.         return new R2ToR1()
  134.         {
  135.             @Override public double evaluate (
  136.                 final double s,
  137.                 final double t)
  138.                 throws Exception
  139.             {
  140.                 return new LowerEulerIntegral (
  141.                     null,
  142.                     t
  143.                 ).evaluate (
  144.                     s
  145.                 );
  146.             }
  147.         };
  148.     }

  150.     public static final void main (
  151.         final String[] argumentArray)
  152.         throws Exception
  153.     {
  154.         EnvManager.InitEnv (
  155.             ""
  156.         );

  158.         int besselFirstTermCount = 20;
  159.         int digammaTermCount = 1000;
  160.         double[] nonCentralityParameterArray =
  161.         {
  162.             0.5,
  163.             1.0,
  164.             1.5,
  165.             2.0,
  166.         };
  167.         double[] tArray =
  168.         {
  169.              0.1,
  170.              1.0,
  171.              2.0,
  172.              3.0,
  173.              4.0,
  174.              5.0,
  175.              6.0,
  176.              7.0,
  177.              8.0,
  178.              9.0,
  179.             10.0,
  180.             12.0,
  181.         };
  182.         int[] dofArray =
  183.         {
  184.              2,
  185.              3,
  186.              4,
  187.              5,
  188.              6,
  189.              7,
  190.              8,
  191.              9,
  192.         };
  193.         double[] pValueArray =
  194.         {
  195.              0.05,
  196.              0.10,
  197.              0.15,
  198.              0.20,
  199.              0.25,
  200.              0.30,
  201.              0.35,
  202.              0.40,
  203.              0.45,
  204.              0.50,
  205.              0.55,
  206.              0.60,
  207.         };

  209.         R1ToR1 gammaEstimator = new EulerIntegralSecondKind (
  210.             null
  211.         );

  213.         R2ToR1 lowerIncompleteGammaEstimator = LowerIncompleteGamma();

  215.         R1ToR1 digammaEstimator = CumulativeSeriesEstimator.AbramowitzStegun2007 (
  216.             digammaTermCount
  217.         );

  219.         ModifiedBesselFirstKindEstimator modifiedBesselFirstKindEstimator =
  220.             ModifiedFirstFrobeniusSeriesEstimator.Standard (
  221.                 gammaEstimator,
  222.                 besselFirstTermCount
  223.             );

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

  227.         System.out.println ("\t|                                             PROBABILITY DENSITY FUNCTION ESTIMATE                                            ||");

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

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

  233.         System.out.println ("\t|                - Degrees of Freedom. Non Centrality Parameter                                                                ||");

  235.         System.out.println ("\t|                - Values for different t                                                                                      ||");

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

  239.         for (double nonCentralityParameter : nonCentralityParameterArray)
  240.         {
  241.             for (int dof : dofArray)
  242.             {
  243.                 R1NonCentral r1UnivariateNonCentral = R1NonCentral.Standard (
  244.                     dof,
  245.                     nonCentralityParameter,
  246.                     gammaEstimator,
  247.                     digammaEstimator,
  248.                     lowerIncompleteGammaEstimator,
  249.                     modifiedBesselFirstKindEstimator
  250.                 );

  252.                 String display = "\t| [" +
  253.                     FormatUtil.FormatDouble (dof, 2, 0, 1., false) + " | " +
  254.                     FormatUtil.FormatDouble (nonCentralityParameter, 1, 1, 1., false) +
  255.                 "] =>";

  257.                 for (double t : tArray)
  258.                 {
  259.                     display = display + " " + FormatUtil.FormatDouble (
  260.                         r1UnivariateNonCentral.density (
  261.                             t
  262.                         ), 1, 5, 1., false
  263.                     ) + " |";
  264.                 }

  266.                 System.out.println (display + "|");
  267.             }
  268.         }

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

  272.         System.out.println();

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

  276.         System.out.println ("\t|                                           CUMULATIVE DISTRIBUTION FUNCTION ESTIMATE                                          ||");

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

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

  282.         System.out.println ("\t|                - Degrees of Freedom. Non Centrality Parameter                                                                ||");

  284.         System.out.println ("\t|                - Values for different t                                                                                      ||");

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

  288.         for (double nonCentralityParameter : nonCentralityParameterArray)
  289.         {
  290.             for (int dof : dofArray)
  291.             {
  292.                 R1NonCentral r1UnivariateNonCentral = R1NonCentral.Standard (
  293.                     dof,
  294.                     nonCentralityParameter,
  295.                     gammaEstimator,
  296.                     digammaEstimator,
  297.                     lowerIncompleteGammaEstimator,
  298.                     modifiedBesselFirstKindEstimator
  299.                 );

  301.                 String display = "\t| [" +
  302.                     FormatUtil.FormatDouble (dof, 2, 0, 1., false) + " | " +
  303.                     FormatUtil.FormatDouble (nonCentralityParameter, 1, 1, 1., false) +
  304.                 "] =>";

  306.                 for (double t : tArray)
  307.                 {
  308.                     display = display + " " + FormatUtil.FormatDouble (
  309.                         r1UnivariateNonCentral.cumulative (
  310.                             t
  311.                         ), 1, 5, 1., false
  312.                     ) + " |";
  313.                 }

  315.                 System.out.println (display + "|");
  316.             }
  317.         }

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

  321.         System.out.println();

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

  325.         System.out.println ("\t|                                       INVERSE CUMULATIVE DISTRIBUTION FUNCTION ESTIMATE                                      ||");

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

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

  331.         System.out.println ("\t|                - Degrees of Freedom. Non Centrality Parameter                                                                ||");

  333.         System.out.println ("\t|                - Values for different p                                                                                      ||");

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

  337.         for (double nonCentralityParameter : nonCentralityParameterArray)
  338.         {
  339.             for (int dof : dofArray)
  340.             {
  341.                 R1NonCentral r1UnivariateNonCentral = R1NonCentral.Standard (
  342.                     dof,
  343.                     nonCentralityParameter,
  344.                     gammaEstimator,
  345.                     digammaEstimator,
  346.                     lowerIncompleteGammaEstimator,
  347.                     modifiedBesselFirstKindEstimator
  348.                 );

  350.                 String display = "\t| [" +
  351.                     FormatUtil.FormatDouble (dof, 2, 0, 1., false) + " | " +
  352.                     FormatUtil.FormatDouble (nonCentralityParameter, 1, 1, 1., false) +
  353.                 "] =>";

  355.                 for (double p : pValueArray)
  356.                 {
  357.                     display = display + " " + FormatUtil.FormatDouble (
  358.                         r1UnivariateNonCentral.invCumulative (
  359.                             p
  360.                         ), 1, 5, 1., false
  361.                     ) + " |";
  362.                 }

  364.                 System.out.println (display + "|");
  365.             }
  366.         }

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

  370.         EnvManager.TerminateEnv();
  371.     }
  372. }
Created with JaCoCo 0.7.9.201702052155