PrincipalComponentQMDynamics.java

  1. package org.drip.sample.hjm;

  3. import org.drip.analytics.date.*;
  4. import org.drip.analytics.definition.MarketSurface;
  5. import org.drip.analytics.support.Helper;
  6. import org.drip.dynamics.hjm.*;
  7. import org.drip.function.definition.R1ToR1;
  8. import org.drip.function.r1tor1.FlatUnivariate;
  9. import org.drip.numerical.common.FormatUtil;
  10. import org.drip.sequence.random.*;
  11. import org.drip.service.env.EnvManager;
  12. import org.drip.spline.basis.PolynomialFunctionSetParams;
  13. import org.drip.spline.params.*;
  14. import org.drip.spline.stretch.MultiSegmentSequenceBuilder;
  15. import org.drip.state.creator.ScenarioMarketSurfaceBuilder;
  16. import org.drip.state.identifier.*;

  18. /*
  19.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  20.  */

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

  85. /**
  86.  * <i>PrincipalComponentQMDynamics</i> demonstrates the Construction and Usage of the Principal Component
  87.  * Based Gaussian Model Dynamics for the Evolution of the Discount Factor Quantification Metrics - the
  88.  * Instantaneous Forward Rate, the LIBOR Forward Rate, the Shifted LIBOR Forward Rate, the Short Rate, the
  89.  * Compounded Short Rate, and the Price.
  90.  *  
  91.  * <br><br>
  92.  *  <ul>
  93.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/AnalyticsCore.md">Analytics Core Module</a></li>
  94.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics Library</a></li>
  95.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/README.md">Sample</a></li>
  96.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/hjm/README.md">Generic HJM Evolution</a></li>
  97.  *  </ul>
  98.  * <br><br>
  99.  *
  100.  * @author Lakshmi Krishnamurthy
  101.  */

  103. public class PrincipalComponentQMDynamics {

  105.     private static final MarketSurface FlatVolatilitySurface (
  106.         final JulianDate dtStart,
  107.         final String strCurrency,
  108.         final double dblFlatVol)
  109.         throws Exception
  110.     {
  111.         return ScenarioMarketSurfaceBuilder.CustomSplineWireSurface (
  112.             "VIEW_TARGET_VOLATILITY_SURFACE",
  113.             dtStart,
  114.             strCurrency,
  115.             new double[] {
  116.                 dtStart.julian(),
  117.                 dtStart.addYears (2).julian(),
  118.                 dtStart.addYears (4).julian(),
  119.                 dtStart.addYears (6).julian(),
  120.                 dtStart.addYears (8).julian(),
  121.                 dtStart.addYears (10).julian()
  122.             },
  123.             new double[] {
  124.                 dtStart.julian(),
  125.                 dtStart.addYears (2).julian(),
  126.                 dtStart.addYears (4).julian(),
  127.                 dtStart.addYears (6).julian(),
  128.                 dtStart.addYears (8).julian(),
  129.                 dtStart.addYears (10).julian()
  130.             },
  131.             new double[][] {
  132.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  133.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  134.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  135.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  136.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  137.                 {dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol, dblFlatVol},
  138.             },
  139.             new SegmentCustomBuilderControl (
  140.                 MultiSegmentSequenceBuilder.BASIS_SPLINE_POLYNOMIAL,
  141.                 new PolynomialFunctionSetParams (4),
  142.                 SegmentInelasticDesignControl.Create (
  143.                     2,
  144.                     2
  145.                 ),
  146.                 null,
  147.                 null
  148.             ),
  149.             new SegmentCustomBuilderControl (
  150.                 MultiSegmentSequenceBuilder.BASIS_SPLINE_POLYNOMIAL,
  151.                 new PolynomialFunctionSetParams (4),
  152.                 SegmentInelasticDesignControl.Create (
  153.                     2,
  154.                     2
  155.                 ),
  156.                 null,
  157.                 null
  158.             )
  159.         );
  160.     }

  162.     private static final MultiFactorStateEvolver HJMInstance (
  163.         final JulianDate dtStart,
  164.         final String strCurrency,
  165.         final String strTenor,
  166.         final MarketSurface mktSurfFlatVol1,
  167.         final MarketSurface mktSurfFlatVol2,
  168.         final MarketSurface mktSurfFlatVol3,
  169.         final R1ToR1 auForwardRate,
  170.         final int iNumFactor)
  171.         throws Exception
  172.     {
  173.         MultiFactorVolatility mfv = new MultiFactorVolatility (
  174.             new MarketSurface[] {
  175.                 mktSurfFlatVol1,
  176.                 mktSurfFlatVol2,
  177.                 mktSurfFlatVol3
  178.             },
  179.             new PrincipalFactorSequenceGenerator (
  180.                 new UnivariateSequenceGenerator[] {
  181.                     new BoxMullerGaussian (
  182.                         0.,
  183.                         1.
  184.                     ),
  185.                     new BoxMullerGaussian (
  186.                         0.,
  187.                         1.
  188.                     ),
  189.                     new BoxMullerGaussian (
  190.                         0.,
  191.                         1.
  192.                     )
  193.                 },
  194.                 new double[][] {
  195.                     {1.0, 0.1, 0.2},
  196.                     {0.1, 1.0, 0.2},
  197.                     {0.2, 0.1, 1.0}
  198.                 },
  199.                 iNumFactor
  200.             )
  201.         );

  203.         return new MultiFactorStateEvolver (
  204.             FundingLabel.Standard (strCurrency),
  205.             ForwardLabel.Create (
  206.                 strCurrency,
  207.                 strTenor
  208.             ),
  209.             mfv,
  210.             auForwardRate
  211.         );
  212.     }

  214.     private static final ShortForwardRateUpdate InitQMSnap (
  215.         final JulianDate dtStart,
  216.         final String strCurrency,
  217.         final String strViewTenor,
  218.         final String strTenor,
  219.         final double dblInitialForwardRate,
  220.         final double dblInitialPrice)
  221.         throws Exception
  222.     {
  223.         return ShortForwardRateUpdate.Create (
  224.             FundingLabel.Standard (strCurrency),
  225.             ForwardLabel.Create (
  226.                 strCurrency,
  227.                 strTenor
  228.             ),
  229.             dtStart.julian(),
  230.             dtStart.julian(),
  231.             dtStart.addTenor (strViewTenor).julian(),
  232.             dblInitialForwardRate,
  233.             0.,
  234.             dblInitialForwardRate,
  235.             0.,
  236.             dblInitialForwardRate + (365.25 / Helper.TenorToDays (strTenor)),
  237.             0.,
  238.             dblInitialForwardRate,
  239.             0.,
  240.             dblInitialForwardRate,
  241.             0.,
  242.             dblInitialPrice,
  243.             0.
  244.         );
  245.     }

  247.     private static final void QMEvolution (
  248.         final MultiFactorStateEvolver hjm,
  249.         final JulianDate dtStart,
  250.         final String strCurrency,
  251.         final String strViewTenor,
  252.         final ShortForwardRateUpdate qmInitial)
  253.         throws Exception
  254.     {
  255.         int iViewDate = dtStart.addTenor (strViewTenor).julian();

  257.         int iDayStep = 2;
  258.         ShortForwardRateUpdate qm = qmInitial;
  259.         JulianDate dtSpot = dtStart;

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

  263.         System.out.println ("\t|                                                                                                                               ||");

  265.         System.out.println ("\t|    Multi-Factor PCA-Based Gaussian HJM Quantification Metric Run                                                              ||");

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

  269.         System.out.println ("\t|                                                                                                                               ||");

  271.         System.out.println ("\t|        Number of Prinicipal Components: " + hjm.mfv().msg().numFactor() + "                                                                                     ||");

  273.         System.out.println ("\t|                                                                                                                               ||");

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

  277.         System.out.println ("\t|            Date                                                                                                               ||");

  279.         System.out.println ("\t|            Instantaneous Forward Rate (%)                                                                                     ||");

  281.         System.out.println ("\t|            Instantaneous Forward Rate - Change (%)                                                                            ||");

  283.         System.out.println ("\t|            LIBOR Forward Rate (%)                                                                                             ||");

  285.         System.out.println ("\t|            LIBOR Forward Rate - Change (%)                                                                                    ||");

  287.         System.out.println ("\t|            Shifted LIBOR Forward Rate (%)                                                                                     ||");

  289.         System.out.println ("\t|            Shifted LIBOR Forward Rate - Change (%)                                                                            ||");

  291.         System.out.println ("\t|            Short Rate (%)                                                                                                     ||");

  293.         System.out.println ("\t|            Short Rate - Change (%)                                                                                            ||");

  295.         System.out.println ("\t|            Continuously Compounded Short Rate (%)                                                                             ||");

  297.         System.out.println ("\t|            Continuously Compounded Short Rate - Change (%)                                                                    ||");

  299.         System.out.println ("\t|            Price                                                                                                              ||");

  301.         System.out.println ("\t|            Price - Change                                                                                                     ||");

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

  305.         while (dtSpot.julian() < iViewDate) {
  306.             int iSpotDate = dtSpot.julian();

  308.             qm = (ShortForwardRateUpdate) hjm.evolve (
  309.                 iSpotDate,
  310.                 iViewDate,
  311.                 iDayStep,
  312.                 qm
  313.             );

  315.             System.out.println ("\t| [" + dtSpot + "] = " +
  316.                 FormatUtil.FormatDouble (qm.instantaneousForwardRate(), 1, 2, 100.) + "% | " +
  317.                 FormatUtil.FormatDouble (qm.instantaneousForwardRateIncrement(), 1, 2, 100.) + "% || " +
  318.                 FormatUtil.FormatDouble (qm.liborForwardRate(), 1, 2, 100.) + "% | " +
  319.                 FormatUtil.FormatDouble (qm.liborForwardRateIncrement(), 1, 2, 100.) + "% || " +
  320.                 FormatUtil.FormatDouble (qm.shiftedLIBORForwardRate(), 1, 4, 1.) + " | " +
  321.                 FormatUtil.FormatDouble (qm.shiftedLIBORForwardRateIncrement(), 1, 2, 100.) + "% || " +
  322.                 FormatUtil.FormatDouble (qm.shortRate(), 1, 2, 100.) + "% | " +
  323.                 FormatUtil.FormatDouble (qm.shortRateIncrement(), 1, 2, 100.) + "% || " +
  324.                 FormatUtil.FormatDouble (qm.compoundedShortRate(), 1, 2, 100.) + "% | " +
  325.                 FormatUtil.FormatDouble (qm.compoundedShortRateIncrement(), 1, 2, 100.) + "% || " +
  326.                 FormatUtil.FormatDouble (qm.price(), 2, 2, 100.) + " | " +
  327.                 FormatUtil.FormatDouble (qm.priceIncrement(), 1, 2, 100.) + " || "
  328.             );

  330.             dtSpot = dtSpot.addBusDays (
  331.                 iDayStep,
  332.                 strCurrency
  333.             );
  334.         }

  336.         System.out.println ("\t|-------------------------------------------------------------------------------------------------------------------------------||");
  337.     }

  339.     public static final void main (
  340.         final String[] astrArgs)
  341.         throws Exception
  342.     {
  343.         EnvManager.InitEnv ("");

  345.         String strCurrency = "USD";
  346.         double dblFlatVol1 = 0.007;
  347.         double dblFlatVol2 = 0.009;
  348.         double dblFlatVol3 = 0.004;
  349.         double dblFlatForwardRate = 0.05;
  350.         double dblInitialPrice = 0.9875;
  351.         String strViewTenor = "3M";
  352.         String strTenor = "3M";

  354.         JulianDate dtSpot = DateUtil.Today();

  356.         MarketSurface mktSurfFlatVol1 = FlatVolatilitySurface (
  357.             dtSpot,
  358.             strCurrency,
  359.             dblFlatVol1
  360.         );

  362.         MarketSurface mktSurfFlatVol2 = FlatVolatilitySurface (
  363.             dtSpot,
  364.             strCurrency,
  365.             dblFlatVol2
  366.         );

  368.         MarketSurface mktSurfFlatVol3 = FlatVolatilitySurface (
  369.             dtSpot,
  370.             strCurrency,
  371.             dblFlatVol3
  372.         );

  374.         ShortForwardRateUpdate qmInitial = InitQMSnap (
  375.             dtSpot,
  376.             strCurrency,
  377.             strViewTenor,
  378.             strTenor,
  379.             dblFlatForwardRate,
  380.             dblInitialPrice
  381.         );

  383.         int[] aiNumFactor = new int[] {
  384.             1, 2, 3
  385.         };

  387.         for (int iNumFactor : aiNumFactor) {
  388.             MultiFactorStateEvolver hjm = HJMInstance (
  389.                 dtSpot,
  390.                 strCurrency,
  391.                 strTenor,
  392.                 mktSurfFlatVol1,
  393.                 mktSurfFlatVol2,
  394.                 mktSurfFlatVol3,
  395.                 new FlatUnivariate (dblFlatForwardRate),
  396.                 iNumFactor
  397.             );

  399.             QMEvolution (
  400.                 hjm,
  401.                 dtSpot,
  402.                 strCurrency,
  403.                 strViewTenor,
  404.                 qmInitial
  405.             );
  406.         }

  408.         EnvManager.TerminateEnv();
  409.     }
  410. }
Created with JaCoCo 0.7.9.201702052155