FRAMarketPeriods.java

  1. package org.drip.sample.cashflow;

  3. import org.drip.analytics.cashflow.*;
  4. import org.drip.analytics.date.*;
  5. import org.drip.analytics.output.ConvexityAdjustment;
  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.fra.*;
  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.identifier.ForwardLabel;

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

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

  92. /**
  93.  * <i>FRAMarketPeriods</i> demonstrates the Cash Flow Period Details for a Market FRA.
  94.  *  
  95.  * <br><br>
  96.  *  <ul>
  97.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ProductCore.md">Product Core Module</a></li>
  98.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics</a></li>
  99.  *      <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>
  100.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/cashflow/README.md">Fixed Income Product Cash Flow Display</a></li>
  101.  *  </ul>
  102.  * <br><br>
  103.  * 
  104.  * @author Lakshmi Krishnamurthy
  105.  */

  107. public class FRAMarketPeriods {

  109.     private static final MergedDiscountForwardCurve FundingCurve (
  110.         final JulianDate dtSpot,
  111.         final String strCurrency,
  112.         final double dblBump)
  113.         throws Exception
  114.     {
  115.         String[] astrDepositMaturityTenor = new String[] {
  116.             "2D"
  117.         };

  119.         double[] adblDepositQuote = new double[] {
  120.             0.0111956 + dblBump // 2D
  121.         };

  123.         double[] adblFuturesQuote = new double[] {
  124.             0.011375 + dblBump, // 98.8625
  125.             0.013350 + dblBump, // 98.6650
  126.             0.014800 + dblBump, // 98.5200
  127.             0.016450 + dblBump, // 98.3550
  128.             0.017850 + dblBump, // 98.2150
  129.             0.019300 + dblBump  // 98.0700
  130.         };

  132.         String[] astrFixFloatMaturityTenor = new String[] {
  133.             "02Y",
  134.             "03Y",
  135.             "04Y",
  136.             "05Y",
  137.             "06Y",
  138.             "07Y",
  139.             "08Y",
  140.             "09Y",
  141.             "10Y",
  142.             "11Y",
  143.             "12Y",
  144.             "15Y",
  145.             "20Y",
  146.             "25Y",
  147.             "30Y",
  148.             "40Y",
  149.             "50Y"
  150.         };

  152.         double[] adblFixFloatQuote = new double[] {
  153.             0.017029 + dblBump, //  2Y
  154.             0.019354 + dblBump, //  3Y
  155.             0.021044 + dblBump, //  4Y
  156.             0.022291 + dblBump, //  5Y
  157.             0.023240 + dblBump, //  6Y
  158.             0.024025 + dblBump, //  7Y
  159.             0.024683 + dblBump, //  8Y
  160.             0.025243 + dblBump, //  9Y
  161.             0.025720 + dblBump, // 10Y
  162.             0.026130 + dblBump, // 11Y
  163.             0.026495 + dblBump, // 12Y
  164.             0.027230 + dblBump, // 15Y
  165.             0.027855 + dblBump, // 20Y
  166.             0.028025 + dblBump, // 25Y
  167.             0.028028 + dblBump, // 30Y
  168.             0.027902 + dblBump, // 40Y
  169.             0.027655 + dblBump  // 50Y
  170.         };

  172.         return LatentMarketStateBuilder.SmoothFundingCurve (
  173.             dtSpot,
  174.             strCurrency,
  175.             astrDepositMaturityTenor,
  176.             adblDepositQuote,
  177.             "ForwardRate",
  178.             adblFuturesQuote,
  179.             "ForwardRate",
  180.             astrFixFloatMaturityTenor,
  181.             adblFixFloatQuote,
  182.             "SwapRate"
  183.         );
  184.     }

  186.     public static final void main (
  187.         final String[] astrArgs)
  188.         throws Exception
  189.     {
  190.         EnvManager.InitEnv ("");

  192.         JulianDate dtSpot = DateUtil.CreateFromYMD (
  193.             2017,
  194.             DateUtil.MARCH,
  195.             10
  196.         );

  198.         String strCurrency = "USD";

  200.         FRAStandardComponent fraStandard = OTCInstrumentBuilder.FRAStandard (
  201.             dtSpot,
  202.             ForwardLabel.Create (
  203.                 strCurrency,
  204.                 "3M"
  205.             ),
  206.             "2Y",
  207.             0.01
  208.         );

  210.         FRAMarketComponent fraMarket = new FRAMarketComponent (
  211.             "FRA_MARKET_COMPONENT",
  212.             fraStandard.stream(),
  213.             fraStandard.strike(),
  214.             null
  215.         );

  217.         System.out.println();

  219.         MergedDiscountForwardCurve mdfc = FundingCurve (
  220.             dtSpot,
  221.             strCurrency,
  222.             0.
  223.         ); 

  225.         CurveSurfaceQuoteContainer csqc = MarketParamsBuilder.Create (
  226.             mdfc,
  227.             null,
  228.             null,
  229.             null,
  230.             null,
  231.             null,
  232.             null
  233.         );

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

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

  239.         System.out.println ("\t||                                                            CASH FLOW PERIOD DATES AND FACTORS                                                            ||");

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

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

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

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

  249.         System.out.println ("\t||           - Period Index Reference Start Date                                                                                                            ||");

  251.         System.out.println ("\t||           - Period Index Reference End Date                                                                                                              ||");

  253.         System.out.println ("\t||           - Period Reset Date                                                                                                                            ||");

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

  257.         System.out.println ("\t||           - Period FX Fixing Date                                                                                                                        ||");

  259.         System.out.println ("\t||           - Period Is FX MTM?                                                                                                                            ||");

  261.         System.out.println ("\t||           - Period Tenor                                                                                                                                 ||");

  263.         System.out.println ("\t||           - Period Coupon Frequency                                                                                                                      ||");

  265.         System.out.println ("\t||           - Period Pay Currency                                                                                                                          ||");

  267.         System.out.println ("\t||           - Period Coupon Currency                                                                                                                       ||");

  269.         System.out.println ("\t||           - Period Basis                                                                                                                                 ||");

  271.         System.out.println ("\t||           - Period Base Notional                                                                                                                         ||");

  273.         System.out.println ("\t||           - Period Notional                                                                                                                              ||");

  275.         System.out.println ("\t||           - Period Coupon Factor                                                                                                                         ||");

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

  279.         for (CompositePeriod p : fraMarket.couponPeriods()) {
  280.             int iEndDate = p.endDate();

  282.             CompositeFloatingPeriod cfp = (CompositeFloatingPeriod) p;

  284.             ComposableUnitFloatingPeriod cufp = (ComposableUnitFloatingPeriod) cfp.periods().get(0);

  286.             ReferenceIndexPeriod rip = cufp.referenceIndexPeriod();

  288.             System.out.println ("\t|| " +
  289.                 DateUtil.YYYYMMDD (p.startDate()) + " => " +
  290.                 DateUtil.YYYYMMDD (iEndDate) + " | " +
  291.                 DateUtil.YYYYMMDD (rip.startDate()) + " | " +
  292.                 DateUtil.YYYYMMDD (rip.endDate()) + " | " +
  293.                 DateUtil.YYYYMMDD (rip.fixingDate()) + " | " +
  294.                 DateUtil.YYYYMMDD (p.payDate()) + " | " +
  295.                 DateUtil.YYYYMMDD (p.fxFixingDate()) + " | " +
  296.                 p.isFXMTM() + " | " +
  297.                 p.tenor() + " | " +
  298.                 p.freq() + " | " +
  299.                 p.payCurrency() + " | " +
  300.                 p.couponCurrency() + " | " +
  301.                 FormatUtil.FormatDouble (p.basis(), 1, 0, 10000.) + " | " +
  302.                 FormatUtil.FormatDouble (p.baseNotional(), 1, 4, 1.) + " | " +
  303.                 FormatUtil.FormatDouble (p.notional (iEndDate), 1, 4, 1.) + " | " +
  304.                 FormatUtil.FormatDouble (p.couponFactor (iEndDate), 1, 4, 1.) + " ||"
  305.             );
  306.         }

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

  310.         System.out.println();

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

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

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

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

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

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

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

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

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

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

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

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

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

  338.         for (CompositePeriod p : fraMarket.couponPeriods()) {
  339.             int iEndDate = p.endDate();

  341.             int iPayDate = p.payDate();

  343.             int iStartDate = p.startDate();

  345.             double dblCouponRate = fraMarket.couponMetrics (
  346.                 iPayDate,
  347.                 valParams,
  348.                 csqc
  349.             ).rate();

  351.             double dblCouponDCF = p.couponDCF();

  353.             System.out.println ("\t|| " +
  354.                 DateUtil.YYYYMMDD (iStartDate) + " => " +
  355.                 DateUtil.YYYYMMDD (iEndDate) + " | " +
  356.                 p.fundingLabel().fullyQualifiedName() + " | " +
  357.                 p.floaterLabel().fullyQualifiedName() + " | " +
  358.                 FormatUtil.FormatDouble (dblCouponRate, 1, 2, 100.) + "% | " +
  359.                 FormatUtil.FormatDouble (dblCouponDCF, 1, 4, 1.) + " | " +
  360.                 FormatUtil.FormatDouble (dblCouponRate * dblCouponDCF * p.notional (iEndDate) * p.couponFactor (iEndDate), 1, 4, 1.) + " | " +
  361.                 FormatUtil.FormatDouble (p.notional (iStartDate) - p.notional (iEndDate), 1, 4, 1.) + " | " +
  362.                 FormatUtil.FormatDouble (p.df (csqc), 1, 4, 1.) + " ||"
  363.             );
  364.         }

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

  368.         System.out.println();

  370.         System.out.println();

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

  374.         System.out.println ("\t||                                       CASH FLOW PERIODS CONVEXITY CORRECTION                                       ||");

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

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

  380.         System.out.println ("\t||            - Collateral Credit Adjustment                                                                          ||");

  382.         System.out.println ("\t||            - Collateral Forward Adjustment                                                                         ||");

  384.         System.out.println ("\t||            - Collateral Funding Adjustment                                                                         ||");

  386.         System.out.println ("\t||            - Collateral FX Adjustment                                                                              ||");

  388.         System.out.println ("\t||            - Credit Forward Adjustment                                                                             ||");

  390.         System.out.println ("\t||            - Credit Funding Adjustment                                                                             ||");

  392.         System.out.println ("\t||            - Credit FX Adjustment                                                                                  ||");

  394.         System.out.println ("\t||            - Forward Funding Adjustment                                                                            ||");

  396.         System.out.println ("\t||            - Forward FX Adjustment                                                                                 ||");

  398.         System.out.println ("\t||            - Funding FX Adjustment                                                                                 ||");

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

  402.         for (CompositePeriod p : fraMarket.couponPeriods()) {
  403.             ConvexityAdjustment ca = p.terminalConvexityAdjustment (
  404.                 dtSpot.julian(),
  405.                 csqc
  406.             );

  408.             System.out.println ("\t|| " +
  409.                 DateUtil.YYYYMMDD (p.startDate()) + " => " +
  410.                 DateUtil.YYYYMMDD (p.endDate()) + " | " +
  411.                 FormatUtil.FormatDouble (ca.collateralCredit(), 1, 3, 1.) + " | " +
  412.                 FormatUtil.FormatDouble (ca.collateralForward(), 1, 3, 1.) + " | " +
  413.                 FormatUtil.FormatDouble (ca.collateralFunding(), 1, 3, 1.) + " | " +
  414.                 FormatUtil.FormatDouble (ca.collateralFX(), 1, 3, 1.) + " | " +
  415.                 FormatUtil.FormatDouble (ca.creditForward(), 1, 3, 1.) + " | " +
  416.                 FormatUtil.FormatDouble (ca.creditFunding(), 1, 3, 1.) + " | " +
  417.                 FormatUtil.FormatDouble (ca.creditFX(), 1, 3, 1.) + " | " +
  418.                 FormatUtil.FormatDouble (ca.forwardFunding(), 1, 3, 1.) + " | " +
  419.                 FormatUtil.FormatDouble (ca.forwardFX(), 1, 3, 1.) + " | " +
  420.                 FormatUtil.FormatDouble (ca.fundingFX(), 1, 3, 1.) + " ||"
  421.             );
  422.         }

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

  426.         System.out.println();

  428.         EnvManager.TerminateEnv();
  429.     }
  430. }
Created with JaCoCo 0.7.9.201702052155