EQRiskThresholdContainer21.java

  1. package org.drip.simm.equity;

  2. /*
  3.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  4.  */

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

  75. /**
  76.  * <i>EQRiskThresholdContainer21</i> holds the ISDA SIMM 2.1 Equity Risk Thresholds - the Equity Buckets and
  77.  * the Delta/Vega Limits defined for the Concentration Thresholds. The References are:
  78.  *
  79.  * <br><br>
  80.  *  <ul>
  81.  *      <li>
  82.  *          Andersen, L. B. G., M. Pykhtin, and A. Sokol (2017): Credit Exposure in the Presence of Initial
  83.  *              Margin https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2806156 <b>eSSRN</b>
  84.  *      </li>
  85.  *      <li>
  86.  *          Albanese, C., S. Caenazzo, and O. Frankel (2017): Regression Sensitivities for Initial Margin
  87.  *              Calculations https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2763488 <b>eSSRN</b>
  88.  *      </li>
  89.  *      <li>
  90.  *          Anfuso, F., D. Aziz, P. Giltinan, and K. Loukopoulus (2017): A Sound Modeling and Back-testing
  91.  *              Framework for Forecasting Initial Margin Requirements
  92.  *                  https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2716279 <b>eSSRN</b>
  93.  *      </li>
  94.  *      <li>
  95.  *          Caspers, P., P. Giltinan, R. Lichters, and N. Nowaczyk (2017): Forecasting Initial Margin
  96.  *              Requirements - A Model Evaluation https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2911167
  97.  *                  <b>eSSRN</b>
  98.  *      </li>
  99.  *      <li>
  100.  *          International Swaps and Derivatives Association (2017): SIMM v2.0 Methodology
  101.  *              https://www.isda.org/a/oFiDE/isda-simm-v2.pdf
  102.  *      </li>
  103.  *  </ul>
  104.  *
  105.  * <br><br>
  106.  *  <ul>
  107.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/PortfolioCore.md">Portfolio Core Module</a></li>
  108.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/MarginAnalyticsLibrary.md">Initial and Variation Margin Analytics</a></li>
  109.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/simm/README.md">Initial Margin Analytics based on ISDA SIMM and its Variants</a></li>
  110.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/simm/equity/README.md">Equity Risk Factor Calibration Settings</a></li>
  111.  *  </ul>
  112.  * <br><br>
  113.  *
  114.  * @author Lakshmi Krishnamurthy
  115.  */

  116. public class EQRiskThresholdContainer21
  117. {
  118.     private static final java.util.Map<java.lang.Integer, org.drip.simm.common.DeltaVegaThreshold>
  119.         s_DeltaVegaThresholdMap = new java.util.TreeMap<java.lang.Integer,
  120.             org.drip.simm.common.DeltaVegaThreshold>();

  121.     /**
  122.      * Initialize the Equity Risk Threshold Container
  123.      *
  124.      * @return TRUE - The Equity Risk Threshold Container successfully initialized
  125.      */

  126.     public static final boolean Init()
  127.     {
  128.         try
  129.         {
  130.             s_DeltaVegaThresholdMap.put (
  131.                 -1,
  132.                 new org.drip.simm.common.DeltaVegaThreshold (
  133.                     1.8,
  134.                     43.
  135.                 )
  136.             );

  137.             s_DeltaVegaThresholdMap.put (
  138.                 1,
  139.                 new org.drip.simm.common.DeltaVegaThreshold (
  140.                     8.4,
  141.                     220.
  142.                 )
  143.             );

  144.             s_DeltaVegaThresholdMap.put (
  145.                 2,
  146.                 new org.drip.simm.common.DeltaVegaThreshold (
  147.                     8.4,
  148.                     220.
  149.                 )
  150.             );

  151.             s_DeltaVegaThresholdMap.put (
  152.                 3,
  153.                 new org.drip.simm.common.DeltaVegaThreshold (
  154.                     8.4,
  155.                     220.
  156.                 )
  157.             );

  158.             s_DeltaVegaThresholdMap.put (
  159.                 4,
  160.                 new org.drip.simm.common.DeltaVegaThreshold (
  161.                     8.4,
  162.                     220.
  163.                 )
  164.             );

  165.             s_DeltaVegaThresholdMap.put (
  166.                 5,
  167.                 new org.drip.simm.common.DeltaVegaThreshold (
  168.                     26.,
  169.                     2300.
  170.                 )
  171.             );

  172.             s_DeltaVegaThresholdMap.put (
  173.                 6,
  174.                 new org.drip.simm.common.DeltaVegaThreshold (
  175.                     26.,
  176.                     2300.
  177.                 )
  178.             );

  179.             s_DeltaVegaThresholdMap.put (
  180.                 7,
  181.                 new org.drip.simm.common.DeltaVegaThreshold (
  182.                     26.,
  183.                     2300.
  184.                 )
  185.             );

  186.             s_DeltaVegaThresholdMap.put (
  187.                 8,
  188.                 new org.drip.simm.common.DeltaVegaThreshold (
  189.                     26.,
  190.                     2300.
  191.                 )
  192.             );

  193.             s_DeltaVegaThresholdMap.put (
  194.                 9,
  195.                 new org.drip.simm.common.DeltaVegaThreshold (
  196.                     1.8,
  197.                     43.
  198.                 )
  199.             );

  200.             s_DeltaVegaThresholdMap.put (
  201.                 10,
  202.                 new org.drip.simm.common.DeltaVegaThreshold (
  203.                     1.9,
  204.                     250.
  205.                 )
  206.             );

  207.             s_DeltaVegaThresholdMap.put (
  208.                 11,
  209.                 new org.drip.simm.common.DeltaVegaThreshold (
  210.                     540.,
  211.                     8100.
  212.                 )
  213.             );

  214.             s_DeltaVegaThresholdMap.put (
  215.                 12,
  216.                 new org.drip.simm.common.DeltaVegaThreshold (
  217.                     540.,
  218.                     8100.
  219.                 )
  220.             );
  221.         }
  222.         catch (java.lang.Exception e)
  223.         {
  224.             e.printStackTrace();

  225.             return false;
  226.         }

  227.         return true;
  228.     }

  229.     /**
  230.      * Retrieve the Bucket Number Set
  231.      *
  232.      * @return The Bucket Number Set
  233.      */

  234.     public static final java.util.Set<java.lang.Integer> BucketSet()
  235.     {
  236.         return s_DeltaVegaThresholdMap.keySet();
  237.     }

  238.     /**
  239.      * Indicate if the Bucket is contained the Threshold Container
  240.      *
  241.      * @param bucketNumber The Bucket Number
  242.      *
  243.      * @return TRUE - The Bucket is contained the Threshold Container
  244.      */

  245.     public static final boolean ContainsBucket (
  246.         final int bucketNumber)
  247.     {
  248.         return s_DeltaVegaThresholdMap.containsKey (bucketNumber);
  249.     }

  250.     /**
  251.      * Retrieve the Equity Threshold specified by the Bucket Number
  252.      *
  253.      * @param bucketNumber The Bucket Number
  254.      *
  255.      * @return The Equity Threshold specified by the Bucket Number
  256.      */

  257.     public static final org.drip.simm.common.DeltaVegaThreshold Threshold (
  258.         final int bucketNumber)
  259.     {
  260.         return ContainsBucket (bucketNumber) ? s_DeltaVegaThresholdMap.get (bucketNumber) : null;
  261.     }

  262.     /**
  263.      * Retrieve the Delta Vega Threshold Map
  264.      *
  265.      * @return The Delta Vega Threshold Map
  266.      */

  267.     public static final java.util.Map<java.lang.Integer, org.drip.simm.common.DeltaVegaThreshold>
  268.         DeltaVegaThresholdMap()
  269.     {
  270.         return s_DeltaVegaThresholdMap;
  271.     }
  272. }