CIRSteadyStatePDF.java

  1. package org.drip.sample.kolmogorov;

  3. import org.drip.dynamics.meanreverting.R1CIRStochasticEvolver;
  4. import org.drip.function.definition.R1ToR1;
  5. import org.drip.numerical.common.FormatUtil;
  6. import org.drip.service.env.EnvManager;

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

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

  72. /**
  73.  * <i>CIRTemporalPDF</i> demonstrates the Computation of the PDF from an Evolving R<sup>1</sup>
  74.  *  Cox-Ingersoll-Ross Process. The References are:
  75.  *  
  76.  *  <br><br>
  77.  *  <ul>
  78.  *      <li>
  79.  *          Bogoliubov, N. N., and D. P. Sankevich (1994): N. N. Bogoliubov and Statistical Mechanics
  80.  *              <i>Russian Mathematical Surveys</i> <b>49 (5)</b> 19-49
  81.  *      </li>
  82.  *      <li>
  83.  *          Holubec, V., K. Kroy, and S. Steffenoni (2019): Physically Consistent Numerical Solver for
  84.  *              Time-dependent Fokker-Planck Equations <i>Physical Review E</i> <b>99 (4)</b> 032117
  85.  *      </li>
  86.  *      <li>
  87.  *          Kadanoff, L. P. (2000): <i>Statistical Physics: Statics, Dynamics, and Re-normalization</i>
  88.  *              <b>World Scientific</b>
  89.  *      </li>
  90.  *      <li>
  91.  *          Ottinger, H. C. (1996): <i>Stochastic Processes in Polymeric Fluids</i> <b>Springer-Verlag</b>
  92.  *              Berlin-Heidelberg
  93.  *      </li>
  94.  *      <li>
  95.  *          Wikipedia (2019): Fokker-Planck Equation
  96.  *              https://en.wikipedia.org/wiki/Fokker%E2%80%93Planck_equation
  97.  *      </li>
  98.  *  </ul>
  99.  *
  100.  *  <br><br>
  101.  *  <ul>
  102.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/AnalyticsCore.md">Analytics Core Module</a></li>
  103.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics</a></li>
  104.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/dynamics/README.md">Dynamics</a></li>
  105.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/dynamics/lmm/README.md">LIBOR Market Model</a></li>
  106.  *  </ul>
  107.  *
  108.  * @author Lakshmi Krishnamurthy
  109.  */

  111. public class CIRSteadyStatePDF
  112. {

  114.     private static final void SteadyStateDistribution (
  115.         final double meanReversionSpeed,
  116.         final double meanReversionLevel,
  117.         final double volatility,
  118.         final double[] xArray)
  119.         throws Exception
  120.     {
  121.         R1ToR1 steadyStatePDF = R1CIRStochasticEvolver.Wiener (
  122.             meanReversionSpeed,
  123.             meanReversionLevel,
  124.             volatility,
  125.             0.01
  126.         ).fokkerPlanckGenerator().steadyStatePDF();

  128.         java.lang.String dump = "\t| [" +
  129.             FormatUtil.FormatDouble (meanReversionSpeed, 1, 1, 1.) + ", " +
  130.             FormatUtil.FormatDouble (meanReversionLevel, 1, 1, 1.) + ", " +
  131.             FormatUtil.FormatDouble (volatility, 1, 1, 1.) + "] =>";

  133.         for (double x : xArray)
  134.         {
  135.             dump = dump + " " + FormatUtil.FormatDouble (
  136.                 steadyStatePDF.evaluate (
  137.                     x
  138.                 ), 1, 6, 1.
  139.             ) + " |";
  140.         }

  142.         System.out.println (dump + "|");
  143.     }

  145.     public static final void main (
  146.         final String[] argumentArray)
  147.         throws Exception
  148.     {
  149.         EnvManager.InitEnv (
  150.             ""
  151.         );

  153.         double[] xArray =
  154.         {
  155.              0.01,
  156.              0.25,
  157.              0.50,
  158.              0.75,
  159.              1.00,
  160.              1.25,
  161.              1.50,
  162.              1.75,
  163.              2.00,
  164.              2.25,
  165.              2.50,
  166.         };
  167.         double[] meanReversionLevelArray =
  168.         {
  169.              2.0,
  170.              3.0,
  171.              4.0,
  172.         };
  173.         double[] meanReversionSpeedArray =
  174.         {
  175.              0.5,
  176.              1.0,
  177.              1.5,
  178.              2.0,
  179.              2.5,
  180.         };
  181.         double[] volatilityArray = 
  182.         {
  183.             0.5,
  184.             1.0,
  185.             1.5,
  186.             2.0,
  187.             2.5,
  188.             3.0,
  189.         };

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

  193.         System.out.println ("\t|                                                 CIR FOKKER-PLANCK PDF STEADY STATE DISTRIBUTION                                                   ||");

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

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

  199.         System.out.println ("\t|                - Mean Reversion Speed                                                                                                             ||");

  201.         System.out.println ("\t|                - Mean Reversion Level                                                                                                             ||");

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

  205.         System.out.println ("\t|                - Row of PDF Values over x                                                                                                         ||");

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

  209.         for (double meanReversionSpeed : meanReversionSpeedArray)
  210.         {
  211.             for (double meanReversionLevel : meanReversionLevelArray)
  212.             {
  213.                 for (double volatility : volatilityArray)
  214.                 {
  215.                     SteadyStateDistribution (
  216.                         meanReversionSpeed,
  217.                         meanReversionLevel,
  218.                         volatility,
  219.                         xArray
  220.                     );
  221.                 }
  222.             }
  223.         }

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

  227.         EnvManager.TerminateEnv();
  228.     }
  229. }
Created with JaCoCo 0.7.9.201702052155