Kamarhati.java

  1. package org.drip.sample.securitysuite;

  3. import org.drip.analytics.cashflow.*;
  4. import org.drip.analytics.date.*;
  5. import org.drip.numerical.common.FormatUtil;
  6. import org.drip.param.market.CurveSurfaceQuoteContainer;
  7. import org.drip.param.valuation.ValuationParams;
  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.scenario.*;
  13. import org.drip.service.template.LatentMarketStateBuilder;
  14. import org.drip.state.discount.MergedDiscountForwardCurve;
  15. import org.drip.state.identifier.FloaterLabel;

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

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

  63. /**
  64.  * Kamarhati demonstrates the Analytics Calculation/Reconciliation for the Bond Kamarhati.
  65.  * 
  66.  * @author Lakshmi Krishnamurthy
  67.  */

  69. public class Kamarhati {

  71.     private static final void SetEOS (
  72.         final BondComponent bond,
  73.         final EmbeddedOptionSchedule eosCall,
  74.         final EmbeddedOptionSchedule eosPut)
  75.         throws java.lang.Exception
  76.     {
  77.         if (null != eosPut) bond.setEmbeddedPutSchedule (eosPut);

  79.         if (null != eosCall) bond.setEmbeddedCallSchedule (eosCall);
  80.     }

  82.     public static final void main (
  83.         final String[] astArgs)
  84.         throws Exception
  85.     {
  86.         EnvManager.InitEnv ("");

  88.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  89.             2017,
  90.             DateUtil.OCTOBER,
  91.             10
  92.         );

  94.         String[] astrDepositTenor = new String[] {
  95.             "2D"
  96.         };

  98.         double[] adblDepositQuote = new double[] {
  99.             0.0130411 // 2D
  100.         };

  102.         double[] adblFuturesQuote = new double[] {
  103.             0.01345,    // 98.655
  104.             0.01470,    // 98.530
  105.             0.01575,    // 98.425
  106.             0.01660,    // 98.340
  107.             0.01745,    // 98.255
  108.             0.01845     // 98.155
  109.         };

  111.         String[] astrFixFloatTenor = new String[] {
  112.             "02Y",
  113.             "03Y",
  114.             "04Y",
  115.             "05Y",
  116.             "06Y",
  117.             "07Y",
  118.             "08Y",
  119.             "09Y",
  120.             "10Y",
  121.             "11Y",
  122.             "12Y",
  123.             "15Y",
  124.             "20Y",
  125.             "25Y",
  126.             "30Y",
  127.             "40Y",
  128.             "50Y"
  129.         };

  131.         double[] adblFixFloatQuote = new double[] {
  132.             0.016410, //  2Y
  133.             0.017863, //  3Y
  134.             0.019030, //  4Y
  135.             0.020035, //  5Y
  136.             0.020902, //  6Y
  137.             0.021660, //  7Y
  138.             0.022307, //  8Y
  139.             0.022879, //  9Y
  140.             0.023363, // 10Y
  141.             0.023820, // 11Y
  142.             0.024172, // 12Y
  143.             0.024934, // 15Y
  144.             0.025581, // 20Y
  145.             0.025906, // 25Y
  146.             0.025973, // 30Y
  147.             0.025838, // 40Y
  148.             0.025560  // 50Y
  149.         };

  151.         String[] astrGovvieTenor = new String[] {
  152.             "1Y",
  153.             "2Y",
  154.             "3Y",
  155.             "5Y",
  156.             "7Y",
  157.             "10Y",
  158.             "20Y",
  159.             "30Y"
  160.         };

  162.         double[] adblGovvieYield = new double[] {
  163.             0.01219, //  1Y
  164.             0.01391, //  2Y
  165.             0.01590, //  3Y
  166.             0.01937, //  5Y
  167.             0.02200, //  7Y
  168.             0.02378, // 10Y
  169.             0.02677, // 20Y
  170.             0.02927  // 30Y
  171.         };

  173.         String[] astrCreditTenor = new String[] {
  174.             "06M",
  175.             "01Y",
  176.             "02Y",
  177.             "03Y",
  178.             "04Y",
  179.             "05Y",
  180.             "07Y",
  181.             "10Y"
  182.         };

  184.         double[] adblCreditQuote = new double[] {
  185.              10.,   //  6M
  186.              12.,   //  1Y
  187.              15.,   //  2Y
  188.              19.,   //  3Y
  189.              24.,   //  4Y
  190.              28.,   //  5Y
  191.              38.,   //  7Y
  192.              51.    // 10Y
  193.         };

  195.         double dblFX = 1;
  196.         int iSettleLag = 3;
  197.         double dblSpread = 0.0;
  198.         String strCurrency = "USD";
  199.         double dblCleanPrice = 0.824219;
  200.         double dblIssuePrice = 0.89;
  201.         double dblSpreadBump = 20.;
  202.         String strTreasuryCode = "UST";
  203.         double dblIssueAmount = 7.50e8;
  204.         double dblSpreadDurationMultiplier = 5.;
  205.         double dblResetRate = 0.060603 - dblSpread;

  207.         JulianDate dtEffective = DateUtil.CreateFromYMD (
  208.             2015,
  209.             12,
  210.             10
  211.         );

  213.         JulianDate dtMaturity = DateUtil.CreateFromYMD (
  214.             2022,
  215.             12,
  216.             10
  217.         );

  219.         BondComponent bond = BondBuilder.CreateSimpleFloater (
  220.             "Kamarhati",
  221.             "USD",
  222.             "USD-3M",
  223.             "Kamarhati",
  224.             dblSpread,
  225.             4,
  226.             "Act/360",
  227.             dtEffective,
  228.             dtMaturity,
  229.             null,
  230.             null
  231.         );

  233.         SetEOS (
  234.             bond,
  235.             EmbeddedOptionSchedule.FromAmerican (
  236.                 dtSpot.julian(),
  237.                 new int[] {
  238.                     DateUtil.CreateFromYMD (2015, 12, 10).julian(),
  239.                     DateUtil.CreateFromYMD (2016, 12, 10).julian(),
  240.                     DateUtil.CreateFromYMD (2022, 12, 10).julian(),
  241.                 },
  242.                 new double[] {
  243.                     1.01,
  244.                     1.00,
  245.                     1.00,
  246.                 },
  247.                 false,
  248.                 15,
  249.                 15,
  250.                 false,
  251.                 Double.NaN,
  252.                 "",
  253.                 Double.NaN
  254.             ),
  255.             null
  256.         );

  258.         CompositeFloatingPeriod cfp = (CompositeFloatingPeriod) bond.stream().containingPeriod (dtSpot.julian());

  260.         int iResetDate = ((org.drip.analytics.cashflow.ComposableUnitFloatingPeriod) (cfp.periods().get
  261.             (0))).referenceIndexPeriod().fixingDate();

  263.         MergedDiscountForwardCurve mdfc = LatentMarketStateBuilder.SmoothFundingCurve (
  264.             dtSpot,
  265.             strCurrency,
  266.             astrDepositTenor,
  267.             adblDepositQuote,
  268.             "ForwardRate",
  269.             adblFuturesQuote,
  270.             "ForwardRate",
  271.             astrFixFloatTenor,
  272.             adblFixFloatQuote,
  273.             "SwapRate"
  274.         );

  276.         BondReplicator abr = BondReplicator.CorporateSenior (
  277.             dblCleanPrice,
  278.             dblIssuePrice,
  279.             dblIssueAmount,
  280.             dtSpot,
  281.             astrDepositTenor,
  282.             adblDepositQuote,
  283.             adblFuturesQuote,
  284.             astrFixFloatTenor,
  285.             adblFixFloatQuote,
  286.             dblSpreadBump,
  287.             dblSpreadDurationMultiplier,
  288.             strTreasuryCode,
  289.             astrGovvieTenor,
  290.             adblGovvieYield,
  291.             astrCreditTenor,
  292.             adblCreditQuote,
  293.             dblFX,
  294.             dblResetRate,
  295.             iSettleLag,
  296.             bond
  297.         );

  299.         BondReplicationRun abrr = abr.generateRun();

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

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

  305.         System.out.println();

  307.         CurveSurfaceQuoteContainer csqc = abr.creditBaseCSQC();

  309.         FloaterLabel fl = bond.floaterSetting().fri();

  311.         csqc.setFixing (iResetDate, fl, dblResetRate);

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

  315.         double dblYield = bond.yieldFromPrice (
  316.             ValuationParams.Spot (dtSpot.julian()),
  317.             csqc,
  318.             null,
  319.             dblCleanPrice
  320.         );

  322.         System.out.println ("Price In  : " + dblCleanPrice);

  324.         System.out.println ("Yield Out : " + dblYield);

  326.         System.out.println ("Price Out : " +
  327.             bond.priceFromYield (
  328.                 ValuationParams.Spot (dtSpot.julian()),
  329.                 csqc,
  330.                 null,
  331.                 dblYield
  332.             )
  333.         );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  367.         for (CompositePeriod p : bond.couponPeriods()) {
  368.             int iEndDate = p.endDate();

  370.             int iPayDate = p.payDate();

  372.             int iStartDate = p.startDate();

  374.             double dblCouponRate = bond.couponMetrics (
  375.                 iPayDate,
  376.                 valParams,
  377.                 csqc
  378.             ).rate();

  380.             double dblCouponDCF = p.couponDCF();

  382.             System.out.println ("\t|| " +
  383.                 DateUtil.YYYYMMDD (iStartDate) + " => " +
  384.                 DateUtil.YYYYMMDD (iEndDate) + " | ? | " +
  385.                 p.fundingLabel().fullyQualifiedName() + " | " +
  386.                 p.floaterLabel().fullyQualifiedName() + " | " +
  387.                 FormatUtil.FormatDouble (dblCouponRate, 1, 2, 100.) + "% | " +
  388.                 FormatUtil.FormatDouble (dblCouponDCF, 1, 4, 1.) + " | " +
  389.                 FormatUtil.FormatDouble (dblCouponRate * dblCouponDCF * p.notional (iEndDate) * p.couponFactor (iEndDate), 1, 4, 1.) + " | " +
  390.                 FormatUtil.FormatDouble (p.notional (iStartDate) - p.notional (iEndDate), 1, 4, 1.) + " | " +
  391.                 FormatUtil.FormatDouble (p.df (csqc), 1, 4, 1.) + " | " +
  392.                 FormatUtil.FormatDouble (p.survival (csqc), 1, 4, 1.) + " | " +
  393.                 FormatUtil.FormatDouble (p.recovery (csqc), 2, 0, 100.) + "% ||"
  394.             );
  395.         }

  397.         System.out.println ("\t|| " +
  398.             DateUtil.YYYYMMDD (dtEffective.julian()) + " => " +
  399.             DateUtil.YYYYMMDD (dtMaturity.julian()) + " | ? | " +
  400.             bond.fundingLabel().fullyQualifiedName() + " | " +
  401.             bond.forwardLabel().get (bond.name()).fullyQualifiedName() + " | " +
  402.             FormatUtil.FormatDouble (0., 1, 2, 100.) + "% | " +
  403.             FormatUtil.FormatDouble (0., 1, 4, 1.) + " | " +
  404.             FormatUtil.FormatDouble (0., 1, 4, 1.) + " | " +
  405.             FormatUtil.FormatDouble (bond.notional (dtMaturity.julian()), 1, 4, 1.) + " | " +
  406.             FormatUtil.FormatDouble (mdfc.df (dtMaturity), 1, 4, 1.) + " | " +
  407.             FormatUtil.FormatDouble (1., 1, 4, 1.) + " | " +
  408.             FormatUtil.FormatDouble (1., 2, 0, 100.) + "% ||"
  409.         );

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

  413.         System.out.println();
  414.     }
  415. }
Created with JaCoCo 0.7.9.201702052155