RiskMeasureSensitivityIR.java

  1. package org.drip.simm.product;

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

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

  120. public class RiskMeasureSensitivityIR
  121. {
  122.     private java.util.Map<java.lang.String, org.drip.simm.product.BucketSensitivityIR> _bucketSensitivityMap
  123.         = null;

  125.     private static final double PositionPrincipalComponentCovariance (
  126.         final org.drip.simm.margin.BucketAggregateIR bucketAggregate,
  127.         final org.drip.simm.foundation.MarginEstimationSettings marginEstimationSettings)
  128.         throws java.lang.Exception
  129.     {
  130.         java.lang.String positionPrincipalComponentScheme =
  131.             marginEstimationSettings.positionPrincipalComponentScheme();

  133.         if (positionPrincipalComponentScheme.equalsIgnoreCase
  134.             (org.drip.simm.foundation.MarginEstimationSettings.POSITION_PRINCIPAL_COMPONENT_COVARIANCE_ESTIMATOR_FRTB))
  135.         {
  136.             return bucketAggregate.positionPrincipalComponentCovarianceFRTB();
  137.         }

  139.         if (positionPrincipalComponentScheme.equalsIgnoreCase
  140.             (org.drip.simm.foundation.MarginEstimationSettings.POSITION_PRINCIPAL_COMPONENT_COVARIANCE_ESTIMATOR_ISDA))
  141.         {
  142.             return bucketAggregate.positionPrincipalComponentCovarianceISDA();
  143.         }

  145.         throw new java.lang.Exception
  146.             ("RiskMeasureSensitivityIR::PositionPrincipalComponentCovariance => Invalid Inputs");
  147.     }

  149.     /**
  150.      * RiskMeasureSensitivityIR Constructor
  151.      * 
  152.      * @param bucketSensitivityMap The IR Class Bucket Sensitivity Map
  153.      * 
  154.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  155.      */

  157.     public RiskMeasureSensitivityIR (
  158.         final java.util.Map<java.lang.String, org.drip.simm.product.BucketSensitivityIR>
  159.             bucketSensitivityMap)
  160.         throws java.lang.Exception
  161.     {
  162.         if (null == (_bucketSensitivityMap = bucketSensitivityMap) || 0 == _bucketSensitivityMap.size())
  163.         {
  164.             throw new java.lang.Exception ("RiskMeasureSensitivityIR Constructor => Invalid Inputs");
  165.         }
  166.     }

  168.     /**
  169.      * Retrieve the Risk Class Bucket Sensitivity Map
  170.      * 
  171.      * @return The Risk Class Bucket Sensitivity Map
  172.      */

  174.     public java.util.Map<java.lang.String, org.drip.simm.product.BucketSensitivityIR>
  175.         bucketSensitivityMap()
  176.     {
  177.         return _bucketSensitivityMap;
  178.     }

  180.     /**
  181.      * Generate the Linear Risk Measure Aggregate
  182.      * 
  183.      * @param riskMeasureSensitivitySettings The Risk Measure Sensitivity Settings
  184.      * @param marginEstimationSettings Margin Estimation Settings
  185.      * 
  186.      * @return The Linear Risk Measure Aggregate
  187.      */

  189.     public org.drip.simm.margin.RiskMeasureAggregateIR linearAggregate (
  190.         final org.drip.simm.parameters.RiskMeasureSensitivitySettingsIR riskMeasureSensitivitySettings,
  191.         final org.drip.simm.foundation.MarginEstimationSettings marginEstimationSettings)
  192.     {
  193.         if (null == riskMeasureSensitivitySettings ||
  194.             null == marginEstimationSettings)
  195.         {
  196.             return null;
  197.         }

  199.         double coreSBAVariance = 0.;

  201.         java.util.Map<java.lang.String, org.drip.simm.margin.BucketAggregateIR> bucketAggregateMap = new
  202.             java.util.TreeMap<java.lang.String, org.drip.simm.margin.BucketAggregateIR>();

  204.         java.util.Map<java.lang.String, org.drip.simm.parameters.BucketSensitivitySettingsIR>
  205.             bucketSensitivitySettingsMap = riskMeasureSensitivitySettings.bucketSensitivitySettingsMap();

  207.         org.drip.measure.stochastic.LabelCorrelation crossBucketCorrelation =
  208.             riskMeasureSensitivitySettings.crossBucketCorrelation();

  210.         for (java.util.Map.Entry<java.lang.String, org.drip.simm.product.BucketSensitivityIR>
  211.             bucketSensitivityMapEntry : _bucketSensitivityMap.entrySet())
  212.         {
  213.             java.lang.String bucketIndex = bucketSensitivityMapEntry.getKey();

  215.             org.drip.simm.product.BucketSensitivityIR bucketSensitivity =
  216.                 bucketSensitivityMapEntry.getValue();

  218.             org.drip.simm.margin.BucketAggregateIR bucketAggregate = bucketSensitivity.aggregate
  219.                 (bucketSensitivitySettingsMap.get (bucketIndex));

  221.             if (null == bucketAggregate)
  222.             {
  223.                 return null;
  224.             }

  226.             bucketAggregateMap.put (
  227.                 "" + bucketIndex,
  228.                 bucketAggregate
  229.             );
  230.         }

  232.         try
  233.         {
  234.             for (java.util.Map.Entry<java.lang.String, org.drip.simm.margin.BucketAggregateIR>
  235.                 bucketAggregateMapOuterEntry : bucketAggregateMap.entrySet())
  236.             {
  237.                 java.lang.String outerKey = bucketAggregateMapOuterEntry.getKey();

  239.                 org.drip.simm.margin.BucketAggregateIR bucketAggregateOuter =
  240.                     bucketAggregateMapOuterEntry.getValue();

  242.                 double weightedSensitivityVarianceOuter = bucketAggregateOuter.sensitivityMarginVariance();

  244.                 double positionPrincipalComponentCovarianceOuter = PositionPrincipalComponentCovariance (
  245.                     bucketAggregateOuter,
  246.                     marginEstimationSettings
  247.                 );

  249.                 for (java.util.Map.Entry<java.lang.String, org.drip.simm.margin.BucketAggregateIR>
  250.                     bucketAggregateMapInnerEntry : bucketAggregateMap.entrySet())
  251.                 {
  252.                     java.lang.String innerKey = bucketAggregateMapInnerEntry.getKey();

  254.                     coreSBAVariance = coreSBAVariance + (outerKey.equalsIgnoreCase (innerKey) ?
  255.                         weightedSensitivityVarianceOuter : crossBucketCorrelation.entry (
  256.                             outerKey,
  257.                             innerKey
  258.                         ) * positionPrincipalComponentCovarianceOuter *
  259.                         PositionPrincipalComponentCovariance (
  260.                             bucketAggregateMapInnerEntry.getValue(),
  261.                             marginEstimationSettings
  262.                         )
  263.                     );
  264.                 }
  265.             }

  267.             return new org.drip.simm.margin.RiskMeasureAggregateIR (
  268.                 bucketAggregateMap,
  269.                 coreSBAVariance,
  270.                 0.
  271.             );
  272.         }
  273.         catch (java.lang.Exception e)
  274.         {
  275.             e.printStackTrace();
  276.         }

  278.         return null;
  279.     }

  281.     /**
  282.      * Generate the Curvature Risk Measure Aggregate
  283.      * 
  284.      * @param riskMeasureSensitivitySettings The Risk Measure Sensitivity Settings
  285.      * @param marginEstimationSettings Margin Estimation Settings
  286.      * 
  287.      * @return The Curvature Risk Measure Aggregate
  288.      */

  290.     public org.drip.simm.margin.RiskMeasureAggregateIR curvatureAggregate (
  291.         final org.drip.simm.parameters.RiskMeasureSensitivitySettingsIR riskMeasureSensitivitySettings,
  292.         final org.drip.simm.foundation.MarginEstimationSettings marginEstimationSettings)
  293.     {
  294.         if (null == riskMeasureSensitivitySettings || null == marginEstimationSettings)
  295.         {
  296.             return null;
  297.         }

  299.         double coreSBAVariance = 0.;
  300.         double cumulativeRiskFactorSensitivityMarginCore = 0.;
  301.         double cumulativeRiskFactorSensitivityMarginCorePositive = 0.;

  303.         java.util.Map<java.lang.String, org.drip.simm.margin.BucketAggregateIR> bucketAggregateMap = new
  304.             java.util.TreeMap<java.lang.String, org.drip.simm.margin.BucketAggregateIR>();

  306.         java.util.Map<java.lang.String, org.drip.simm.parameters.BucketSensitivitySettingsIR>
  307.             bucketSensitivitySettingsMap = riskMeasureSensitivitySettings.bucketSensitivitySettingsMap();

  309.         org.drip.measure.stochastic.LabelCorrelation crossBucketCorrelation =
  310.             riskMeasureSensitivitySettings.crossBucketCorrelation();

  312.         org.drip.simm.foundation.CurvatureEstimator curvatureEstimator =
  313.             marginEstimationSettings.curvatureEstimator();

  315.         boolean isCorrelatorQuadratric = curvatureEstimator.isCorrelatorQuadratric();

  317.         for (java.util.Map.Entry<java.lang.String, org.drip.simm.product.BucketSensitivityIR>
  318.             bucketSensitivityMapEntry : _bucketSensitivityMap.entrySet())
  319.         {
  320.             java.lang.String bucketIndex = bucketSensitivityMapEntry.getKey();

  322.             org.drip.simm.product.BucketSensitivityIR bucketSensitivity =
  323.                 bucketSensitivityMapEntry.getValue();

  325.             org.drip.simm.margin.BucketAggregateIR bucketAggregate = bucketSensitivity.aggregate
  326.                 (bucketSensitivitySettingsMap.get (bucketIndex));

  328.             if (null == bucketAggregate)
  329.             {
  330.                 return null;
  331.             }

  333.             double bucketCumulativeRiskFactorSensitivityMargin =
  334.                 bucketAggregate.cumulativeSensitivityMargin();

  336.             cumulativeRiskFactorSensitivityMarginCore = cumulativeRiskFactorSensitivityMarginCore +
  337.                 bucketCumulativeRiskFactorSensitivityMargin;

  339.             cumulativeRiskFactorSensitivityMarginCorePositive =
  340.                 cumulativeRiskFactorSensitivityMarginCorePositive +
  341.                 java.lang.Math.max (
  342.                     bucketCumulativeRiskFactorSensitivityMargin,
  343.                     0.
  344.                 );

  346.             bucketAggregateMap.put (
  347.                 bucketIndex,
  348.                 bucketAggregate
  349.             );
  350.         }

  352.         try
  353.         {
  354.             for (java.util.Map.Entry<java.lang.String, org.drip.simm.margin.BucketAggregateIR>
  355.                 bucketAggregateMapOuterEntry : bucketAggregateMap.entrySet())
  356.             {
  357.                 java.lang.String outerKey = bucketAggregateMapOuterEntry.getKey();

  359.                 org.drip.simm.margin.BucketAggregateIR bucketAggregateOuter =
  360.                     bucketAggregateMapOuterEntry.getValue();

  362.                 double weightedSensitivityVarianceOuter = bucketAggregateOuter.sensitivityMarginVariance();

  364.                 double positionPrincipalComponentCovarianceOuter = PositionPrincipalComponentCovariance (
  365.                     bucketAggregateOuter,
  366.                     marginEstimationSettings
  367.                 );

  369.                 for (java.util.Map.Entry<java.lang.String, org.drip.simm.margin.BucketAggregateIR>
  370.                     bucketAggregateMapInnerEntry : bucketAggregateMap.entrySet())
  371.                 {
  372.                     java.lang.String innerKey = bucketAggregateMapInnerEntry.getKey();

  374.                     if (outerKey.equalsIgnoreCase (innerKey))
  375.                     {
  376.                         coreSBAVariance = coreSBAVariance + weightedSensitivityVarianceOuter;
  377.                     }
  378.                     else
  379.                     {
  380.                         double correlation = crossBucketCorrelation.entry (
  381.                             "" + outerKey,
  382.                             "" + innerKey
  383.                         );

  385.                         double curvatureCorrelation = isCorrelatorQuadratric ? correlation * correlation
  386.                             : correlation;

  388.                         org.drip.simm.margin.BucketAggregateIR bucketAggregateInner =
  389.                             bucketAggregateMapInnerEntry.getValue();

  391.                         coreSBAVariance = coreSBAVariance + curvatureCorrelation *
  392.                             positionPrincipalComponentCovarianceOuter *
  393.                             curvatureEstimator.varianceModulator (
  394.                                 outerKey,
  395.                                 weightedSensitivityVarianceOuter,
  396.                                 innerKey,
  397.                                 bucketAggregateInner.sensitivityMarginVariance()
  398.                             ) * PositionPrincipalComponentCovariance (
  399.                                 bucketAggregateInner,
  400.                                 marginEstimationSettings
  401.                             );
  402.                     }
  403.                 }
  404.             }

  406.             double coreSBAMargin = curvatureEstimator.margin (
  407.                 cumulativeRiskFactorSensitivityMarginCore,
  408.                 cumulativeRiskFactorSensitivityMarginCorePositive,
  409.                 coreSBAVariance
  410.             );

  412.             return new org.drip.simm.margin.RiskMeasureAggregateIR (
  413.                 bucketAggregateMap,
  414.                 coreSBAMargin * coreSBAMargin,
  415.                 0.
  416.             );
  417.         }
  418.         catch (java.lang.Exception e)
  419.         {
  420.             e.printStackTrace();
  421.         }

  423.         return null;
  424.     }
  425. }
Created with JaCoCo 0.7.9.201702052155