CapitalUnitStressEventContext.java

  1. package org.drip.capital.shell;

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

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

  77. /**
  78.  * <i>CapitalUnitStressEventContext</i> maintains the Systemic, Idiosyncratic, and Correlated Scenarios at
  79.  *  the Capital Unit Coordinate Level. The References are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Bank for International Supervision(2005): Stress Testing at Major Financial Institutions: Survey
  85.  *              Results and Practice https://www.bis.org/publ/cgfs24.htm
  86.  *      </li>
  87.  *      <li>
  88.  *          Glasserman, P. (2004): <i>Monte Carlo Methods in Financial Engineering</i> <b>Springer</b>
  89.  *      </li>
  90.  *      <li>
  91.  *          Kupiec, P. H. (2000): Stress Tests and Risk Capital <i>Risk</i> <b>2 (4)</b> 27-39
  92.  *      </li>
  93.  *  </ul>
  94.  *
  95.  *  <br><br>
  96.  *  <ul>
  97.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/PortfolioCore.md">Portfolio Core Module</a></li>
  98.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/CapitalAnalyticsLibrary.md">Capital Analytics</a></li>
  99.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/capital/README.md">Basel Market Risk and Operational Capital</a></li>
  100.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/capital/shell/README.md">Economic Risk Capital Parameter Contexts</a></li>
  101.  *  </ul>
  102.  * 
  103.  * @author Lakshmi Krishnamurthy
  104.  */

  106. public class CapitalUnitStressEventContext
  107. {
  108.     private java.util.Map<java.lang.String, org.drip.capital.entity.CapitalUnitEventContainer>
  109.         _capitalUnitEventMap = new
  110.             org.drip.analytics.support.CaseInsensitiveHashMap<org.drip.capital.entity.CapitalUnitEventContainer>();

  112.     /**
  113.      * Empty CapitalUnitStressEventContext Constructor
  114.      */

  116.     public CapitalUnitStressEventContext()
  117.     {
  118.     }

  120.     /**
  121.      * Add a Systemic Event to the Capital Unit Coordinate
  122.      * 
  123.      * @param capitalCoordinateFQN The Capital Coordinate FQN
  124.      * @param systemicScenarioPnLSeries Systemic Scenario PnL Series
  125.      * @param systemicScenarioPnLSeriesPAA Systemic Scenario PnL Series PAA
  126.      * 
  127.      * @return TRUE - Systemic Event successfully created and added to the Capital Unit Event Map
  128.      */

  130.     public boolean addSystemic (
  131.         final java.lang.String capitalCoordinateFQN,
  132.         final org.drip.capital.shell.SystemicScenarioPnLSeries systemicScenarioPnLSeries,
  133.         final org.drip.capital.shell.SystemicScenarioPnLSeriesPAA systemicScenarioPnLSeriesPAA)
  134.     {
  135.         if (null == systemicScenarioPnLSeries)
  136.         {
  137.             return false;
  138.         }

  140.         org.drip.capital.entity.CapitalUnitEventContainer capitalUnitEventContainer =
  141.             new org.drip.capital.entity.CapitalUnitEventContainer();

  143.         try
  144.         {
  145.             if (!capitalUnitEventContainer.addSystemicEvent (
  146.                 new org.drip.capital.stress.Event (
  147.                     org.drip.capital.stress.EventSpecification.Systemic1974Baseline(),
  148.                     systemicScenarioPnLSeries.baseline1974(),
  149.                     null == systemicScenarioPnLSeriesPAA ?
  150.                         null : systemicScenarioPnLSeriesPAA.baseline1974DecompositionMap()
  151.                 )
  152.             ))
  153.             {
  154.                 return false;
  155.             }

  157.             if (!capitalUnitEventContainer.addSystemicEvent (
  158.                 new org.drip.capital.stress.Event (
  159.                     org.drip.capital.stress.EventSpecification.Systemic2008Baseline(),
  160.                     systemicScenarioPnLSeries.baseline2008(),
  161.                     null == systemicScenarioPnLSeriesPAA ?
  162.                         null : systemicScenarioPnLSeriesPAA.baseline2008DecompositionMap()
  163.                 )
  164.             ))
  165.             {
  166.                 return false;
  167.             }

  169.             if (!capitalUnitEventContainer.addSystemicEvent (
  170.                 new org.drip.capital.stress.Event (
  171.                     org.drip.capital.stress.EventSpecification.SystemicDeepDownturn(),
  172.                     systemicScenarioPnLSeries.deepDownturn(),
  173.                     null == systemicScenarioPnLSeriesPAA ?
  174.                         null : systemicScenarioPnLSeriesPAA.deepDownturnDecompositionMap()
  175.                 )
  176.             ))
  177.             {
  178.                 return false;
  179.             }

  181.             if (!capitalUnitEventContainer.addSystemicEvent (
  182.                 new org.drip.capital.stress.Event (
  183.                     org.drip.capital.stress.EventSpecification.SystemicDollarDecline(),
  184.                     systemicScenarioPnLSeries.dollarDecline(),
  185.                     null == systemicScenarioPnLSeriesPAA ?
  186.                         null : systemicScenarioPnLSeriesPAA.dollarDeclineDecompositionMap()
  187.                 )
  188.             ))
  189.             {
  190.                 return false;
  191.             }

  193.             if (!capitalUnitEventContainer.addSystemicEvent (
  194.                 new org.drip.capital.stress.Event (
  195.                     org.drip.capital.stress.EventSpecification.SystemicInterestRateShock(),
  196.                     systemicScenarioPnLSeries.interestRateShock(),
  197.                     null == systemicScenarioPnLSeriesPAA ?
  198.                         null : systemicScenarioPnLSeriesPAA.interestRateShockDecompositionMap()
  199.                 )
  200.             ))
  201.             {
  202.                 return false;
  203.             }

  205.             if (!capitalUnitEventContainer.addSystemicEvent (
  206.                 new org.drip.capital.stress.Event (
  207.                     org.drip.capital.stress.EventSpecification.SystemicLostDecade(),
  208.                     systemicScenarioPnLSeries.lostDecade(),
  209.                     null == systemicScenarioPnLSeriesPAA ?
  210.                         null : systemicScenarioPnLSeriesPAA.lostDecadeDecompositionMap()
  211.                 )
  212.             ))
  213.             {
  214.                 return false;
  215.             }

  217.             _capitalUnitEventMap.put (
  218.                 new org.drip.capital.label.CapitalSegmentCoordinate (
  219.                     capitalCoordinateFQN
  220.                 ).fullyQualifiedName(),
  221.                 capitalUnitEventContainer
  222.             );

  224.             return true;
  225.         }
  226.         catch (java.lang.Exception e)
  227.         {
  228.             e.printStackTrace();
  229.         }

  231.         return false;
  232.     }

  234.     /**
  235.      * Add a Correlated Event to the Capital Unit Coordinate
  236.      * 
  237.      * @param capitalCoordinateFQN The Capital Coordinate FQN
  238.      * @param correlatedEventName Correlated Event Name
  239.      * @param correlatedSystemicScenarioPnLSeries Correlated Systemic Scenario PnL Series
  240.      * 
  241.      * @return TRUE - Correlated Event successfully created and added to the Capital Unit Event Map
  242.      */

  244.     public boolean addCorrelated (
  245.         final java.lang.String capitalCoordinateFQN,
  246.         final java.lang.String correlatedEventName,
  247.         final org.drip.capital.shell.SystemicScenarioPnLSeries correlatedSystemicScenarioPnLSeries)
  248.     {
  249.         try
  250.         {
  251.             if (!_capitalUnitEventMap.containsKey (
  252.                 capitalCoordinateFQN
  253.             ))
  254.             {
  255.                 addSystemic (
  256.                     capitalCoordinateFQN,
  257.                     org.drip.capital.shell.SystemicScenarioPnLSeries.ZERO(),
  258.                     null
  259.                 );
  260.             }

  262.             org.drip.capital.entity.CapitalUnitEventContainer capitalUnitEventContainer =
  263.                 _capitalUnitEventMap.get (
  264.                     capitalCoordinateFQN
  265.                 );

  267.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  268.                 org.drip.capital.definition.SystemicScenarioDefinition.BASELINE_1974,
  269.                 correlatedEventName,
  270.                 correlatedSystemicScenarioPnLSeries.baseline1974()
  271.             ))
  272.             {
  273.                 return false;
  274.             }

  276.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  277.                 org.drip.capital.definition.SystemicScenarioDefinition.BASELINE_2008,
  278.                 correlatedEventName,
  279.                 correlatedSystemicScenarioPnLSeries.baseline2008()
  280.             ))
  281.             {
  282.                 return false;
  283.             }

  285.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  286.                 org.drip.capital.definition.SystemicScenarioDefinition.DEEP_DOWNTURN,
  287.                 correlatedEventName,
  288.                 correlatedSystemicScenarioPnLSeries.deepDownturn()
  289.             ))
  290.             {
  291.                 return false;
  292.             }

  294.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  295.                 org.drip.capital.definition.SystemicScenarioDefinition.DOLLAR_DECLINE,
  296.                 correlatedEventName,
  297.                 correlatedSystemicScenarioPnLSeries.dollarDecline()
  298.             ))
  299.             {
  300.                 return false;
  301.             }

  303.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  304.                 org.drip.capital.definition.SystemicScenarioDefinition.INTEREST_RATE_SHOCK,
  305.                 correlatedEventName,
  306.                 correlatedSystemicScenarioPnLSeries.interestRateShock()
  307.             ))
  308.             {
  309.                 return false;
  310.             }

  312.             if (!capitalUnitEventContainer.addCorrelatedEvent (
  313.                 org.drip.capital.definition.SystemicScenarioDefinition.LOST_DECADE,
  314.                 correlatedEventName,
  315.                 correlatedSystemicScenarioPnLSeries.lostDecade()
  316.             ))
  317.             {
  318.                 return false;
  319.             }

  321.             return true;
  322.         }
  323.         catch (java.lang.Exception e)
  324.         {
  325.             e.printStackTrace();
  326.         }

  328.         return false;
  329.     }

  331.     /**
  332.      * Add a Idiosyncratic Event to the Capital Unit Coordinate
  333.      * 
  334.      * @param capitalUnitCoordinateFQN The Capital Unit Coordinate FQN
  335.      * @param scenarioName Scenario Name
  336.      * @param scenarioProbability Scenario Probability
  337.      * @param scenarioPnL Scenario PnL
  338.      * 
  339.      * @return TRUE - Idiosyncratic Event successfully created and added to the Capital Unit Event Map
  340.      */

  342.     public boolean addIdiosyncratic (
  343.         final java.lang.String capitalUnitCoordinateFQN,
  344.         final java.lang.String scenarioName,
  345.         final double scenarioProbability,
  346.         final double scenarioPnL)
  347.     {
  348.         try
  349.         {
  350.             if (!_capitalUnitEventMap.containsKey (
  351.                 capitalUnitCoordinateFQN
  352.             ))
  353.             {
  354.                 addSystemic (
  355.                     capitalUnitCoordinateFQN,
  356.                     org.drip.capital.shell.SystemicScenarioPnLSeries.ZERO(),
  357.                     null
  358.                 );
  359.             }

  361.             org.drip.capital.entity.CapitalUnitEventContainer capitalUnitEventContainer =
  362.                 _capitalUnitEventMap.get (
  363.                     capitalUnitCoordinateFQN
  364.                 );

  366.             if (!capitalUnitEventContainer.addIdiosyncraticEvent (
  367.                 new org.drip.capital.stress.Event (
  368.                     new org.drip.capital.stress.EventSpecification (
  369.                         scenarioName,
  370.                         scenarioProbability
  371.                     ),
  372.                     org.drip.capital.stress.PnLSeries.SingleOutcome (
  373.                         scenarioPnL
  374.                     ),
  375.                     null
  376.                 )
  377.             ))
  378.             {
  379.                 return false;
  380.             }

  382.             if (!_capitalUnitEventMap.containsKey (
  383.                 capitalUnitCoordinateFQN
  384.             ))
  385.             {
  386.                 _capitalUnitEventMap.put (
  387.                     capitalUnitCoordinateFQN,
  388.                     capitalUnitEventContainer
  389.                 );
  390.             }

  392.             return true;
  393.         }
  394.         catch (java.lang.Exception e)
  395.         {
  396.             e.printStackTrace();
  397.         }

  399.         return false;
  400.     }

  402.     /**
  403.      * Retrieve all the Capital Unit Coordinates that have Entries in the Coordinate Scenario Stress Map for the
  404.      *  specified Risk Type and Region
  405.      * 
  406.      * @param region Region
  407.      * @param riskType Risk Type
  408.      * 
  409.      * @return The Capital Unit Coordinate Set
  410.      */

  412.     public java.util.Set<java.lang.String> matchingCapitalUnitCoordinateSet (
  413.         final java.lang.String region,
  414.         final java.lang.String riskType)
  415.     {
  416.         if (null == region || region.isEmpty() ||
  417.             null == riskType || riskType.isEmpty())
  418.         {
  419.             return null;
  420.         }

  422.         java.util.Set<java.lang.String> matchingCapitalUnitCoordinateFQNSet =
  423.             new java.util.HashSet<java.lang.String>();

  425.         java.util.Set<java.lang.String> capitalUnitCoordinateFQNSet = _capitalUnitEventMap.keySet();

  427.         for (java.lang.String capitalUnitCoordinateFQN : capitalUnitCoordinateFQNSet)
  428.         {
  429.             org.drip.capital.label.BusinessRegionRiskTypeCoordinate capitalUnitCoordinate =
  430.                 org.drip.capital.label.BusinessRegionRiskTypeCoordinate.Standard (
  431.                     capitalUnitCoordinateFQN
  432.                 );

  434.             if (null == capitalUnitCoordinate)
  435.             {
  436.                 return null;
  437.             }

  439.             if (region.equalsIgnoreCase (
  440.                     capitalUnitCoordinate.region()
  441.                 ) && riskType.equalsIgnoreCase (
  442.                     capitalUnitCoordinate.riskType()
  443.                 )
  444.             )
  445.             {
  446.                 matchingCapitalUnitCoordinateFQNSet.add (
  447.                     capitalUnitCoordinateFQN
  448.                 );
  449.             }
  450.         }

  452.         return matchingCapitalUnitCoordinateFQNSet;
  453.     }

  455.     /**
  456.      * Retrieve all the Capital Unit Coordinates that have Entries in the Coordinate Scenario Stress Map for the
  457.      *  specified Region
  458.      * 
  459.      * @param region Region
  460.      * 
  461.      * @return The Child Coordinate Set
  462.      */

  464.     public java.util.Set<java.lang.String> matchingCapitalUnitCoordinateSet (
  465.         final java.lang.String region)
  466.     {
  467.         if (null == region || region.isEmpty())
  468.         {
  469.             return null;
  470.         }

  472.         java.util.Set<java.lang.String> matchingCapitalUnitCoordinateFQNSet =
  473.             new java.util.HashSet<java.lang.String>();

  475.         java.util.Set<java.lang.String> capitalUnitCoordinateFQNSet = _capitalUnitEventMap.keySet();

  477.         for (java.lang.String capitalUnitCoordinateFQN : capitalUnitCoordinateFQNSet)
  478.         {
  479.             org.drip.capital.label.BusinessRegionRiskTypeCoordinate capitalUnitCoordinate =
  480.                 org.drip.capital.label.BusinessRegionRiskTypeCoordinate.Standard (
  481.                     capitalUnitCoordinateFQN
  482.                 );

  484.             if (null == capitalUnitCoordinate)
  485.             {
  486.                 return null;
  487.             }

  489.             if (region.equalsIgnoreCase (
  490.                 capitalUnitCoordinate.region()
  491.             ))
  492.             {
  493.                 matchingCapitalUnitCoordinateFQNSet.add (
  494.                     capitalUnitCoordinateFQN
  495.                 );
  496.             }
  497.         }

  499.         return matchingCapitalUnitCoordinateFQNSet;
  500.     }

  502.     /**
  503.      * Retrieve the Capital Unit Stress Map
  504.      * 
  505.      * @return The Capital Unit Stress Map
  506.      */

  508.     public java.util.Map<java.lang.String, org.drip.capital.entity.CapitalUnitEventContainer>
  509.         capitalUnitEventMap()
  510.     {
  511.         return _capitalUnitEventMap;
  512.     }
  513. }
Created with JaCoCo 0.7.9.201702052155