MarginEstimationSettings.java

  1. package org.drip.simm.foundation;

  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>MarginEstimationSettings</i> exposes the Customization Settings used in the Margin Estimation. 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/foundation/README.md">Foundation Utilities for ISDA SIMM</a></li>
  114.  *  </ul>
  115.  * <br><br>
  116.  * 
  117.  * @author Lakshmi Krishnamurthy
  118.  */

  120. public class MarginEstimationSettings
  121. {

  123.     /**
  124.      * FRTB Based Position - Principal Component Estimator
  125.      */

  127.     public static final java.lang.String POSITION_PRINCIPAL_COMPONENT_COVARIANCE_ESTIMATOR_FRTB = "FRTB";

  129.     /**
  130.      * ISDA Based Position - Principal Component Estimator
  131.      */

  133.     public static final java.lang.String POSITION_PRINCIPAL_COMPONENT_COVARIANCE_ESTIMATOR_ISDA = "ISDA";

  135.     private java.lang.String _positionPrincipalComponentScheme = "";
  136.     private org.drip.simm.foundation.CurvatureEstimator _curvatureEstimator = null;

  138.     /**
  139.      * Generate a Cornish-Fischer Instance of MarginEstimationSettings
  140.      * 
  141.      * @param positionPrincipalComponentScheme The Position Principal Component Scheme
  142.      * 
  143.      * @return Cornish-Fischer Instance of MarginEstimationSettings
  144.      */

  146.     public static final MarginEstimationSettings CornishFischer (
  147.         final java.lang.String positionPrincipalComponentScheme)
  148.     {
  149.         try
  150.         {
  151.             return new MarginEstimationSettings (
  152.                 positionPrincipalComponentScheme,
  153.                 org.drip.simm.foundation.CurvatureEstimatorResponseFunction.CornishFischer()
  154.             );
  155.         }
  156.         catch (java.lang.Exception e)
  157.         {
  158.             e.printStackTrace();
  159.         }

  161.         return null;
  162.     }

  164.     /**
  165.      * Generate a ISDA Delta Instance of MarginEstimationSettings
  166.      * 
  167.      * @param positionPrincipalComponentScheme The Position Principal Component Scheme
  168.      * 
  169.      * @return ISDA Delta Instance of MarginEstimationSettings
  170.      */

  172.     public static final MarginEstimationSettings ISDADelta (
  173.         final java.lang.String positionPrincipalComponentScheme)
  174.     {
  175.         try
  176.         {
  177.             return new MarginEstimationSettings (
  178.                 positionPrincipalComponentScheme,
  179.                 org.drip.simm.foundation.CurvatureEstimatorISDADelta.Standard()
  180.             );
  181.         }
  182.         catch (java.lang.Exception e)
  183.         {
  184.             e.printStackTrace();
  185.         }

  187.         return null;
  188.     }

  190.     /**
  191.      * Generate an FRTB Instance of MarginEstimationSettings
  192.      * 
  193.      * @param positionPrincipalComponentScheme The Position Principal Component Scheme
  194.      * 
  195.      * @return FRTB Instance of MarginEstimationSettings
  196.      */

  198.     public static final MarginEstimationSettings FRTB (
  199.         final java.lang.String positionPrincipalComponentScheme)
  200.     {
  201.         try
  202.         {
  203.             return new MarginEstimationSettings (
  204.                 positionPrincipalComponentScheme,
  205.                 org.drip.simm.foundation.CurvatureEstimatorFRTB.Standard()
  206.             );
  207.         }
  208.         catch (java.lang.Exception e)
  209.         {
  210.             e.printStackTrace();
  211.         }

  213.         return null;
  214.     }

  216.     /**
  217.      * MarginEstimationSettings Constructor
  218.      * 
  219.      * @param positionPrincipalComponentScheme The Position Principal Component Scheme
  220.      * @param curvatureEstimator The Curvature Estimator Function
  221.      * 
  222.      * @throws java.lang.Exception Throwm if the Inputs are Invalid
  223.      */

  225.     public MarginEstimationSettings (
  226.         final java.lang.String positionPrincipalComponentScheme,
  227.         final org.drip.simm.foundation.CurvatureEstimator curvatureEstimator)
  228.         throws java.lang.Exception
  229.     {
  230.         if (null == (_positionPrincipalComponentScheme = positionPrincipalComponentScheme) ||
  231.             _positionPrincipalComponentScheme.isEmpty() ||
  232.             null == (_curvatureEstimator = curvatureEstimator))
  233.         {
  234.             throw new java.lang.Exception ("MarginEstimationSettings Constructor => Invalid Inputs");
  235.         }
  236.     }

  238.     /**
  239.      * Retrieve the Position Principal Component Scheme
  240.      * 
  241.      * @return The Position Principal Component Scheme
  242.      */

  244.     public java.lang.String positionPrincipalComponentScheme()
  245.     {
  246.         return _positionPrincipalComponentScheme;
  247.     }

  249.     /**
  250.      * Retrieve the Curvature Estimator Function
  251.      * 
  252.      * @return The Curvature Estimator Function
  253.      */

  255.     public org.drip.simm.foundation.CurvatureEstimator curvatureEstimator()
  256.     {
  257.         return _curvatureEstimator;
  258.     }
  259. }
Created with JaCoCo 0.7.9.201702052155