PlottingPositionGenerator.java

  1. package org.drip.sample.quantile;

  2. import org.drip.numerical.common.FormatUtil;
  3. import org.drip.service.env.EnvManager;
  4. import org.drip.validation.quantile.PlottingPosition;
  5. import org.drip.validation.quantile.PlottingPositionGeneratorFilliben;
  6. import org.drip.validation.quantile.PlottingPositionGeneratorHeuristic;

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

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

  67. /**
  68.  * <i>PlottingPositionGenerator</i> compares several Order Statistics Mean and Median Based Plotting Position
  69.  * Generators.
  70.  *
  71.  *  <br><br>
  72.  *  <ul>
  73.  *      <li>
  74.  *          Gibbons, J. D., and S. Chakraborti (2003): <i>Non-parametric Statistical Inference 4th
  75.  *              Edition</i> <b>CRC Press</b>
  76.  *      </li>
  77.  *      <li>
  78.  *          Filliben, J. J. (1975): The Probability Plot Correlation Coefficient Test for Normality
  79.  *              <i>Technometrics, American Society for Quality</i> <b>17 (1)</b> 111-117
  80.  *      </li>
  81.  *      <li>
  82.  *          Gnanadesikan, R. (1977): <i>Methods for Statistical Analysis of Multivariate Observations</i>
  83.  *              <b>Wiley</b>
  84.  *      </li>
  85.  *      <li>
  86.  *          Thode, H. C. (2002): <i>Testing for Normality</i> <b>Marcel Dekker</b> New York
  87.  *      </li>
  88.  *      <li>
  89.  *          Wikipedia (2018): Q-Q Plot https://en.wikipedia.org/wiki/Q%E2%80%93Q_plot
  90.  *      </li>
  91.  *  </ul>
  92.  *
  93.  *  <br><br>
  94.  *  <ul>
  95.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/AnalyticsCore.md">Analytics Core Module</a></li>
  96.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ModelValidationAnalyticsLibrary.md">Model Validation Analytics Library</a></li>
  97.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/validation">Model Validation Suite</a></li>
  98.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/validation/quantile">Quantile Based Graphical Numerical Validators</a></li>
  99.  *  </ul>
  100.  * <br><br>
  101.  *
  102.  * @author Lakshmi Krishnamurthy
  103.  */

  104. public class PlottingPositionGenerator
  105. {

  106.     private static final void OrderStatisticQuantiles (
  107.         final PlottingPosition[] plottingPositionArrayStandard,
  108.         final PlottingPosition[] plottingPositionArrayBernardBosLevenbach,
  109.         final PlottingPosition[] plottingPositionArrayNIST,
  110.         final PlottingPosition[] plottingPositionArrayYuHuang,
  111.         final PlottingPosition[] plottingPositionArrayBMDP,
  112.         final PlottingPosition[] plottingPositionArrayBlom,
  113.         final PlottingPosition[] plottingPositionArrayCunnane,
  114.         final PlottingPosition[] plottingPositionArrayGringorten,
  115.         final PlottingPosition[] plottingPositionArrayHazen,
  116.         final PlottingPosition[] plottingPositionArrayLarsenCurrantHunt,
  117.         final PlottingPosition[] plottingPositionArrayFilliben,
  118.         final PlottingPosition[] plottingPositionArrayFillibenMedian)
  119.         throws Exception
  120.     {
  121.         for (int plotIndex = 0; plotIndex < plottingPositionArrayStandard.length; ++plotIndex)
  122.         {
  123.             System.out.println (
  124.                 "\t| " + FormatUtil.FormatDouble (
  125.                     plottingPositionArrayStandard[plotIndex].orderStatisticOrdinal(), 2, 0, 1.
  126.                 ) + " => " +
  127.                 FormatUtil.FormatDouble (plottingPositionArrayStandard[plotIndex].quantile(), 1, 4, 1.) + " | " +
  128.                 FormatUtil.FormatDouble (plottingPositionArrayBernardBosLevenbach[plotIndex].quantile(), 1, 4, 1.) + " | " +
  129.                 FormatUtil.FormatDouble (plottingPositionArrayNIST[plotIndex].quantile(), 1, 4, 1.) + " | " +
  130.                 FormatUtil.FormatDouble (plottingPositionArrayYuHuang[plotIndex].quantile(), 1, 4, 1.) + " | " +
  131.                 FormatUtil.FormatDouble (plottingPositionArrayBMDP[plotIndex].quantile(), 1, 4, 1.) + " | " +
  132.                 FormatUtil.FormatDouble (plottingPositionArrayBlom[plotIndex].quantile(), 1, 4, 1.) + " | " +
  133.                 FormatUtil.FormatDouble (plottingPositionArrayCunnane[plotIndex].quantile(), 1, 4, 1.) + " | " +
  134.                 FormatUtil.FormatDouble (plottingPositionArrayGringorten[plotIndex].quantile(), 1, 4, 1.) + " | " +
  135.                 FormatUtil.FormatDouble (plottingPositionArrayHazen[plotIndex].quantile(), 1, 4, 1.) + " | " +
  136.                 FormatUtil.FormatDouble (plottingPositionArrayLarsenCurrantHunt[plotIndex].quantile(), 1, 4, 1.) + " | " +
  137.                 FormatUtil.FormatDouble (plottingPositionArrayFilliben[plotIndex].quantile(), 1, 4, 1.) + " || " +
  138.                 FormatUtil.FormatDouble (plottingPositionArrayFillibenMedian[plotIndex].quantile(), 1, 4, 1.) + " ||"
  139.             );
  140.         }
  141.     }

  142.     public static final void main (
  143.         final String[] argumentArray)
  144.         throws java.lang.Exception
  145.     {
  146.         EnvManager.InitEnv ("");

  147.         int orderStatisticCount = 25;

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

  149.         System.out.println ("\t|                                 EXPECTED ORDER STATISTICS BASED PLOTTING POSITION GENERATORS                                  ||");

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

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

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

  153.         System.out.println ("\t|                - Wikipedia Standard (2018)                                                                                    ||");

  154.         System.out.println ("\t|                - Bernard and Bos-Leverbach (1953)                                                                             ||");

  155.         System.out.println ("\t|                - NIST (2013)                                                                                                  ||");

  156.         System.out.println ("\t|                - Yu and Huang (2001)                                                                                          ||");

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

  158.         System.out.println ("\t|                - Blom (1958)                                                                                                  ||");

  159.         System.out.println ("\t|                - Cunnane (1978)                                                                                               ||");

  160.         System.out.println ("\t|                - Gringorten (1963)                                                                                            ||");

  161.         System.out.println ("\t|                - Hazen (1913)                                                                                                 ||");

  162.         System.out.println ("\t|                - Larsen, Currant, and Hunt (1980)                                                                             ||");

  163.         System.out.println ("\t|                - Filliben (1975)                                                                                              ||");

  164.         System.out.println ("\t|                - Filliben (1975) Median Based                                                                                 ||");

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

  166.         OrderStatisticQuantiles (
  167.             PlottingPositionGeneratorHeuristic.Standard (orderStatisticCount).generate(),
  168.             PlottingPositionGeneratorHeuristic.BernardBosLevenbach1953 (orderStatisticCount).generate(),
  169.             PlottingPositionGeneratorHeuristic.NIST2013 (orderStatisticCount).generate(),
  170.             PlottingPositionGeneratorHeuristic.YuHuang2001 (orderStatisticCount).generate(),
  171.             PlottingPositionGeneratorHeuristic.BMDP2018 (orderStatisticCount).generate(),
  172.             PlottingPositionGeneratorHeuristic.Blom1958 (orderStatisticCount).generate(),
  173.             PlottingPositionGeneratorHeuristic.Cunnane1978 (orderStatisticCount).generate(),
  174.             PlottingPositionGeneratorHeuristic.Gringorten1963 (orderStatisticCount).generate(),
  175.             PlottingPositionGeneratorHeuristic.Hazen1913 (orderStatisticCount).generate(),
  176.             PlottingPositionGeneratorHeuristic.LarsenCurrantHunt1980 (orderStatisticCount).generate(),
  177.             PlottingPositionGeneratorHeuristic.Filliben1975 (orderStatisticCount).generate(),
  178.             new PlottingPositionGeneratorFilliben (orderStatisticCount).generate()
  179.         );

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

  181.         EnvManager.TerminateEnv();
  182.     }
  183. }