CreditIndexDefinitions.java

  1. package org.drip.sample.credit;

  2. import org.drip.market.otc.*;
  3. import org.drip.numerical.common.FormatUtil;
  4. import org.drip.service.env.EnvManager;

  5. /*
  6.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  7.  */

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

  80. /**
  81.  * <i>CreditIndexDefinitions</i> displays the Definitions of the CDX NA IG OTC Index CDS Contracts.
  82.  *  
  83.  * <br><br>
  84.  *  <ul>
  85.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ProductCore.md">Product Core Module</a></li>
  86.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics</a></li>
  87.  *      <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>
  88.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/cashflow/README.md">Single Name Portfolio CDS Analytics</a></li>
  89.  *  </ul>
  90.  * <br><br>
  91.  *
  92.  * @author Lakshmi Krishnamurthy
  93.  */

  94. public class CreditIndexDefinitions {

  95.     private static final void DisplayIndexConvention (
  96.         final String strFullIndexName)
  97.         throws Exception
  98.     {
  99.         CreditIndexConvention cic = CreditIndexConventionContainer.ConventionFromFullName (strFullIndexName);

  100.         System.out.println (
  101.             "\t| " + cic.fullName() +
  102.             " | " + cic.indexType() +
  103.             " | " + cic.indexSubType() +
  104.             " | " + cic.seriesName() +
  105.             " | " + cic.currency() +
  106.             " | " + cic.effectiveDate() +
  107.             " | " + cic.maturityDate() +
  108.             " | " + cic.frequency() +
  109.             " | " + cic.dayCount() +
  110.             " | " + FormatUtil.FormatDouble (cic.fixedCoupon(), 3, 0, 10000.) +
  111.             " | " + FormatUtil.FormatDouble (cic.recoveryRate(), 2, 0, 100.) +
  112.             "% | " + cic.numberOfConstituents() + " ||"
  113.         );
  114.     }

  115.     public static final void main (
  116.         final String[] astrArgs)
  117.         throws Exception
  118.     {
  119.         EnvManager.InitEnv ("");

  120.         String[] astrFullIndexName = new String[] {
  121.             "CDX.NA.IG.S15.5Y",
  122.             "CDX.NA.IG.S16.5Y",
  123.             "CDX.NA.IG.S17.5Y",
  124.             "CDX.NA.IG.S18.5Y",
  125.             "CDX.NA.IG.S19.5Y",
  126.             "CDX.NA.IG.S20.5Y",
  127.             "CDX.NA.IG.S21.5Y",
  128.             "CDX.NA.IG.S22.5Y",
  129.             "CDX.NA.IG.S23.5Y",
  130.             "CDX.NA.IG.S24.5Y",
  131.             "CDX.NA.IG.S25.5Y",
  132.             "CDX.NA.IG.S26.5Y"
  133.         };

  134.         System.out.println ("\n");

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

  136.         System.out.println ("\t|                                                                                                          ||");

  137.         System.out.println ("\t|                                      CDX NA IG OTC INDEX DEFINITIONS                                     ||");

  138.         System.out.println ("\t|                                                                                                          ||");

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

  140.         System.out.println ("\t|                                                                                                          ||");

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

  142.         System.out.println ("\t|                                                                                                          ||");

  143.         System.out.println ("\t|        - Full Name                                                                                       ||");

  144.         System.out.println ("\t|        - Index Type                                                                                      ||");

  145.         System.out.println ("\t|        - Index Sub-Type                                                                                  ||");

  146.         System.out.println ("\t|        - Series Name                                                                                     ||");

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

  148.         System.out.println ("\t|        - Effective Date                                                                                  ||");

  149.         System.out.println ("\t|        - Maturity Date                                                                                   ||");

  150.         System.out.println ("\t|        - Coupon/Pay Frequency                                                                            ||");

  151.         System.out.println ("\t|        - Coupon/Pay Day Count                                                                            ||");

  152.         System.out.println ("\t|        - Fixed Coupon Strike (bp)                                                                        ||");

  153.         System.out.println ("\t|        - Fixed Recovery Rate                                                                             ||");

  154.         System.out.println ("\t|        - Number of Constituents                                                                          ||");

  155.         System.out.println ("\t|                                                                                                          ||");

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

  157.         for (String strFullIndexName : astrFullIndexName)
  158.             DisplayIndexConvention (strFullIndexName);

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

  160.         System.out.println ("\n");

  161.         EnvManager.TerminateEnv();
  162.     }
  163. }