Rajahmundry.java

  1. package org.drip.sample.bondmetrics;

  3. import org.drip.analytics.cashflow.CompositePeriod;
  4. import org.drip.analytics.date.*;
  5. import org.drip.numerical.common.FormatUtil;
  6. import org.drip.param.creator.MarketParamsBuilder;
  7. import org.drip.param.market.CurveSurfaceQuoteContainer;
  8. import org.drip.param.valuation.ValuationParams;
  9. import org.drip.product.creator.BondBuilder;
  10. import org.drip.product.credit.BondComponent;
  11. import org.drip.product.params.EmbeddedOptionSchedule;
  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>Rajahmundry</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 Rajahmundry {

  110.     private static final void SetEOS (
  111.         final BondComponent bond,
  112.         final EmbeddedOptionSchedule eosCall,
  113.         final EmbeddedOptionSchedule eosPut)
  114.         throws java.lang.Exception
  115.     {
  116.         if (null != eosPut) bond.setEmbeddedPutSchedule (eosPut);

  118.         if (null != eosCall) bond.setEmbeddedCallSchedule (eosCall);
  119.     }

  121.     public static final void main (
  122.         final String[] astArgs)
  123.         throws Exception
  124.     {
  125.         EnvManager.InitEnv (
  126.             "",
  127.             true
  128.         );

  130.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  131.             2017,
  132.             DateUtil.JULY,
  133.             10
  134.         );

  136.         String[] astrDepositTenor = new String[] {
  137.             "2D"
  138.         };

  140.         double[] adblDepositQuote = new double[] {
  141.             0.0130411 // 2D
  142.         };

  144.         double[] adblFuturesQuote = new double[] {
  145.             0.01345,    // 98.655
  146.             0.01470,    // 98.530
  147.             0.01575,    // 98.425
  148.             0.01660,    // 98.340
  149.             0.01745,    // 98.255
  150.             0.01845     // 98.155
  151.         };

  153.         String[] astrFixFloatTenor = new String[] {
  154.             "02Y",
  155.             "03Y",
  156.             "04Y",
  157.             "05Y",
  158.             "06Y",
  159.             "07Y",
  160.             "08Y",
  161.             "09Y",
  162.             "10Y",
  163.             "11Y",
  164.             "12Y",
  165.             "15Y",
  166.             "20Y",
  167.             "25Y",
  168.             "30Y",
  169.             "40Y",
  170.             "50Y"
  171.         };

  173.         String[] astrGovvieTenor = new String[] {
  174.             "1Y",
  175.             "2Y",
  176.             "3Y",
  177.             "5Y",
  178.             "7Y",
  179.             "10Y",
  180.             "20Y",
  181.             "30Y"
  182.         };

  184.         double[] adblFixFloatQuote = new double[] {
  185.             0.016410, //  2Y
  186.             0.017863, //  3Y
  187.             0.019030, //  4Y
  188.             0.020035, //  5Y
  189.             0.020902, //  6Y
  190.             0.021660, //  7Y
  191.             0.022307, //  8Y
  192.             0.022879, //  9Y
  193.             0.023363, // 10Y
  194.             0.023820, // 11Y
  195.             0.024172, // 12Y
  196.             0.024934, // 15Y
  197.             0.025581, // 20Y
  198.             0.025906, // 25Y
  199.             0.025973, // 30Y
  200.             0.025838, // 40Y
  201.             0.025560  // 50Y
  202.         };

  204.         double[] adblGovvieYield = new double[] {
  205.             0.01219, //  1Y
  206.             0.01391, //  2Y
  207.             0.01590, //  3Y
  208.             0.01937, //  5Y
  209.             0.02200, //  7Y
  210.             0.02378, // 10Y
  211.             0.02677, // 20Y
  212.             0.02927  // 30Y
  213.         };

  215.         String[] astrCreditTenor = new String[] {
  216.             "06M",
  217.             "01Y",
  218.             "02Y",
  219.             "03Y",
  220.             "04Y",
  221.             "05Y",
  222.             "07Y",
  223.             "10Y"
  224.         };

  226.         double[] adblCreditQuote = new double[] {
  227.              60.,   //  6M
  228.              68.,   //  1Y
  229.              88.,   //  2Y
  230.             102.,   //  3Y
  231.             121.,   //  4Y
  232.             138.,   //  5Y
  233.             168.,   //  7Y
  234.             188.    // 10Y
  235.         };

  237.         double dblFX = 1.;
  238.         int iSettleLag = 3;
  239.         int iCouponFreq = 2;
  240.         String strName = "Rajahmundry";
  241.         double dblCleanPrice = 0.97;
  242.         double dblIssuePrice = 1.0;
  243.         String strCurrency = "USD";
  244.         double dblSpreadBump = 20.;
  245.         double dblCouponRate = 0.07750;
  246.         double dblIssueAmount = 5.25e08;
  247.         String strTreasuryCode = "UST";
  248.         String strCouponDayCount = "30/360";
  249.         double dblSpreadDurationMultiplier = 5.;

  251.         JulianDate dtEffective = DateUtil.CreateFromYMD (
  252.             2017,
  253.             6,
  254.             30
  255.         );

  257.         JulianDate dtMaturity = DateUtil.CreateFromYMD (
  258.             2025,
  259.             6,
  260.             15
  261.         );

  263.         BondComponent bond = BondBuilder.CreateSimpleFixedFP (
  264.             strName,
  265.             strCurrency,
  266.             strName,
  267.             dblCouponRate,
  268.             iCouponFreq,
  269.             strCouponDayCount,
  270.             dtEffective,
  271.             dtMaturity,
  272.             DateUtil.CreateFromYMD (
  273.                 2017,
  274.                 12,
  275.                 15
  276.             ).julian(),
  277.             DateUtil.CreateFromYMD (
  278.                 2024,
  279.                 12,
  280.                 15
  281.             ).julian(),
  282.             null,
  283.             null,
  284.             null,
  285.             null,
  286.             null,
  287.             null,
  288.             null,
  289.             null,
  290.             null,
  291.             null
  292.         );

  294.         SetEOS (
  295.             bond,
  296.             new EmbeddedOptionSchedule (
  297.                 new int[] {
  298.                     DateUtil.CreateFromYMD (2020, 06, 15).julian(),
  299.                     DateUtil.CreateFromYMD (2021, 06, 15).julian(),
  300.                     DateUtil.CreateFromYMD (2022, 06, 15).julian(),
  301.                     DateUtil.CreateFromYMD (2023, 06, 15).julian(),
  302.                 },
  303.                 new double[] {
  304.                     1.03875,
  305.                     1.01938,
  306.                     1.00969,
  307.                     1.00000,
  308.                 },
  309.                 false,
  310.                 15,
  311.                 false,
  312.                 Double.NaN,
  313.                 "",
  314.                 Double.NaN
  315.             ),
  316.             null
  317.         );

  319.         BondReplicator abr = BondReplicator.CorporateSenior (
  320.             dblCleanPrice,
  321.             dblIssuePrice,
  322.             dblIssueAmount,
  323.             dtSpot,
  324.             astrDepositTenor,
  325.             adblDepositQuote,
  326.             adblFuturesQuote,
  327.             astrFixFloatTenor,
  328.             adblFixFloatQuote,
  329.             dblSpreadBump,
  330.             dblSpreadDurationMultiplier,
  331.             strTreasuryCode,
  332.             astrGovvieTenor,
  333.             adblGovvieYield,
  334.             astrCreditTenor,
  335.             adblCreditQuote,
  336.             dblFX,
  337.             Double.NaN,
  338.             iSettleLag,
  339.             bond
  340.         );

  342.         BondReplicationRun abrr = abr.generateRun();

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

  346.         MergedDiscountForwardCurve mdfc = LatentMarketStateBuilder.SmoothFundingCurve (
  347.             dtSpot,
  348.             strCurrency,
  349.             astrDepositTenor,
  350.             adblDepositQuote,
  351.             "ForwardRate",
  352.             adblFuturesQuote,
  353.             "ForwardRate",
  354.             astrFixFloatTenor,
  355.             adblFixFloatQuote,
  356.             "SwapRate"
  357.         );

  359.         CurveSurfaceQuoteContainer csqc = MarketParamsBuilder.Create (
  360.             mdfc,
  361.             null,
  362.             null,
  363.             null,
  364.             null,
  365.             null,
  366.             null
  367.         );

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

  371.         System.out.println();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  405.         for (CompositePeriod p : bond.couponPeriods()) {
  406.             int iEndDate = p.endDate();

  408.             int iPayDate = p.payDate();

  410.             int iStartDate = p.startDate();

  412.             dblCouponRate = bond.couponMetrics (
  413.                 iPayDate,
  414.                 valParams,
  415.                 csqc
  416.             ).rate();

  418.             double dblCouponDCF = p.couponDCF();

  420.             System.out.println ("\t|| " +
  421.                 DateUtil.YYYYMMDD (iStartDate) + " => " +
  422.                 DateUtil.YYYYMMDD (iEndDate) + " | ? | " +
  423.                 p.fundingLabel().fullyQualifiedName() + " | NONE | " +
  424.                 FormatUtil.FormatDouble (dblCouponRate, 1, 2, 100.) + "% | " +
  425.                 FormatUtil.FormatDouble (dblCouponDCF, 1, 4, 1.) + " | " +
  426.                 FormatUtil.FormatDouble (dblCouponRate * dblCouponDCF * p.notional (iEndDate) * p.couponFactor (iEndDate), 1, 4, 1.) + " | " +
  427.                 FormatUtil.FormatDouble (p.notional (iStartDate) - p.notional (iEndDate), 1, 4, 1.) + " | " +
  428.                 FormatUtil.FormatDouble (1., 1, 4, 1.) + " | " +
  429.                 FormatUtil.FormatDouble (1., 2, 2, 100.) + "% ||"
  430.             );
  431.         }

  433.         System.out.println ("\t|| " +
  434.             DateUtil.YYYYMMDD (dtEffective.julian()) + " => " +
  435.             DateUtil.YYYYMMDD (dtMaturity.julian()) + " | ? | " +
  436.             bond.fundingLabel().fullyQualifiedName() + " | NONE | " +
  437.             FormatUtil.FormatDouble (0., 1, 2, 100.) + "% | " +
  438.             FormatUtil.FormatDouble (0., 1, 4, 1.) + " | " +
  439.             FormatUtil.FormatDouble (0., 1, 4, 1.) + " | " +
  440.             FormatUtil.FormatDouble (bond.notional (dtMaturity.julian()), 1, 4, 1.) + " | " +
  441.             FormatUtil.FormatDouble (mdfc.df (dtMaturity), 1, 4, 1.) + " | " +
  442.             FormatUtil.FormatDouble (1., 1, 4, 1.) + " | " +
  443.             FormatUtil.FormatDouble (1., 2, 2, 100.) + "% ||"
  444.         );

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

  448.         EnvManager.TerminateEnv();
  449.     }
  450. }
Created with JaCoCo 0.7.9.201702052155