Gopalpur.java

  1. package org.drip.sample.bondmetrics;

  3. import org.drip.analytics.cashflow.CompositePeriod;
  4. import org.drip.analytics.date.*;
  5. import org.drip.analytics.daycount.*;
  6. import org.drip.numerical.common.FormatUtil;
  7. import org.drip.param.creator.MarketParamsBuilder;
  8. import org.drip.param.market.CurveSurfaceQuoteContainer;
  9. import org.drip.param.valuation.ValuationParams;
  10. import org.drip.product.creator.BondBuilder;
  11. import org.drip.product.credit.BondComponent;
  12. import org.drip.service.env.EnvManager;
  13. import org.drip.service.scenario.*;
  14. import org.drip.service.template.LatentMarketStateBuilder;
  15. import org.drip.state.discount.MergedDiscountForwardCurve;

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

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

  93. /**
  94.  * <i>Gopalpur</i> generates the Full Suite of Replication Metrics for a Sample Bond.
  95.  *  
  96.  * <br><br>
  97.  *  <ul>
  98.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ProductCore.md">Product Core Module</a></li>
  99.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics</a></li>
  100.  *      <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>
  101.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/bondmetrics/README.md">Bond Relative Value Replication Demonstration</a></li>
  102.  *  </ul>
  103.  * <br><br>
  104.  * 
  105.  * @author Lakshmi Krishnamurthy
  106.  */

  108. public class Gopalpur {

  110.     public static final void main (
  111.         final String[] astArgs)
  112.         throws Exception
  113.     {
  114.         EnvManager.InitEnv (
  115.             "",
  116.             true
  117.         );

  119.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  120.             2017,
  121.             DateUtil.SEPTEMBER,
  122.             20
  123.         );

  125.         String[] astrDepositTenor = new String[] {
  126.             "2D"
  127.         };

  129.         double[] adblDepositQuote = new double[] {
  130.             0.0130411 // 2D
  131.         };

  133.         double[] adblFuturesQuote = new double[] {
  134.             0.01345,    // 98.655
  135.             0.01470,    // 98.530
  136.             0.01575,    // 98.425
  137.             0.01660,    // 98.340
  138.             0.01745,    // 98.255
  139.             0.01845     // 98.155
  140.         };

  142.         String[] astrFixFloatTenor = new String[] {
  143.             "02Y",
  144.             "03Y",
  145.             "04Y",
  146.             "05Y",
  147.             "06Y",
  148.             "07Y",
  149.             "08Y",
  150.             "09Y",
  151.             "10Y",
  152.             "11Y",
  153.             "12Y",
  154.             "15Y",
  155.             "20Y",
  156.             "25Y",
  157.             "30Y",
  158.             "40Y",
  159.             "50Y"
  160.         };

  162.         String[] astrGovvieTenor = new String[] {
  163.             "1Y",
  164.             "2Y",
  165.             "3Y",
  166.             "5Y",
  167.             "7Y",
  168.             "10Y",
  169.             "20Y",
  170.             "30Y"
  171.         };

  173.         double[] adblFixFloatQuote = new double[] {
  174.             0.016410, //  2Y
  175.             0.017863, //  3Y
  176.             0.019030, //  4Y
  177.             0.020035, //  5Y
  178.             0.020902, //  6Y
  179.             0.021660, //  7Y
  180.             0.022307, //  8Y
  181.             0.022879, //  9Y
  182.             0.023363, // 10Y
  183.             0.023820, // 11Y
  184.             0.024172, // 12Y
  185.             0.024934, // 15Y
  186.             0.025581, // 20Y
  187.             0.025906, // 25Y
  188.             0.025973, // 30Y
  189.             0.025838, // 40Y
  190.             0.025560  // 50Y
  191.         };

  193.         double[] adblGovvieYield = new double[] {
  194.             0.01219, //  1Y
  195.             0.01391, //  2Y
  196.             0.01590, //  3Y
  197.             0.01937, //  5Y
  198.             0.02200, //  7Y
  199.             0.02378, // 10Y
  200.             0.02677, // 20Y
  201.             0.02927  // 30Y
  202.         };

  204.         String[] astrCreditTenor = new String[] {
  205.             "06M",
  206.             "01Y",
  207.             "02Y",
  208.             "03Y",
  209.             "04Y",
  210.             "05Y",
  211.             "07Y",
  212.             "10Y"
  213.         };

  215.         double[] adblCreditQuote = new double[] {
  216.              60.,   //  6M
  217.              68.,   //  1Y
  218.              88.,   //  2Y
  219.             102.,   //  3Y
  220.             121.,   //  4Y
  221.             138.,   //  5Y
  222.             168.,   //  7Y
  223.             188.    // 10Y
  224.         };

  226.         double dblFX = 1.;
  227.         int iSettleLag = 3;
  228.         int iCouponFreq = 2;
  229.         String strName = "Gopalpur";
  230.         double dblCleanPrice = 1.0;
  231.         double dblIssuePrice = 1.0;
  232.         String strCurrency = "USD";
  233.         double dblSpreadBump = 20.;
  234.         double dblCouponRate = 0.06875;
  235.         double dblIssueAmount = 5.25e08;
  236.         String strTreasuryCode = "UST";
  237.         String strCouponDayCount = "30/360";
  238.         double dblSpreadDurationMultiplier = 5.;

  240.         JulianDate dtEffective = DateUtil.CreateFromYMD (
  241.             2017,
  242.             2,
  243.             16
  244.         );

  246.         JulianDate dtMaturity = DateUtil.CreateFromYMD (
  247.             2025,
  248.             2,
  249.             15
  250.         );

  252.         BondComponent bond = BondBuilder.CreateSimpleFixedFP (
  253.             strName,
  254.             strCurrency,
  255.             strName,
  256.             dblCouponRate,
  257.             iCouponFreq,
  258.             strCouponDayCount,
  259.             dtEffective,
  260.             dtMaturity,
  261.             DateUtil.CreateFromYMD (
  262.                 2017,
  263.                 8,
  264.                 15
  265.             ).julian(),
  266.             DateUtil.CreateFromYMD (
  267.                 2024,
  268.                 8,
  269.                 15
  270.             ).julian(),
  271.             new DateAdjustParams (
  272.                 Convention.DATE_ROLL_FOLLOWING,
  273.                 0,
  274.                 strCurrency
  275.             ),
  276.             null,
  277.             null,
  278.             null,
  279.             null,
  280.             null,
  281.             null,
  282.             null,
  283.             null,
  284.             null
  285.         );

  287.         BondReplicator abr = BondReplicator.CorporateSenior (
  288.             dblCleanPrice,
  289.             dblIssuePrice,
  290.             dblIssueAmount,
  291.             dtSpot,
  292.             astrDepositTenor,
  293.             adblDepositQuote,
  294.             adblFuturesQuote,
  295.             astrFixFloatTenor,
  296.             adblFixFloatQuote,
  297.             dblSpreadBump,
  298.             dblSpreadDurationMultiplier,
  299.             strTreasuryCode,
  300.             astrGovvieTenor,
  301.             adblGovvieYield,
  302.             astrCreditTenor,
  303.             adblCreditQuote,
  304.             dblFX,
  305.             Double.NaN,
  306.             iSettleLag,
  307.             bond
  308.         );

  310.         BondReplicationRun abrr = abr.generateRun();

  312.         System.out.println (abrr.display());

  314.         MergedDiscountForwardCurve mdfc = LatentMarketStateBuilder.SmoothFundingCurve (
  315.             dtSpot,
  316.             strCurrency,
  317.             astrDepositTenor,
  318.             adblDepositQuote,
  319.             "ForwardRate",
  320.             adblFuturesQuote,
  321.             "ForwardRate",
  322.             astrFixFloatTenor,
  323.             adblFixFloatQuote,
  324.             "SwapRate"
  325.         );

  327.         CurveSurfaceQuoteContainer csqc = MarketParamsBuilder.Create (
  328.             mdfc,
  329.             null,
  330.             null,
  331.             null,
  332.             null,
  333.             null,
  334.             null
  335.         );

  337.         ValuationParams valParams = ValuationParams.Spot (dtSpot.julian());

  339.         System.out.println();

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

  343.         System.out.println ("\t||                                           PERIOD LABELS AND CURVE FACTORS                                          ||");

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

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

  349.         System.out.println ("\t||           - Period Start Date                                                                                      ||");

  351.         System.out.println ("\t||           - Period End Date                                                                                        ||");

  353.         System.out.println ("\t||           - Period Pay Date                                                                                        ||");

  355.         System.out.println ("\t||           - Period Credit Label                                                                                    ||");

  357.         System.out.println ("\t||           - Period Funding Label                                                                                   ||");

  359.         System.out.println ("\t||           - Period Forward Label                                                                                   ||");

  361.         System.out.println ("\t||           - Period Coupon Rate (%)                                                                                 ||");

  363.         System.out.println ("\t||           - Period Coupon Year Fraction                                                                            ||");

  365.         System.out.println ("\t||           - Period Coupon Amount                                                                                   ||");

  367.         System.out.println ("\t||           - Period Principal Amount                                                                                ||");

  369.         System.out.println ("\t||           - Period Discount Factor                                                                                 ||");

  371.         System.out.println ("\t||           - Period Survival Probability                                                                            ||");

  373.         System.out.println ("\t||           - Period Recovery                                                                                        ||");

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

  377.         for (CompositePeriod p : bond.couponPeriods()) {
  378.             int iEndDate = p.endDate();

  380.             int iPayDate = p.payDate();

  382.             int iStartDate = p.startDate();

  384.             dblCouponRate = bond.couponMetrics (
  385.                 iEndDate,
  386.                 valParams,
  387.                 csqc
  388.             ).rate();

  390.             double dblCouponDCF = p.couponDCF();

  392.             System.out.println ("\t|| " +
  393.                 DateUtil.YYYYMMDD (iStartDate) + " => " +
  394.                 DateUtil.YYYYMMDD (iEndDate) + " | " +
  395.                 DateUtil.YYYYMMDD (iPayDate) + " | ? | " +
  396.                 p.fundingLabel().fullyQualifiedName() + " | ? | " +
  397.                 FormatUtil.FormatDouble (dblCouponRate, 1, 3, 100.) + "% | " +
  398.                 FormatUtil.FormatDouble (dblCouponDCF, 1, 4, 1.) + " | " +
  399.                 FormatUtil.FormatDouble (dblCouponRate * dblCouponDCF * p.notional (iEndDate) * p.couponFactor (iEndDate), 1, 6, 1.) + " | " +
  400.                 FormatUtil.FormatDouble (p.notional (iStartDate) - p.notional (iEndDate), 1, 4, 1.) + " | " +
  401.                 FormatUtil.FormatDouble (1., 1, 4, 1.) + " | " +
  402.                 FormatUtil.FormatDouble (1., 2, 2, 100.) + "% ||"
  403.             );
  404.         }

  406.         System.out.println ("\t|| " +
  407.             DateUtil.YYYYMMDD (dtEffective.julian()) + " => " +
  408.             DateUtil.YYYYMMDD (bond.maturityDate().julian()) + " | " +
  409.             DateUtil.YYYYMMDD (bond.maturityPayDate().julian()) + " | ? | " +
  410.             bond.fundingLabel().fullyQualifiedName() + " | ? | " +
  411.             FormatUtil.FormatDouble (0., 1, 3, 100.) + "% | " +
  412.             FormatUtil.FormatDouble (0., 1, 4, 1.) + " | " +
  413.             FormatUtil.FormatDouble (0., 1, 6, 1.) + " | " +
  414.             FormatUtil.FormatDouble (bond.notional (bond.maturityDate().julian()), 1, 4, 1.) + " | " +
  415.             FormatUtil.FormatDouble (1., 1, 4, 1.) + " | " +
  416.             FormatUtil.FormatDouble (1., 2, 2, 100.) + "% ||"
  417.         );

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

  421.         EnvManager.TerminateEnv();
  422.     }
  423. }
Created with JaCoCo 0.7.9.201702052155