ZeroCouponBullet3.java

  1. package org.drip.sample.sovereign;

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

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

  20. /*!
  21.  * Copyright (C) 2018 Lakshmi Krishnamurthy
  22.  * Copyright (C) 2017 Lakshmi Krishnamurthy
  23.  * 
  24.  *  This file is part of DRIP, a free-software/open-source library for buy/side financial/trading model
  25.  *      libraries targeting analysts and developers
  26.  *      https://lakshmidrip.github.io/DRIP/
  27.  *  
  28.  *  DRIP is composed of four main libraries:
  29.  *  
  30.  *  - DRIP Fixed Income - https://lakshmidrip.github.io/DRIP-Fixed-Income/
  31.  *  - DRIP Asset Allocation - https://lakshmidrip.github.io/DRIP-Asset-Allocation/
  32.  *  - DRIP Numerical Optimizer - https://lakshmidrip.github.io/DRIP-Numerical-Optimizer/
  33.  *  - DRIP Statistical Learning - https://lakshmidrip.github.io/DRIP-Statistical-Learning/
  34.  * 
  35.  *  - DRIP Fixed Income: Library for Instrument/Trading Conventions, Treasury Futures/Options,
  36.  *      Funding/Forward/Overnight Curves, Multi-Curve Construction/Valuation, Collateral Valuation and XVA
  37.  *      Metric Generation, Calibration and Hedge Attributions, Statistical Curve Construction, Bond RV
  38.  *      Metrics, Stochastic Evolution and Option Pricing, Interest Rate Dynamics and Option Pricing, LMM
  39.  *      Extensions/Calibrations/Greeks, Algorithmic Differentiation, and Asset Backed Models and Analytics.
  40.  * 
  41.  *  - DRIP Asset Allocation: Library for model libraries for MPT framework, Black Litterman Strategy
  42.  *      Incorporator, Holdings Constraint, and Transaction Costs.
  43.  * 
  44.  *  - DRIP Numerical Optimizer: Library for Numerical Optimization and Spline Functionality.
  45.  * 
  46.  *  - DRIP Statistical Learning: Library for Statistical Evaluation and Machine Learning.
  47.  * 
  48.  *  Licensed under the Apache License, Version 2.0 (the "License");
  49.  *      you may not use this file except in compliance with the License.
  50.  *   
  51.  *  You may obtain a copy of the License at
  52.  *      http://www.apache.org/licenses/LICENSE-2.0
  53.  *  
  54.  *  Unless required by applicable law or agreed to in writing, software
  55.  *      distributed under the License is distributed on an "AS IS" BASIS,
  56.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  57.  *  
  58.  *  See the License for the specific language governing permissions and
  59.  *      limitations under the License.
  60.  */

  62. /**
  63.  * ZeroCouponBullet3 demonstrates Non-EOS Zero Coupon Multi-flavor Bond Pricing and Relative Value Measure
  64.  *  Generation Functionality.
  65.  * 
  66.  * @author Lakshmi Krishnamurthy
  67.  */

  69. public class ZeroCouponBullet3 {

  71.     private static final MergedDiscountForwardCurve FundingCurve (
  72.         final JulianDate dtSpot,
  73.         final String strCurrency,
  74.         final double dblBump)
  75.         throws Exception
  76.     {
  77.         String[] astrDepositMaturityTenor = new String[] {
  78.             "2D"
  79.         };

  81.         double[] adblDepositQuote = new double[] {
  82.             0.0111956 + dblBump // 2D
  83.         };

  85.         double[] adblFuturesQuote = new double[] {
  86.             0.011375 + dblBump, // 98.8625
  87.             0.013350 + dblBump, // 98.6650
  88.             0.014800 + dblBump, // 98.5200
  89.             0.016450 + dblBump, // 98.3550
  90.             0.017850 + dblBump, // 98.2150
  91.             0.019300 + dblBump  // 98.0700
  92.         };

  94.         String[] astrFixFloatMaturityTenor = new String[] {
  95.             "02Y",
  96.             "03Y",
  97.             "04Y",
  98.             "05Y",
  99.             "06Y",
  100.             "07Y",
  101.             "08Y",
  102.             "09Y",
  103.             "10Y",
  104.             "11Y",
  105.             "12Y",
  106.             "15Y",
  107.             "20Y",
  108.             "25Y",
  109.             "30Y",
  110.             "40Y",
  111.             "50Y"
  112.         };

  114.         double[] adblFixFloatQuote = new double[] {
  115.             0.017029 + dblBump, //  2Y
  116.             0.019354 + dblBump, //  3Y
  117.             0.021044 + dblBump, //  4Y
  118.             0.022291 + dblBump, //  5Y
  119.             0.023240 + dblBump, //  6Y
  120.             0.024025 + dblBump, //  7Y
  121.             0.024683 + dblBump, //  8Y
  122.             0.025243 + dblBump, //  9Y
  123.             0.025720 + dblBump, // 10Y
  124.             0.026130 + dblBump, // 11Y
  125.             0.026495 + dblBump, // 12Y
  126.             0.027230 + dblBump, // 15Y
  127.             0.027855 + dblBump, // 20Y
  128.             0.028025 + dblBump, // 25Y
  129.             0.028028 + dblBump, // 30Y
  130.             0.027902 + dblBump, // 40Y
  131.             0.027655 + dblBump  // 50Y
  132.         };

  134.         MergedDiscountForwardCurve dcFunding = LatentMarketStateBuilder.SmoothFundingCurve (
  135.             dtSpot,
  136.             strCurrency,
  137.             astrDepositMaturityTenor,
  138.             adblDepositQuote,
  139.             "ForwardRate",
  140.             adblFuturesQuote,
  141.             "ForwardRate",
  142.             astrFixFloatMaturityTenor,
  143.             adblFixFloatQuote,
  144.             "SwapRate"
  145.         );

  147.         Component[] aDepositComp = OTCInstrumentBuilder.FundingDeposit (
  148.             dtSpot,
  149.             strCurrency,
  150.             astrDepositMaturityTenor
  151.         );

  153.         Component[] aFuturesComp = ExchangeInstrumentBuilder.ForwardRateFuturesPack (
  154.             dtSpot,
  155.             adblFuturesQuote.length,
  156.             strCurrency
  157.         );

  159.         Component[] aFixFloatComp = OTCInstrumentBuilder.FixFloatStandard (
  160.             dtSpot,
  161.             strCurrency,
  162.             "ALL",
  163.             astrFixFloatMaturityTenor,
  164.             "MAIN",
  165.             0.
  166.         );

  168.         ValuationParams valParams = new ValuationParams (
  169.             dtSpot,
  170.             dtSpot,
  171.             strCurrency
  172.         );

  174.         CurveSurfaceQuoteContainer csqc = MarketParamsBuilder.Create (
  175.             dcFunding,
  176.             null,
  177.             null,
  178.             null,
  179.             null,
  180.             null,
  181.             null
  182.         );

  184.         System.out.println();

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

  188.         System.out.println ("\t|        DEPOSIT INPUT vs. CALC       ||");

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

  192.         for (int i = 0; i < aDepositComp.length; ++i)
  193.             System.out.println ("\t| [" + aDepositComp[i].maturityDate() + "] =" +
  194.                 FormatUtil.FormatDouble (aDepositComp[i].measureValue (
  195.                     valParams,
  196.                     null,
  197.                     csqc,
  198.                     null,
  199.                     "ForwardRate"
  200.                 ), 1, 6, 1.) + " |" +
  201.                 FormatUtil.FormatDouble (adblDepositQuote[i], 1, 6, 1.) + " ||"
  202.             );

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

  206.         System.out.println();

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

  210.         System.out.println ("\t|        FUTURES INPUT vs. CALC       ||");

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

  214.         for (int i = 0; i < aFuturesComp.length; ++i)
  215.             System.out.println ("\t| [" + aFuturesComp[i].maturityDate() + "] =" +
  216.                 FormatUtil.FormatDouble (aFuturesComp[i].measureValue (
  217.                     valParams,
  218.                     null,
  219.                     csqc,
  220.                     null,
  221.                     "ForwardRate"
  222.                 ), 1, 6, 1.) + " |" +
  223.                 FormatUtil.FormatDouble (adblFuturesQuote[i], 1, 6, 1.) + " ||"
  224.             );

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

  228.         System.out.println();

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

  232.         System.out.println ("\t|          FIX-FLOAT INPUTS vs CALIB             ||");

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

  236.         for (int i = 0; i < aFixFloatComp.length; ++i)
  237.             System.out.println ("\t| [" + aFixFloatComp[i].maturityDate() + "] =" +
  238.                 FormatUtil.FormatDouble (aFixFloatComp[i].measureValue (
  239.                     valParams,
  240.                     null,
  241.                     csqc,
  242.                     null,
  243.                     "CalibSwapRate"
  244.                 ), 1, 6, 1.) + " |" +
  245.                 FormatUtil.FormatDouble (adblFixFloatQuote[i], 1, 6, 1.) + " |" +
  246.                 FormatUtil.FormatDouble (aFixFloatComp[i].measureValue (
  247.                     valParams,
  248.                     null,
  249.                     csqc,
  250.                     null,
  251.                     "FairPremium"
  252.                 ), 1, 6, 1.) + " ||"
  253.             );

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

  257.         System.out.println();

  259.         return dcFunding;
  260.     }

  262.     private static final GovvieCurve GovvieCurve (
  263.         final JulianDate dtSpot,
  264.         final String strCode,
  265.         final double[] adblCoupon,
  266.         final double[] adblYield)
  267.         throws Exception
  268.     {
  269.         JulianDate[] adtEffective = new JulianDate[] {
  270.             dtSpot,
  271.             dtSpot,
  272.             dtSpot,
  273.             dtSpot,
  274.             dtSpot,
  275.             dtSpot,
  276.             dtSpot,
  277.             dtSpot
  278.         };

  280.         JulianDate[] adtMaturity = new JulianDate[] {
  281.             dtSpot.addTenor ("1Y"),
  282.             dtSpot.addTenor ("2Y"),
  283.             dtSpot.addTenor ("3Y"),
  284.             dtSpot.addTenor ("5Y"),
  285.             dtSpot.addTenor ("7Y"),
  286.             dtSpot.addTenor ("10Y"),
  287.             dtSpot.addTenor ("20Y"),
  288.             dtSpot.addTenor ("30Y")
  289.         };

  291.         GovvieCurve gc = LatentMarketStateBuilder.GovvieCurve (
  292.             strCode,
  293.             dtSpot,
  294.             adtEffective,
  295.             adtMaturity,
  296.             adblCoupon,
  297.             adblYield,
  298.             "Yield",
  299.             LatentMarketStateBuilder.SHAPE_PRESERVING
  300.         );

  302.         BondComponent[] aComp = TreasuryBuilder.FromCode (
  303.             strCode,
  304.             adtEffective,
  305.             adtMaturity,
  306.             adblCoupon
  307.         );

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

  311.         CurveSurfaceQuoteContainer csqc = new CurveSurfaceQuoteContainer();

  313.         csqc.setGovvieState (gc);

  315.         System.out.println();

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

  319.         System.out.println ("\t|       TREASURY INPUT vs CALIB YIELD       ||");

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

  323.         for (int i = 0; i < aComp.length; ++i)
  324.             System.out.println ("\t| " + aComp[i].name() + " | " +
  325.                 FormatUtil.FormatDouble (adblYield[i], 1, 3, 100.) + "% | " +
  326.                 FormatUtil.FormatDouble (aComp[i].yieldFromPrice (
  327.                     valParams,
  328.                     null,
  329.                     null,
  330.                     aComp[i].maturityDate().julian(),
  331.                     1.,
  332.                     aComp[i].priceFromYield (
  333.                         valParams,
  334.                         null,
  335.                         null,
  336.                         gc.yield (aComp[i].maturityDate().julian())
  337.                     )
  338.                 ), 1, 3, 100.) + "% ||"
  339.             );

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

  343.         return gc;
  344.     }

  346.     private static final BondComponent Zero (
  347.         final String strCUSIP,
  348.         final JulianDate dtEffective,
  349.         final JulianDate dtMaturity,
  350.         final String strDayCount)
  351.         throws Exception
  352.     {
  353.         return BondBuilder.CreateSimpleFixed (
  354.             strCUSIP,
  355.             "USD",
  356.             "",
  357.             0.,
  358.             2,
  359.             strDayCount,
  360.             dtEffective,
  361.             dtMaturity,
  362.             null,
  363.             null
  364.         );
  365.     }

  367.     private static final void RVMeasures (
  368.         final BondComponent[] aBond,
  369.         final JulianDate dtValue,
  370.         final CurveSurfaceQuoteContainer csqc,
  371.         final double[] adblCleanPrice)
  372.         throws Exception
  373.     {
  374.         JulianDate dtSettle = dtValue.addBusDays (
  375.             3,
  376.             aBond[0].currency()
  377.         );

  379.         ValuationParams valParams = new ValuationParams (
  380.             dtValue,
  381.             dtSettle,
  382.             aBond[0].currency()
  383.         );

  385.         System.out.println();

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

  389.         System.out.println ("\t| Trade Date       : " + dtValue + " ||");

  391.         System.out.println ("\t| Cash Settle Date : " + dtSettle + " ||");

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

  395.         System.out.println();

  397.         String strSecularMetrics = "";

  399.         for (int i = 0; i < aBond.length; ++i) {
  400.             double dblOAS = Double.NaN;
  401.             double dblYTM = Double.NaN;
  402.             double dblYTW = Double.NaN;
  403.             double dblWALTM = Double.NaN;
  404.             double dblWALTW = Double.NaN;
  405.             double dblDiscountMargin = Double.NaN;
  406.             double dblModifiedDurationTW = Double.NaN;

  408.             try {
  409.                 WorkoutInfo wi = aBond[i].exerciseYieldFromPrice (
  410.                     valParams,
  411.                     csqc,
  412.                     null,
  413.                     adblCleanPrice[i]
  414.                 );

  416.                 dblYTW = wi.yield();

  418.                 dblYTM = aBond[i].yieldFromPrice (
  419.                     valParams,
  420.                     csqc,
  421.                     null,
  422.                     aBond[i].maturityDate().julian(),
  423.                     1.,
  424.                     adblCleanPrice[i]
  425.                 );

  427.                 dblWALTW = aBond[i].weightedAverageLife (
  428.                     valParams,
  429.                     csqc,
  430.                     wi.date(),
  431.                     wi.factor()
  432.                 );

  434.                 dblWALTM = aBond[i].weightedAverageLife (
  435.                     valParams,
  436.                     csqc,
  437.                     aBond[i].maturityDate().julian(),
  438.                     1.
  439.                 );

  441.                 dblDiscountMargin = aBond[i].discountMarginFromYield (
  442.                     valParams,
  443.                     csqc,
  444.                     null,
  445.                     wi.date(),
  446.                     wi.factor(),
  447.                     wi.yield()
  448.                 );

  450.                 dblOAS = aBond[i].oasFromYield (
  451.                     valParams,
  452.                     csqc,
  453.                     null,
  454.                     wi.date(),
  455.                     wi.factor(),
  456.                     wi.yield()
  457.                 );

  459.                 dblModifiedDurationTW = aBond[i].modifiedDurationFromPrice (
  460.                     valParams,
  461.                     csqc,
  462.                     null,
  463.                     wi.date(),
  464.                     wi.factor(),
  465.                     adblCleanPrice[i]
  466.                 );
  467.             } catch (Exception e) {
  468.                 // e.printStackTrace();
  469.             }

  471.             strSecularMetrics +=
  472.                 aBond[i].name() + "," +
  473.                 aBond[i].effectiveDate() + "," +
  474.                 aBond[i].maturityDate() + "," +
  475.                 FormatUtil.FormatDouble (adblCleanPrice[i], 3, 3, 100.) + "," +
  476.                 FormatUtil.FormatDouble (0., 1, 4, 100.) + "," +
  477.                 FormatUtil.FormatDouble (dblYTW, 1, 3, 100.) + "%," +
  478.                 FormatUtil.FormatDouble (dblYTM, 1, 3, 100.) + "%," +
  479.                 FormatUtil.FormatDouble (dblWALTW, 1, 3, 1.) + "," +
  480.                 FormatUtil.FormatDouble (dblWALTM, 1, 3, 1.) + "," +
  481.                 FormatUtil.FormatDouble (dblModifiedDurationTW, 1, 4, 10000.) + "," +
  482.                 FormatUtil.FormatDouble (dblDiscountMargin, 1, 3, 10000.) + "," +
  483.                 FormatUtil.FormatDouble (dblOAS, 1, 3, 10000.) + "\n";
  484.         }

  486.         System.out.println
  487.             ("Bond, Issue, Maturity, Clean Price, Accrued, Yield TW, Yield TM, WAL TW, WAL TM, Duration TW, Discount Margin TW, OAS TW");

  489.         System.out.print (strSecularMetrics);
  490.     }

  492.     public static final void main (
  493.         final String[] astrArgs)
  494.         throws Exception
  495.     {
  496.         EnvManager.InitEnv ("");

  498.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  499.             2017,
  500.             DateUtil.MARCH,
  501.             10
  502.         );

  504.         String strCurrency = "USD";
  505.         String strTreasuryCode = "UST";

  507.         double[] adblTreasuryCoupon = new double[] {
  508.             0.0100,
  509.             0.0100,
  510.             0.0125,
  511.             0.0150,
  512.             0.0200,
  513.             0.0225,
  514.             0.0250,
  515.             0.0300
  516.         };

  518.         double[] adblTreasuryYield = new double[] {
  519.             0.0083, //  1Y
  520.             0.0122, //  2Y
  521.             0.0149, //  3Y
  522.             0.0193, //  5Y
  523.             0.0227, //  7Y
  524.             0.0248, // 10Y
  525.             0.0280, // 20Y
  526.             0.0308  // 30Y
  527.         };

  529.         BondComponent[] aZeroBond = new BondComponent[] {
  530.             Zero ("20772GF78", DateUtil.CreateFromYMD (2008,  4, 30), DateUtil.CreateFromYMD (2022,  3, 15), "US MUNI: 30/360"),
  531.             Zero ("20772GF86", DateUtil.CreateFromYMD (2008,  4, 30), DateUtil.CreateFromYMD (2023,  3, 15), "US MUNI: 30/360"),
  532.             Zero ("20772GF94", DateUtil.CreateFromYMD (2008,  4, 30), DateUtil.CreateFromYMD (2024,  3, 15), "US MUNI: 30/360"),
  533.             Zero ("20772GG28", DateUtil.CreateFromYMD (2008,  4, 30), DateUtil.CreateFromYMD (2025,  3, 15), "US MUNI: 30/360"),
  534.             Zero ("646136ES6", DateUtil.CreateFromYMD (2006,  6,  1), DateUtil.CreateFromYMD (2029, 12, 15), "US MUNI: 30/360"),
  535.             Zero ("646136EV9", DateUtil.CreateFromYMD (2006,  6,  1), DateUtil.CreateFromYMD (2032, 12, 15), "US MUNI: 30/360"),
  536.             Zero ("70870EBM0", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2033,  1,  1), "US MUNI: 30/360"),
  537.             Zero ("70870EBM0", DateUtil.CreateFromYMD (2008,  6, 26), DateUtil.CreateFromYMD (2033,  2,  1), "US MUNI: 30/360"),
  538.             Zero ("646136EW7", DateUtil.CreateFromYMD (2006,  6,  1), DateUtil.CreateFromYMD (2033, 12, 15), "US MUNI: 30/360"),
  539.             Zero ("66285WCA2", DateUtil.CreateFromYMD (2008,  4,  3), DateUtil.CreateFromYMD (2035,  1,  1), "US MUNI: 30/360"),
  540.             Zero ("70870EBS7", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2038,  1,  1), "US MUNI: 30/360"),
  541.             Zero ("70870EBT5", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2039,  1,  1), "US MUNI: 30/360"),
  542.             Zero ("70870EBU2", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2040,  1,  1), "US MUNI: 30/360"),
  543.             Zero ("70870EBZ1", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2045,  1,  1), "US MUNI: 30/360"),
  544.             Zero ("70870EDF3", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2045,  1,  1), "US MUNI: 30/360"),
  545.             Zero ("70870ECA5", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2046,  1,  1), "US MUNI: 30/360"),
  546.             Zero ("70870EDG1", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2046,  1,  1), "US MUNI: 30/360"),
  547.             Zero ("70870EDJ5", DateUtil.CreateFromYMD (2013, 12, 23), DateUtil.CreateFromYMD (2047,  1,  1), "US MUNI: 30/360"),
  548.         };

  550.         double[] adblCleanPrice = new double[] {
  551.             0.8738610,  // (2022,  3, 15)
  552.             0.8387205,  // (2023,  3, 15)
  553.             0.8018810,  // (2024,  3, 15)
  554.             0.7643810,  // (2025,  3, 15)
  555.             0.5618700,  // (2029, 12, 15)
  556.             0.4881200,  // (2032, 12, 15)
  557.             0.5024810,  // (2033,  1,  1)
  558.             0.5292085,  // (2033,  2,  1)
  559.             0.4538885,  // (2033, 12, 15)
  560.             0.4689745,  // (2035,  1,  1)
  561.             0.3785930,  // (2038,  1,  1)
  562.             0.3588700,  // (2039,  1,  1)
  563.             0.3395470,  // (2040,  1,  1)
  564.             0.2573115,  // (2045,  1,  1)
  565.             0.2728445,  // (2045,  1,  1)
  566.             0.2433560,  // (2046,  1,  1)
  567.             0.2593310,  // (2046,  1,  1)
  568.             0.2298805,  // (2047,  1,  1)
  569.         };

  571.         RVMeasures (
  572.             aZeroBond,
  573.             dtSpot,
  574.             MarketParamsBuilder.Create (
  575.                 FundingCurve (
  576.                     dtSpot,
  577.                     strCurrency,
  578.                     0.
  579.                 ),
  580.                 GovvieCurve (
  581.                     dtSpot,
  582.                     strTreasuryCode,
  583.                     adblTreasuryCoupon,
  584.                     adblTreasuryYield
  585.                 ),
  586.                 null,
  587.                 null,
  588.                 null,
  589.                 null,
  590.                 null
  591.             ),
  592.             adblCleanPrice
  593.         );

  595.         System.out.println();
  596.     }
  597. }
Created with JaCoCo 0.7.9.201702052155