CapitalUnitStressScenarioLoader.java

  1. package org.drip.capital.feed;

  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>CapitalUnitStressScenarioLoader</i> loads the Stress Scenario Specifications of a Capital Unit. The
  79.  *  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/feed/README.md">Risk Capital Estimation - Feed Processors</a></li>
  101.  *  </ul>
  102.  * 
  103.  * @author Lakshmi Krishnamurthy
  104.  */

  106. public class CapitalUnitStressScenarioLoader
  107. {

  109.     @SuppressWarnings ("deprecation") private static final double StringToDouble (
  110.         final java.lang.String string)
  111.     {
  112.         if (null == string|| string.isEmpty())
  113.         {
  114.             return 0.;
  115.         }

  117.         try
  118.         {
  119.             return new java.lang.Double (string).doubleValue();
  120.         }
  121.         catch (java.lang.Exception e)
  122.         {
  123.         }

  125.         return 0.;
  126.     }

  128.     /**
  129.      * Load the Capital Unit Correlated Stress Scenarios
  130.      * 
  131.      * @param capitalUnitCorrelatedInputFile Capital Unit Correlated Stress Scenario Specifications File
  132.      * @param skipHeader TRUE - Interpret the First Row as a Header
  133.      * 
  134.      * @return The Map of Capital Unit Correlated Stress Scenarios
  135.      */

  137.     public static final java.util.Map<java.lang.String, org.drip.capital.feed.CapitalUnitCorrelatedScenario>
  138.         LoadCorrelated (
  139.             final java.lang.String capitalUnitCorrelatedInputFile,
  140.             final boolean skipHeader)
  141.     {
  142.         if (null == capitalUnitCorrelatedInputFile || capitalUnitCorrelatedInputFile.isEmpty())
  143.         {
  144.             return null;
  145.         }

  147.         boolean firstLine = true;
  148.         java.lang.String capitalUnitCorrelatedLine = "";
  149.         java.io.BufferedReader capitalUnitCorrelatedBufferedReader = null;

  151.         java.util.Map<java.lang.String, org.drip.capital.feed.CapitalUnitCorrelatedScenario>
  152.             capitalUnitCorrelatedScenarioMap = new
  153.                 org.drip.analytics.support.CaseInsensitiveHashMap<org.drip.capital.feed.CapitalUnitCorrelatedScenario>();

  155.         try
  156.         {
  157.             capitalUnitCorrelatedBufferedReader = new java.io.BufferedReader (
  158.                 new java.io.FileReader (
  159.                     capitalUnitCorrelatedInputFile
  160.                 )
  161.             );

  163.             while (null != (capitalUnitCorrelatedLine = capitalUnitCorrelatedBufferedReader.readLine()))
  164.             {
  165.                 if (firstLine)
  166.                 {
  167.                     firstLine = false;

  169.                     if (skipHeader)
  170.                     {
  171.                         continue;
  172.                     }
  173.                 }

  175.                 java.lang.String[] capitalUnitCorrelatedFieldArray =
  176.                     org.drip.numerical.common.StringUtil.Split (
  177.                         capitalUnitCorrelatedLine,
  178.                         ","
  179.                     );

  181.                 if (null == capitalUnitCorrelatedFieldArray || 9 > capitalUnitCorrelatedFieldArray.length)
  182.                 {
  183.                     return null;
  184.                 }

  186.                 capitalUnitCorrelatedScenarioMap.put (
  187.                     new org.drip.capital.label.CapitalUnitCoordinate (
  188.                         capitalUnitCorrelatedFieldArray[0],
  189.                         capitalUnitCorrelatedFieldArray[2]
  190.                     ).fullyQualifiedName(),
  191.                     new org.drip.capital.feed.CapitalUnitCorrelatedScenario (
  192.                         capitalUnitCorrelatedFieldArray[1],
  193.                         capitalUnitCorrelatedFieldArray[3],
  194.                         org.drip.capital.shell.SystemicScenarioPnLSeries.SingleOutcome (
  195.                             StringToDouble (
  196.                                 capitalUnitCorrelatedFieldArray[7]
  197.                             ), StringToDouble (
  198.                                 capitalUnitCorrelatedFieldArray[8]
  199.                             ), StringToDouble (
  200.                                 capitalUnitCorrelatedFieldArray[4]
  201.                             ),
  202.                             0.,
  203.                             StringToDouble (
  204.                                 capitalUnitCorrelatedFieldArray[6]
  205.                             ),
  206.                             StringToDouble (
  207.                                 capitalUnitCorrelatedFieldArray[5]
  208.                             )
  209.                         )
  210.                     )
  211.                 );
  212.             }
  213.         }
  214.         catch (java.lang.Exception e1)
  215.         {
  216.             e1.printStackTrace();
  217.         }
  218.         finally
  219.         {
  220.             try
  221.             {
  222.                 capitalUnitCorrelatedBufferedReader.close();
  223.             }
  224.             catch (java.lang.Exception e2)
  225.             {
  226.                 capitalUnitCorrelatedBufferedReader = null;
  227.             }
  228.         }

  230.         return capitalUnitCorrelatedScenarioMap;
  231.     }

  233.     /**
  234.      * Load the Capital Unit Idiosyncratic Stress Scenarios
  235.      * 
  236.      * @param capitalUnitIdiosyncraticInputFile Capital Unit Idiosyncratic Stress Scenario Specifications
  237.      *  File
  238.      * @param skipHeader TRUE - Interpret the First Row as a Header
  239.      * 
  240.      * @return The Map of Capital Unit Idiosyncratic Stress Scenarios
  241.      */

  243.     public static final java.util.Map<java.lang.String, org.drip.capital.feed.CapitalUnitIdiosyncraticScenario>
  244.         LoadIdiosyncratic (
  245.             final java.lang.String capitalUnitIdiosyncraticInputFile,
  246.             final boolean skipHeader)
  247.     {
  248.         if (null == capitalUnitIdiosyncraticInputFile || capitalUnitIdiosyncraticInputFile.isEmpty())
  249.         {
  250.             return null;
  251.         }

  253.         boolean firstLine = true;
  254.         java.lang.String capitalUnitIdiosyncraticLine = "";
  255.         java.io.BufferedReader capitalUnitIdiosyncraticBufferedReader = null;

  257.         java.util.Map<java.lang.String, org.drip.capital.feed.CapitalUnitIdiosyncraticScenario>
  258.             capitalUnitIdiosyncraticScenarioMap = new
  259.                 org.drip.analytics.support.CaseInsensitiveTreeMap<org.drip.capital.feed.CapitalUnitIdiosyncraticScenario>();

  261.         try
  262.         {
  263.             capitalUnitIdiosyncraticBufferedReader = new java.io.BufferedReader (
  264.                 new java.io.FileReader (
  265.                     capitalUnitIdiosyncraticInputFile
  266.                 )
  267.             );

  269.             while (null != (capitalUnitIdiosyncraticLine =
  270.                 capitalUnitIdiosyncraticBufferedReader.readLine()))
  271.             {
  272.                 if (firstLine)
  273.                 {
  274.                     firstLine = false;

  276.                     if (skipHeader)
  277.                     {
  278.                         continue;
  279.                     }
  280.                 }

  282.                 java.lang.String[] capitalUnitIdiosyncraticFieldArray =
  283.                     org.drip.numerical.common.StringUtil.Split (
  284.                         capitalUnitIdiosyncraticLine,
  285.                         ","
  286.                     );

  288.                 if (null == capitalUnitIdiosyncraticFieldArray ||
  289.                     6 > capitalUnitIdiosyncraticFieldArray.length)
  290.                 {
  291.                     return null;
  292.                 }

  294.                 capitalUnitIdiosyncraticScenarioMap.put (
  295.                     new org.drip.capital.label.CapitalUnitCoordinate (
  296.                         capitalUnitIdiosyncraticFieldArray[0],
  297.                         capitalUnitIdiosyncraticFieldArray[2]
  298.                     ).fullyQualifiedName(),
  299.                     new org.drip.capital.feed.CapitalUnitIdiosyncraticScenario (
  300.                         capitalUnitIdiosyncraticFieldArray[1],
  301.                         capitalUnitIdiosyncraticFieldArray[3],
  302.                         StringToDouble (
  303.                             capitalUnitIdiosyncraticFieldArray[4]
  304.                         ), StringToDouble (
  305.                             capitalUnitIdiosyncraticFieldArray[5]
  306.                         )
  307.                     )
  308.                 );
  309.             }
  310.         }
  311.         catch (java.lang.Exception e1)
  312.         {
  313.             e1.printStackTrace();
  314.         }
  315.         finally
  316.         {
  317.             try
  318.             {
  319.                 capitalUnitIdiosyncraticBufferedReader.close();
  320.             }
  321.             catch (java.lang.Exception e2)
  322.             {
  323.                 capitalUnitIdiosyncraticBufferedReader = null;
  324.             }
  325.         }

  327.         return capitalUnitIdiosyncraticScenarioMap;
  328.     }

  330.     /**
  331.      * Load the Capital Unit Systemic Stress Scenarios
  332.      * 
  333.      * @param capitalUnitSystemicInputFile Capital Unit Systemic Stress Scenario Specifications File
  334.      * @param skipHeader TRUE - Interpret the First Row as a Header
  335.      * 
  336.      * @return The Map of Capital Unit Systemic Stress Scenarios
  337.      */

  339.     public static final java.util.Map<java.lang.String, org.drip.capital.shell.SystemicScenarioPnLSeriesPAA>
  340.         LoadSystemic (
  341.             final java.lang.String capitalUnitSystemicInputFile,
  342.             final boolean skipHeader)
  343.     {
  344.         if (null == capitalUnitSystemicInputFile || capitalUnitSystemicInputFile.isEmpty())
  345.         {
  346.             return null;
  347.         }

  349.         boolean firstLine = true;
  350.         int capitalUnitLineIndex = 0;
  351.         int capitalUnitLineArrayCount = 6;
  352.         java.lang.String capitalUnitSystemicLine = "";
  353.         java.io.BufferedReader capitalUnitSystemicBufferedReader = null;
  354.         java.lang.String[] capitalUnitLineArray = new java.lang.String[capitalUnitLineArrayCount];

  356.         java.util.Map<java.lang.String, org.drip.capital.shell.SystemicScenarioPnLSeriesPAA>
  357.             capitalUnitSystemicPAAMap = new
  358.                 org.drip.analytics.support.CaseInsensitiveTreeMap<org.drip.capital.shell.SystemicScenarioPnLSeriesPAA>();

  360.         try
  361.         {
  362.             capitalUnitSystemicBufferedReader = new java.io.BufferedReader (
  363.                 new java.io.FileReader (
  364.                     capitalUnitSystemicInputFile
  365.                 )
  366.             );

  368.             while (null != (capitalUnitSystemicLine = capitalUnitSystemicBufferedReader.readLine()))
  369.             {
  370.                 if (firstLine)
  371.                 {
  372.                     firstLine = false;

  374.                     if (skipHeader)
  375.                     {
  376.                         continue;
  377.                     }
  378.                 }

  380.                 capitalUnitLineArray[capitalUnitLineIndex++] = capitalUnitSystemicLine;

  382.                 if (capitalUnitLineArrayCount == capitalUnitLineIndex)
  383.                 {
  384.                     capitalUnitLineIndex = 0;
  385.                     java.lang.String capitalUnitID = "";
  386.                     java.lang.String capitalUnitRiskType = "";

  388.                     org.drip.capital.shell.SystemicScenarioPnLSeriesPAA systemicScenarioPnLPAA =
  389.                         new org.drip.capital.shell.SystemicScenarioPnLSeriesPAA();

  391.                     for (int capitalUnitLineArrayIndex = 0;
  392.                         capitalUnitLineArrayIndex < capitalUnitLineArrayCount;
  393.                         ++capitalUnitLineArrayIndex)
  394.                     {
  395.                         java.lang.String[] capitalUnitLineSystemicFieldArray =
  396.                             org.drip.numerical.common.StringUtil.Split (
  397.                                 capitalUnitLineArray[capitalUnitLineArrayIndex],
  398.                                 ","
  399.                             );

  401.                         if (null == capitalUnitLineSystemicFieldArray ||
  402.                             6 > capitalUnitLineSystemicFieldArray.length)
  403.                         {
  404.                             return null;
  405.                         }

  407.                         if (!systemicScenarioPnLPAA.addDecompositionEntry (
  408.                             capitalUnitLineSystemicFieldArray[4],
  409.                             capitalUnitLineSystemicFieldArray[3],
  410.                             StringToDouble (
  411.                                 capitalUnitLineSystemicFieldArray[5]
  412.                             )
  413.                         ))
  414.                         {
  415.                             return null;
  416.                         }

  418.                         if (0 == capitalUnitLineArrayIndex)
  419.                         {
  420.                             capitalUnitRiskType = capitalUnitLineSystemicFieldArray[0];
  421.                             capitalUnitID = capitalUnitLineSystemicFieldArray[1];
  422.                         }
  423.                     }

  425.                     capitalUnitSystemicPAAMap.put (
  426.                         new org.drip.capital.label.CapitalUnitCoordinate (
  427.                             capitalUnitID,
  428.                             capitalUnitRiskType
  429.                         ).fullyQualifiedName(),
  430.                         systemicScenarioPnLPAA
  431.                     );
  432.                 }
  433.             }
  434.         }
  435.         catch (java.lang.Exception e1)
  436.         {
  437.             e1.printStackTrace();
  438.         }
  439.         finally
  440.         {
  441.             try
  442.             {
  443.                 capitalUnitSystemicBufferedReader.close();
  444.             }
  445.             catch (java.lang.Exception e2)
  446.             {
  447.                 capitalUnitSystemicBufferedReader = null;
  448.             }
  449.         }

  451.         return capitalUnitSystemicPAAMap;
  452.     }

  454.     /**
  455.      * Load the Capital Unit Stress Scenarios
  456.      * 
  457.      * @param capitalUnitCorrelatedInputFile Capital Unit Correlated Stress Scenario Specifications File
  458.      * @param capitalUnitIdiosyncraticInputFile Capital Unit Idiosyncratic Stress Scenario Specifications
  459.      *  File
  460.      * @param capitalUnitSystemicInputFile Capital Unit Systemic Stress Scenario Specifications File
  461.      * @param skipHeader TRUE - Interpret the First Row as a Header
  462.      * 
  463.      * @return The Map of Capital Unit Stress Scenarios
  464.      */

  466.     public static final org.drip.capital.shell.CapitalUnitStressEventContext LoadStressScenario (
  467.         final java.lang.String capitalUnitCorrelatedInputFile,
  468.         final java.lang.String capitalUnitIdiosyncraticInputFile,
  469.         final java.lang.String capitalUnitSystemicInputFile,
  470.         final boolean skipHeader)
  471.     {

  473.         java.util.Map<String, org.drip.capital.shell.SystemicScenarioPnLSeriesPAA>
  474.             capitalUnitSystemicScenarioMap = LoadSystemic (
  475.                 capitalUnitSystemicInputFile,
  476.                 skipHeader
  477.             );

  479.         if (null == capitalUnitSystemicScenarioMap)
  480.         {
  481.             return null;
  482.         }

  484.         java.util.Map<String, org.drip.capital.feed.CapitalUnitCorrelatedScenario>
  485.             capitalUnitCorrelatedScenarioMap = LoadCorrelated (
  486.                 capitalUnitCorrelatedInputFile,
  487.                 skipHeader
  488.             );

  490.         if (null == capitalUnitCorrelatedScenarioMap)
  491.         {
  492.             return null;
  493.         }

  495.         java.util.Map<String, org.drip.capital.feed.CapitalUnitIdiosyncraticScenario>
  496.             capitalUnitIdiosyncraticScenarioMap = LoadIdiosyncratic (
  497.                 capitalUnitIdiosyncraticInputFile,
  498.                 skipHeader
  499.             );

  501.         if (null == capitalUnitIdiosyncraticScenarioMap)
  502.         {
  503.             return null;
  504.         }

  506.         org.drip.capital.shell.CapitalUnitStressEventContext capitalUnitStressEventContext =
  507.             new org.drip.capital.shell.CapitalUnitStressEventContext();

  509.         java.util.Set<java.lang.String> systemicStressCapitalUnitCoordinateFQNSet =
  510.             capitalUnitSystemicScenarioMap.keySet();

  512.         for (java.lang.String systemicStressCapitalUnitCoordinateFQN :
  513.             systemicStressCapitalUnitCoordinateFQNSet)
  514.         {
  515.             org.drip.capital.shell.SystemicScenarioPnLSeriesPAA scenarioPnLPAA =
  516.                 capitalUnitSystemicScenarioMap.get (
  517.                     systemicStressCapitalUnitCoordinateFQN
  518.                 );

  520.             if (!capitalUnitStressEventContext.addSystemic (
  521.                 systemicStressCapitalUnitCoordinateFQN,
  522.                 scenarioPnLPAA.aggregatePnL(),
  523.                 scenarioPnLPAA
  524.             ))
  525.             {
  526.                 return null;
  527.             }
  528.         }

  530.         java.util.Set<java.lang.String> correlatedScenarioCapitalUnitCoordinateFQNSet =
  531.             capitalUnitCorrelatedScenarioMap.keySet();

  533.         for (java.lang.String correlatedScenarioCapitalUnitCoordinateFQN :
  534.             correlatedScenarioCapitalUnitCoordinateFQNSet)
  535.         {
  536.             org.drip.capital.feed.CapitalUnitCorrelatedScenario capitalUnitCorrelatedScenario =
  537.                 capitalUnitCorrelatedScenarioMap.get (
  538.                     correlatedScenarioCapitalUnitCoordinateFQN
  539.                 );

  541.             if (!capitalUnitStressEventContext.addCorrelated (
  542.                 correlatedScenarioCapitalUnitCoordinateFQN,
  543.                 capitalUnitCorrelatedScenario.scenarioName(),
  544.                 capitalUnitCorrelatedScenario.scenarioPnL()
  545.             ))
  546.             {
  547.                 return null;
  548.             }
  549.         }

  551.         java.util.Set<java.lang.String> idiosyncraticScenarioCapitalUnitCoordinateFQNSet =
  552.             capitalUnitIdiosyncraticScenarioMap.keySet();

  554.         for (java.lang.String capitalUnitCoordinateFQN : idiosyncraticScenarioCapitalUnitCoordinateFQNSet)
  555.         {
  556.             org.drip.capital.feed.CapitalUnitIdiosyncraticScenario capitalUnitIdiosyncraticScenario =
  557.                 capitalUnitIdiosyncraticScenarioMap.get (
  558.                     capitalUnitCoordinateFQN
  559.                 );

  561.             if (!capitalUnitStressEventContext.addIdiosyncratic (
  562.                 capitalUnitCoordinateFQN,
  563.                 capitalUnitIdiosyncraticScenario.scenarioName(),
  564.                 capitalUnitIdiosyncraticScenario.probability(),
  565.                 capitalUnitIdiosyncraticScenario.pnl()
  566.             ))
  567.             {
  568.                 return null;
  569.             }
  570.         }

  572.         return capitalUnitStressEventContext;
  573.     }
  574. }
Created with JaCoCo 0.7.9.201702052155