BalanceSheet.java

  1. package org.drip.capital.bcbs;

  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>BalanceSheet</i> holds the Quantities used to compute the Capital/Liquidity Ratios in the BCBS
  79.  * Standards. The References are:
  80.  *  
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Basel Committee on Banking Supervision (2017): Basel III Leverage Ratio Framework and Disclosure
  85.  *              Requirements https://www.bis.org/publ/bcbs270.pdf
  86.  *      </li>
  87.  *      <li>
  88.  *          Central Banking (2013): Fed and FDIC agree 6% Leverage Ratio for US SIFIs
  89.  *              https://www.centralbanking.com/central-banking/news/2280726/fed-and-fdic-agree-6-leverage-ratio-for-us-sifis
  90.  *      </li>
  91.  *      <li>
  92.  *          European Banking Agency (2013): Implementing Basel III in Europe: CRD IV Package
  93.  *              https://eba.europa.eu/regulation-and-policy/implementing-basel-iii-europe
  94.  *      </li>
  95.  *      <li>
  96.  *          Federal Reserve (2013): Liquidity Coverage Ratio – Liquidity Risk Measurements, Standards, and
  97.  *              Monitoring
  98.  *              https://web.archive.org/web/20131102074614/http:/www.federalreserve.gov/FR_notice_lcr_20131024.pdf
  99.  *      </li>
  100.  *      <li>
  101.  *          Wikipedia (2018): Basel III https://en.wikipedia.org/wiki/Basel_III
  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/CapitalAnalyticsLibrary.md">Capital Analytics</a></li>
  109.  *      <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>
  110.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/capital/bcbs/README.md">BCBS and Jurisdictional Capital Ratios</a></li>
  111.  *  </ul>
  112.  * 
  113.  * @author Lakshmi Krishnamurthy
  114.  */

  116. public class BalanceSheet
  117. {
  118.     private org.drip.capital.bcbs.BalanceSheetCapital _balanceSheetCapital = null;
  119.     private org.drip.capital.bcbs.BalanceSheetFunding _balanceSheetFunding = null;
  120.     private org.drip.capital.bcbs.BalanceSheetLiquidity _balanceSheetLiquidity = null;

  122.     /**
  123.      * BalanceSheet Constructor
  124.      * 
  125.      * @param balanceSheetCapital Balance Sheet Capital Composite
  126.      * @param balanceSheetLiquidity Balance Sheet Liquidity Composite
  127.      * @param balanceSheetFunding Balance Sheet Funding Composite
  128.      * 
  129.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  130.      */

  132.     public BalanceSheet (
  133.         final org.drip.capital.bcbs.BalanceSheetCapital balanceSheetCapital,
  134.         final org.drip.capital.bcbs.BalanceSheetLiquidity balanceSheetLiquidity,
  135.         final org.drip.capital.bcbs.BalanceSheetFunding balanceSheetFunding)
  136.         throws java.lang.Exception
  137.     {
  138.         if (null == (_balanceSheetCapital = balanceSheetCapital) ||
  139.             null == (_balanceSheetLiquidity = balanceSheetLiquidity) ||
  140.             null == (_balanceSheetFunding = balanceSheetFunding))
  141.         {
  142.             throw new java.lang.Exception ("BalanceSheet Constructor => Invalid Inputs");
  143.         }
  144.     }

  146.     /**
  147.      * Retrieve the Balance Sheet Capital Composite
  148.      * 
  149.      * @return The Balance Sheet Capital Composite
  150.      */

  152.     public org.drip.capital.bcbs.BalanceSheetCapital balanceSheetCapital()
  153.     {
  154.         return _balanceSheetCapital;
  155.     }

  157.     /**
  158.      * Retrieve the Balance Sheet Liquidity Composite
  159.      * 
  160.      * @return The Balance Sheet Liquidity Composite
  161.      */

  163.     public org.drip.capital.bcbs.BalanceSheetLiquidity balanceSheetLiquidity()
  164.     {
  165.         return _balanceSheetLiquidity;
  166.     }

  168.     /**
  169.      * Retrieve the Balance Sheet Funding Composite
  170.      * 
  171.      * @return The Balance Sheet Funding Composite
  172.      */

  174.     public org.drip.capital.bcbs.BalanceSheetFunding balanceSheetFunding()
  175.     {
  176.         return _balanceSheetFunding;
  177.     }

  179.     /**
  180.      * Retrieve the Tier 1 Capital
  181.      * 
  182.      * @return The Tier 1 Capital
  183.      */

  185.     public double tier1()
  186.     {
  187.         return _balanceSheetCapital.tier1();
  188.     }

  190.     /**
  191.      * Retrieve the Total Capital
  192.      * 
  193.      * @return The Total Capital
  194.      */

  196.     public double totalCapital()
  197.     {
  198.         return _balanceSheetCapital.totalCapital();
  199.     }

  201.     /**
  202.      * Retrieve the CET 1 Ratio
  203.      * 
  204.      * @return The CET 1 Ratio
  205.      */

  207.     public double cet1Ratio()
  208.     {
  209.         return _balanceSheetCapital.cet1Ratio();
  210.     }

  212.     /**
  213.      * Retrieve the Tier 1 Ratio
  214.      * 
  215.      * @return The Tier 1 Ratio
  216.      */

  218.     public double tier1Ratio()
  219.     {
  220.         return _balanceSheetCapital.tier1Ratio();
  221.     }

  223.     /**
  224.      * Retrieve the Total Capital Ratio
  225.      * 
  226.      * @return The Total Capital Ratio
  227.      */

  229.     public double totalCapitalRatio()
  230.     {
  231.         return _balanceSheetCapital.totalCapitalRatio();
  232.     }

  234.     /**
  235.      * Retrieve the Leverage Ratio
  236.      * 
  237.      * @return The Leverage Ratio
  238.      */

  240.     public double leverageRatio()
  241.     {
  242.         return _balanceSheetCapital.leverageRatio();
  243.     }

  245.     /**
  246.      * Retrieve the Liquidity Coverage Ratio
  247.      *  
  248.      * @param hqlaSettings THe HQLA Settings
  249.      * 
  250.      * @return The Liquidity Coverage Ratio
  251.      * 
  252.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  253.      */

  255.     public double liquidityCoverageRatio (
  256.         final org.drip.capital.bcbs.HighQualityLiquidAssetSettings hqlaSettings)
  257.         throws java.lang.Exception
  258.     {
  259.         return _balanceSheetLiquidity.liquidityCoverageRatio (hqlaSettings);
  260.     }

  262.     /**
  263.      * Retrieve the Net Stable Funding Ratio
  264.      * 
  265.      * @return The Net Stable Funding Ratio
  266.      */

  268.     public double netStableFundingRatio()
  269.     {
  270.         return _balanceSheetFunding.netStableFundingRatio();
  271.     }

  273.     /**
  274.      * Generate the Balance Sheet Capital Metrics
  275.      * 
  276.      * @return The Balance Sheet Capital Metrics
  277.      */

  279.     public org.drip.capital.bcbs.CapitalMetrics capitalMetrics()
  280.     {
  281.         return _balanceSheetCapital.capitalMetrics();
  282.     }

  284.     /**
  285.      * Generate the Balance Sheet Liquidity Metrics
  286.      *  
  287.      * @param hqlaSettings The HQLA Settings
  288.      * 
  289.      * @return The Balance Sheet Liquidity Metrics
  290.      */

  292.     public org.drip.capital.bcbs.LiquidityMetrics liquidityMetrics (
  293.         final org.drip.capital.bcbs.HighQualityLiquidAssetSettings hqlaSettings)
  294.     {
  295.         try
  296.         {
  297.             return new org.drip.capital.bcbs.LiquidityMetrics (
  298.                 _balanceSheetLiquidity.liquidityCoverageRatio (hqlaSettings),
  299.                 _balanceSheetFunding.netStableFundingRatio()
  300.             );
  301.         }
  302.         catch (java.lang.Exception e)
  303.         {
  304.             e.printStackTrace();
  305.         }

  307.         return null;
  308.     }
  309. }
Created with JaCoCo 0.7.9.201702052155