DiscountCurveJacobianRegressorSet.java

  1. package org.drip.regression.curvejacobian;

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

  83. /**
  84.  * <i>DiscountCurveJacobianRegressorSet</i> implements the regression analysis for the full discount curve
  85.  * (built from cash/future/swap) Sensitivity Jacobians. Specifically, it computes the PVDF micro-Jack.
  86.  * 
  87.  * <br><br>
  88.  *  <ul>
  89.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  90.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationSupportLibrary.md">Computation Support</a></li>
  91.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/regression/README.md">Regression Engine Core and the Unit Regressors</a></li>
  92.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/regression/curvejacobian/README.md">Curve Jacobian Reconciliation Regression Engine</a></li>
  93.  *  </ul>
  94.  * <br><br>
  95.  *
  96.  * @author Lakshmi Krishnamurthy
  97.  */

  99. public class DiscountCurveJacobianRegressorSet implements org.drip.regression.core.RegressorSet {
  100.     private java.lang.String _strRegressionScenario =
  101.         "org.drip.analytics.definition.IRSDiscountCurve.CompPVDFJacobian";

  103.     private java.util.List<org.drip.regression.core.UnitRegressor> _setRegressors = new
  104.         java.util.ArrayList<org.drip.regression.core.UnitRegressor>();

  106.     @Override public java.util.List<org.drip.regression.core.UnitRegressor> getRegressorSet()
  107.     {
  108.         return _setRegressors;
  109.     }

  111.     @Override public boolean setupRegressors()
  112.     {
  113.         try {
  114.             _setRegressors.add (new org.drip.regression.core.UnitRegressionExecutor ("DiscountCurveJacobian",
  115.                 _strRegressionScenario)
  116.             {
  117.                 org.drip.analytics.date.JulianDate dtStart = null;
  118.                 org.drip.state.discount.MergedDiscountForwardCurve dcIRS = null;
  119.                 org.drip.numerical.differentiation.WengertJacobian wjPVDF = null;
  120.                 org.drip.numerical.differentiation.WengertJacobian aWJComp[] = null;
  121.                 org.drip.product.definition.CalibratableComponent aCompCalib[] = null;

  123.                 org.drip.param.market.LatentStateFixingsContainer lsfc = new
  124.                     org.drip.param.market.LatentStateFixingsContainer();

  126.                 @Override public boolean preRegression()
  127.                 {
  128.                     int NUM_DC_INSTR = 15;
  129.                     int aiDate[] = new int[NUM_DC_INSTR];
  130.                     double adblRate[] = new double[NUM_DC_INSTR];
  131.                     double adblCompCalibValue[] = new double[NUM_DC_INSTR];
  132.                     aWJComp = new org.drip.numerical.differentiation.WengertJacobian[NUM_DC_INSTR];
  133.                     java.lang.String astrCalibMeasure[] = new java.lang.String[NUM_DC_INSTR];
  134.                     aCompCalib = new org.drip.product.definition.CalibratableComponent[NUM_DC_INSTR];

  136.                     if (null == (dtStart = org.drip.analytics.date.DateUtil.CreateFromYMD (2011, 4, 6)))
  137.                         return false;

  139.                     aiDate[0] = dtStart.addDays ((int)(365.25 * 1 + 2)).julian(); // 4Y

  141.                     aiDate[1] = dtStart.addDays ((int)(365.25 * 2 + 2)).julian(); // 5Y

  143.                     aiDate[2] = dtStart.addDays ((int)(365.25 * 3 + 2)).julian(); // 6Y

  145.                     aiDate[3] = dtStart.addDays ((int)(365.25 * 7 + 2)).julian(); // 7Y

  147.                     aiDate[4] = dtStart.addDays ((int)(365.25 * 8 + 2)).julian(); // 8Y

  149.                     aiDate[5] = dtStart.addDays ((int)(365.25 * 9 + 2)).julian(); // 9Y

  151.                     aiDate[6] = dtStart.addDays ((int)(365.25 * 10 + 2)).julian(); // 10Y

  153.                     aiDate[7] = dtStart.addDays ((int)(365.25 * 11 + 2)).julian(); // 11Y

  155.                     aiDate[8] = dtStart.addDays ((int)(365.25 * 12 + 2)).julian(); // 12Y

  157.                     aiDate[9] = dtStart.addDays ((int)(365.25 * 15 + 2)).julian(); // 15Y

  159.                     aiDate[10] = dtStart.addDays ((int)(365.25 * 20 + 2)).julian(); // 20Y

  161.                     aiDate[11] = dtStart.addDays ((int)(365.25 * 25 + 2)).julian(); // 25Y

  163.                     aiDate[12] = dtStart.addDays ((int)(365.25 * 30 + 2)).julian(); // 30Y

  165.                     aiDate[13] = dtStart.addDays ((int)(365.25 * 40 + 2)).julian(); // 40Y

  167.                     aiDate[14] = dtStart.addDays ((int)(365.25 * 50 + 2)).julian(); // 50Y

  169.                     adblCompCalibValue[0] = .0166;
  170.                     adblCompCalibValue[1] = .0206;
  171.                     adblCompCalibValue[2] = .0241;
  172.                     adblCompCalibValue[3] = .0269;
  173.                     adblCompCalibValue[4] = .0292;
  174.                     adblCompCalibValue[5] = .0311;
  175.                     adblCompCalibValue[6] = .0326;
  176.                     adblCompCalibValue[7] = .0340;
  177.                     adblCompCalibValue[8] = .0351;
  178.                     adblCompCalibValue[9] = .0375;
  179.                     adblCompCalibValue[10] = .0393;
  180.                     adblCompCalibValue[11] = .0402;
  181.                     adblCompCalibValue[12] = .0407;
  182.                     adblCompCalibValue[13] = .0409;
  183.                     adblCompCalibValue[14] = .0409;
  184.                     org.drip.param.period.CompositePeriodSetting cpsFixed = null;
  185.                     org.drip.param.period.CompositePeriodSetting cpsFloating = null;
  186.                     org.drip.param.period.UnitCouponAccrualSetting ucasFixed = null;
  187.                     org.drip.param.period.ComposableFixedUnitSetting cfusFixed = null;
  188.                     org.drip.param.period.ComposableFloatingUnitSetting cfusFloating = null;

  190.                     try {
  191.                         ucasFixed = new org.drip.param.period.UnitCouponAccrualSetting (2, "Act/360", false,
  192.                             "Act/360", false, "USD", true,
  193.                                 org.drip.analytics.support.CompositePeriodBuilder.ACCRUAL_COMPOUNDING_RULE_GEOMETRIC);

  195.                         cfusFloating = new org.drip.param.period.ComposableFloatingUnitSetting ("3M",
  196.                             org.drip.analytics.support.CompositePeriodBuilder.EDGE_DATE_SEQUENCE_SINGLE,
  197.                                 null, org.drip.state.identifier.ForwardLabel.Standard ("USD-3M"),
  198.                                     org.drip.analytics.support.CompositePeriodBuilder.REFERENCE_PERIOD_IN_ADVANCE,
  199.                             0.);

  201.                         cfusFixed = new org.drip.param.period.ComposableFixedUnitSetting ("6M",
  202.                             org.drip.analytics.support.CompositePeriodBuilder.EDGE_DATE_SEQUENCE_REGULAR,
  203.                                 null, 0., 0., "USD");

  205.                         cpsFloating = new org.drip.param.period.CompositePeriodSetting (4, "3M", "USD", null,
  206.                             -1., null, null, null, null);

  208.                         cpsFixed = new org.drip.param.period.CompositePeriodSetting (2, "6M", "USD", null,
  209.                             1., null, null, null, null);
  210.                     } catch (java.lang.Exception e) {
  211.                         e.printStackTrace();

  213.                         return false;
  214.                     }

  216.                     for (int i = 0; i < NUM_DC_INSTR; ++i) {
  217.                         adblRate[i] = 0.01;
  218.                         astrCalibMeasure[i] = "Rate";

  220.                         try {
  221.                             java.util.List<java.lang.Integer> lsFixedStreamEdgeDate =
  222.                                 org.drip.analytics.support.CompositePeriodBuilder.BackwardEdgeDates (dtStart,
  223.                                     new org.drip.analytics.date.JulianDate (aiDate[i]), "6M", null,
  224.                                         org.drip.analytics.support.CompositePeriodBuilder.SHORT_STUB);

  226.                             java.util.List<java.lang.Integer> lsFloatingStreamEdgeDate =
  227.                                 org.drip.analytics.support.CompositePeriodBuilder.BackwardEdgeDates (dtStart,
  228.                                     new org.drip.analytics.date.JulianDate (aiDate[i]), "3M", null,
  229.                                         org.drip.analytics.support.CompositePeriodBuilder.SHORT_STUB);

  231.                             org.drip.product.rates.Stream floatingStream = new org.drip.product.rates.Stream
  232.                                 (org.drip.analytics.support.CompositePeriodBuilder.FloatingCompositeUnit
  233.                                     (lsFloatingStreamEdgeDate, cpsFloating, cfusFloating));

  235.                             org.drip.product.rates.Stream fixedStream = new org.drip.product.rates.Stream
  236.                                 (org.drip.analytics.support.CompositePeriodBuilder.FixedCompositeUnit
  237.                                     (lsFixedStreamEdgeDate, cpsFixed, ucasFixed, cfusFixed));


  240.                             aCompCalib[i] = new org.drip.product.rates.FixFloatComponent (fixedStream,
  241.                                 floatingStream, null);
  242.                         } catch (java.lang.Exception e) {
  243.                             e.printStackTrace();

  245.                             return false;
  246.                         }
  247.                     }

  249.                     lsfc.add (dtStart.addDays (2), org.drip.state.identifier.ForwardLabel.Standard
  250.                         ("USD-6M"), 0.0042);

  252.                     return null != (dcIRS =
  253.                         org.drip.state.creator.ScenarioDiscountCurveBuilder.NonlinearBuild (dtStart, "USD",
  254.                             aCompCalib, adblCompCalibValue, astrCalibMeasure, lsfc));
  255.                 }

  257.                 @Override public boolean execRegression()
  258.                 {
  259.                     for (int i = 0; i < aCompCalib.length; ++i) {
  260.                         try {
  261.                             if (null == (aWJComp[i] = aCompCalib[i].jackDDirtyPVDManifestMeasure (new
  262.                                 org.drip.param.valuation.ValuationParams (dtStart, dtStart, "USD"), null,
  263.                                     org.drip.param.creator.MarketParamsBuilder.Create (dcIRS, null, null,
  264.                                         null, null, null, lsfc), null)))
  265.                                 return false;
  266.                         } catch (java.lang.Exception e) {
  267.                             e.printStackTrace();

  269.                             return false;
  270.                         }
  271.                     }

  273.                     return null != (wjPVDF = dcIRS.compJackDPVDManifestMeasure (dtStart));
  274.                 }

  276.                 @Override public boolean postRegression (
  277.                     final org.drip.regression.core.RegressionRunDetail rnvd)
  278.                 {
  279.                     for (int i = 0; i < aCompCalib.length; ++i) {
  280.                         if (!rnvd.set ("PVDFMicroJack_" + aCompCalib[i].name(), aWJComp[i].displayString()))
  281.                             return false;
  282.                     }

  284.                     return rnvd.set ("CompPVDFJacobian", wjPVDF.displayString());
  285.                 }
  286.             });
  287.         } catch (java.lang.Exception e) {
  288.             e.printStackTrace();
  289.         }

  291.         return true;
  292.     }

  294.     @Override public java.lang.String getSetName()
  295.     {
  296.         return _strRegressionScenario;
  297.     }
  298. }
Created with JaCoCo 0.7.9.201702052155