Kurnool.java

  1. package org.drip.sample.municipal;

  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.params.EmbeddedOptionSchedule;
  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.  * Kurnool demonstrates EOS Fixed/Float Coupon Multi-flavor Pricing and Relative Value Measure Generation for
  64.  *  Kurnool.
  65.  * 
  66.  * @author Lakshmi Krishnamurthy
  67.  */

  69. public class Kurnool {

  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.         return LatentMarketStateBuilder.SmoothFundingCurve (
  135.             dtSpot,
  136.             strCurrency,
  137.             astrDepositMaturityTenor,
  138.             adblDepositQuote,
  139.             "ForwardRate",
  140.             adblFuturesQuote,
  141.             "ForwardRate",
  142.             astrFixFloatMaturityTenor,
  143.             adblFixFloatQuote,
  144.             "SwapRate"
  145.         );
  146.     }

  148.     private static final GovvieCurve GovvieCurve (
  149.         final JulianDate dtSpot,
  150.         final String strCode,
  151.         final double[] adblCoupon,
  152.         final double[] adblYield)
  153.         throws Exception
  154.     {
  155.         JulianDate[] adtEffective = new JulianDate[] {
  156.             dtSpot,
  157.             dtSpot,
  158.             dtSpot,
  159.             dtSpot,
  160.             dtSpot,
  161.             dtSpot,
  162.             dtSpot,
  163.             dtSpot
  164.         };

  166.         JulianDate[] adtMaturity = new JulianDate[] {
  167.             dtSpot.addTenor ("1Y"),
  168.             dtSpot.addTenor ("2Y"),
  169.             dtSpot.addTenor ("3Y"),
  170.             dtSpot.addTenor ("5Y"),
  171.             dtSpot.addTenor ("7Y"),
  172.             dtSpot.addTenor ("10Y"),
  173.             dtSpot.addTenor ("20Y"),
  174.             dtSpot.addTenor ("30Y")
  175.         };

  177.         return LatentMarketStateBuilder.GovvieCurve (
  178.             strCode,
  179.             dtSpot,
  180.             adtEffective,
  181.             adtMaturity,
  182.             adblCoupon,
  183.             adblYield,
  184.             "Yield",
  185.             LatentMarketStateBuilder.SHAPE_PRESERVING
  186.         );
  187.     }

  189.     private static final void RVMeasures (
  190.         final BondComponent bond,
  191.         final JulianDate dtValue,
  192.         final CurveSurfaceQuoteContainer csqc,
  193.         final double dblCleanPrice)
  194.         throws Exception
  195.     {
  196.         JulianDate dtSettle = dtValue.addBusDays (
  197.             0,
  198.             bond.currency()
  199.         );

  201.         ValuationParams valParams = new ValuationParams (
  202.             dtValue,
  203.             dtSettle,
  204.             bond.currency()
  205.         );

  207.         System.out.println();

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

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

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

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

  217.         System.out.println();

  219.         double dblYTM = Double.NaN;
  220.         double dblYTW = Double.NaN;
  221.         double dblOASTM = Double.NaN;
  222.         double dblOASTW = Double.NaN;
  223.         double dblWALTM = Double.NaN;
  224.         double dblWALTW = Double.NaN;
  225.         double dblZSpreadTM = Double.NaN;
  226.         double dblZSpreadTW = Double.NaN;
  227.         double dblOASDurationTW = Double.NaN;
  228.         double dblModifiedDurationTM = Double.NaN;
  229.         double dblModifiedDurationTW = Double.NaN;

  231.         WorkoutInfo wi = bond.exerciseYieldFromPrice (
  232.             valParams,
  233.             csqc,
  234.             null,
  235.             dblCleanPrice
  236.         );

  238.         try {
  239.             dblYTW = wi.yield();

  241.             dblYTM = bond.yieldFromPrice (
  242.                 valParams,
  243.                 csqc,
  244.                 null,
  245.                 bond.maturityDate().julian(),
  246.                 1.,
  247.                 dblCleanPrice
  248.             );

  250.             dblWALTW = bond.weightedAverageLife (
  251.                 valParams,
  252.                 csqc,
  253.                 wi.date(),
  254.                 wi.factor()
  255.             );

  257.             dblWALTM = bond.weightedAverageLife (
  258.                 valParams,
  259.                 csqc,
  260.                 bond.maturityDate().julian(),
  261.                 1.
  262.             );

  264.             dblZSpreadTM = bond.zSpreadFromYield (
  265.                 valParams,
  266.                 csqc,
  267.                 null,
  268.                 bond.maturityDate().julian(),
  269.                 1.,
  270.                 dblYTM
  271.             );

  273.             dblZSpreadTW = bond.zSpreadFromYield (
  274.                 valParams,
  275.                 csqc,
  276.                 null,
  277.                 wi.date(),
  278.                 wi.factor(),
  279.                 wi.yield()
  280.             );

  282.             dblOASTM = bond.oasFromYield (
  283.                 valParams,
  284.                 csqc,
  285.                 null,
  286.                 wi.date(),
  287.                 wi.factor(),
  288.                 dblYTM
  289.             );

  291.             dblOASTW = bond.oasFromYield (
  292.                 valParams,
  293.                 csqc,
  294.                 null,
  295.                 wi.date(),
  296.                 wi.factor(),
  297.                 wi.yield()
  298.             );

  300.             dblOASDurationTW = (dblCleanPrice - bond.priceFromOAS (
  301.                     valParams,
  302.                     csqc,
  303.                     null,
  304.                     wi.date(),
  305.                     wi.factor(),
  306.                     dblOASTW + 0.0001
  307.                 )
  308.             ) / dblCleanPrice;

  310.             dblModifiedDurationTM = bond.modifiedDurationFromPrice (
  311.                 valParams,
  312.                 csqc,
  313.                 null,
  314.                 bond.maturityDate().julian(),
  315.                 1.,
  316.                 dblCleanPrice
  317.             );

  319.             dblModifiedDurationTW = bond.modifiedDurationFromPrice (
  320.                 valParams,
  321.                 csqc,
  322.                 null,
  323.                 wi.date(),
  324.                 wi.factor(),
  325.                 dblCleanPrice
  326.             );
  327.         } catch (Exception e) {
  328.             // e.printStackTrace();
  329.         }

  331.         System.out.println ("\t Bond Name                 => " + bond.name());

  333.         System.out.println ("\t Effective Date            => " + bond.effectiveDate());

  335.         System.out.println ("\t Maturity Date             => " + bond.maturityDate());

  337.         System.out.println ("\t Exercise Date             => " + new JulianDate (wi.date()));

  339.         System.out.println ("\t Price                     => " + FormatUtil.FormatDouble (dblCleanPrice, 1, 5, 100.));

  341.         System.out.println ("\t Bond Accrued              => " + FormatUtil.FormatDouble (bond.accrued (dtValue.julian(), csqc), 1, 4, 100.));

  343.         System.out.println ("\t Bond YTM                  => " + FormatUtil.FormatDouble (dblYTM, 1, 2, 100.) + "%");

  345.         System.out.println ("\t Bond YTW                  => " + FormatUtil.FormatDouble (dblYTW, 1, 2, 100.) + "%");

  347.         System.out.println ("\t Bond WAL TM               => " + FormatUtil.FormatDouble (dblWALTM, 2, 1, 1.));

  349.         System.out.println ("\t Bond WAL TW               => " + FormatUtil.FormatDouble (dblWALTW, 2, 1, 1.));

  351.         System.out.println ("\t Bond Modified Duration TM => " + FormatUtil.FormatDouble (dblModifiedDurationTM, 2, 4, 10000.));

  353.         System.out.println ("\t Bond Modified Duration TW => " + FormatUtil.FormatDouble (dblModifiedDurationTW, 2, 4, 10000.));

  355.         System.out.println ("\t Bond OAS Duration         => " + FormatUtil.FormatDouble (dblOASDurationTW, 2, 4, 10000.));

  357.         System.out.println ("\t Bond Z Spread TM          => " + FormatUtil.FormatDouble (dblZSpreadTM, 3, 0, 10000.));

  359.         System.out.println ("\t Bond Z Spread TW          => " + FormatUtil.FormatDouble (dblZSpreadTW, 3, 0, 10000.));

  361.         System.out.println ("\t Bond OAS TM               => " + FormatUtil.FormatDouble (dblOASTM, 3, 0, 10000.));

  363.         System.out.println ("\t Bond OAS TW               => " + FormatUtil.FormatDouble (dblOASTW, 3, 0, 10000.));
  364.     }

  366.     public static final void main (
  367.         final String[] astrArgs)
  368.         throws Exception
  369.     {
  370.         EnvManager.InitEnv ("");

  372.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  373.             2017,
  374.             DateUtil.MARCH,
  375.             24
  376.         );

  378.         String strCurrency = "USD";
  379.         String strTreasuryCode = "UST";

  381.         double[] adblTreasuryCoupon = new double[] {
  382.             0.0100,
  383.             0.0100,
  384.             0.0125,
  385.             0.0150,
  386.             0.0200,
  387.             0.0225,
  388.             0.0250,
  389.             0.0300
  390.         };

  392.         double[] adblTreasuryYield = new double[] {
  393.             0.0083, //  1Y
  394.             0.0122, //  2Y
  395.             0.0149, //  3Y
  396.             0.0193, //  5Y
  397.             0.0227, //  7Y
  398.             0.0248, // 10Y
  399.             0.0280, // 20Y
  400.             0.0308  // 30Y
  401.         };

  403.         JulianDate dtEffective = DateUtil.CreateFromYMD (2014,  4, 11);
  404.         JulianDate dtMaturity  = DateUtil.CreateFromYMD (2029,  4, 11);
  405.         double dblCoupon = 0.0400;
  406.         double dblCleanPrice = 1.00085;
  407.         int iFreq = 2;
  408.         String strCUSIP = "Kurnool";
  409.         String strDayCount = "30/360";
  410.         int[] aiExerciseDate = new int[] {
  411.             DateUtil.CreateFromYMD (2017,  4, 11).julian(),
  412.         };
  413.         double[] adblExercisePrice = new double[] {
  414.             1.,
  415.         };

  417.         BondComponent bond = BondBuilder.CreateSimpleFixed (
  418.             strCUSIP,
  419.             strCurrency,
  420.             "",
  421.             dblCoupon,
  422.             iFreq,
  423.             strDayCount,
  424.             dtEffective,
  425.             dtMaturity,
  426.             null,
  427.             null
  428.         );

  430.         EmbeddedOptionSchedule eos = new EmbeddedOptionSchedule (
  431.             aiExerciseDate,
  432.             adblExercisePrice,
  433.             false,
  434.             30,
  435.             false,
  436.             Double.NaN,
  437.             "",
  438.             Double.NaN
  439.         );

  441.         bond.setEmbeddedCallSchedule (eos);

  443.         RVMeasures (
  444.             bond,
  445.             dtSpot,
  446.             MarketParamsBuilder.Create (
  447.                 FundingCurve (
  448.                     dtSpot,
  449.                     strCurrency,
  450.                     0.
  451.                 ),
  452.                 GovvieCurve (
  453.                     dtSpot,
  454.                     strTreasuryCode,
  455.                     adblTreasuryCoupon,
  456.                     adblTreasuryYield
  457.                 ),
  458.                 null,
  459.                 null,
  460.                 null,
  461.                 null,
  462.                 null
  463.             ),
  464.             dblCleanPrice
  465.         );

  467.         System.out.println();
  468.     }
  469. }
Created with JaCoCo 0.7.9.201702052155