PykhtinPillar.java
package org.drip.exposure.regression;
/*
* -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*/
/*!
* Copyright (C) 2020 Lakshmi Krishnamurthy
* Copyright (C) 2019 Lakshmi Krishnamurthy
* Copyright (C) 2018 Lakshmi Krishnamurthy
*
* This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
* asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
* analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
* equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
* numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
* and computational support.
*
* https://lakshmidrip.github.io/DROP/
*
* DROP is composed of three modules:
*
* - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
* - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
* - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
*
* DROP Product Core implements libraries for the following:
* - Fixed Income Analytics
* - Loan Analytics
* - Transaction Cost Analytics
*
* DROP Portfolio Core implements libraries for the following:
* - Asset Allocation Analytics
* - Asset Liability Management Analytics
* - Capital Estimation Analytics
* - Exposure Analytics
* - Margin Analytics
* - XVA Analytics
*
* DROP Computational Core implements libraries for the following:
* - Algorithm Support
* - Computation Support
* - Function Analysis
* - Model Validation
* - Numerical Analysis
* - Numerical Optimizer
* - Spline Builder
* - Statistical Learning
*
* Documentation for DROP is Spread Over:
*
* - Main => https://lakshmidrip.github.io/DROP/
* - Wiki => https://github.com/lakshmiDRIP/DROP/wiki
* - GitHub => https://github.com/lakshmiDRIP/DROP
* - Repo Layout Taxonomy => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
* - Javadoc => https://lakshmidrip.github.io/DROP/Javadoc/index.html
* - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
* - Release Versions => https://lakshmidrip.github.io/DROP/version.html
* - Community Credits => https://lakshmidrip.github.io/DROP/credits.html
* - Issues Catalog => https://github.com/lakshmiDRIP/DROP/issues
* - JUnit => https://lakshmidrip.github.io/DROP/junit/index.html
* - Jacoco => https://lakshmidrip.github.io/DROP/jacoco/index.html
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* <i>PykhtinPillar</i> holds the Details of the Pillar Vertex Realization Point - the Realization Value, the
* Order Index, the CDF, the Transform Variate, and the Local Volatility - in accordance with the Pykhtin
* (2009) Scheme. The References are:
*
* <br><br>
* <ul>
* <li>
* Andersen, L. B. G., M. Pykhtin, and A. Sokol (2017): Re-thinking Margin Period of Risk
* https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2902737 <b>eSSRN</b>
* </li>
* <li>
* Andersen, L. B. G., M. Pykhtin, and A. Sokol (2017): Credit Exposure in the Presence of
* Initial Margin https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2806156 <b>eSSRN</b>
* </li>
* <li>
* Albanese, C., and L. Andersen (2014): Accounting for OTC Derivatives: Funding Adjustments and
* the Re-Hypothecation Option https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2482955
* <b>eSSRN</b>
* </li>
* <li>
* Burgard, C., and M. Kjaer (2017): Derivatives Funding, Netting, and Accounting
* https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2534011 <b>eSSRN</b>
* </li>
* <li>
* Piterbarg, V. (2010): Funding Beyond Discounting: Collateral Agreements and Derivatives
* Pricing <i>Risk</i> <b>21 (2)</b> 97-102
* </li>
* </ul>
*
* <br><br>
* <ul>
* <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/PortfolioCore.md">Portfolio Core Module</a></li>
* <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ExposureAnalyticsLibrary.md">Exposure Analytics</a></li>
* <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/exposure/README.md">Exposure Group Level Collateralized/Uncollateralized Exposure</a></li>
* <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/exposure/regression/README.md">Regression Based Path Exposure Generation</a></li>
* </ul>
*
* @author Lakshmi Krishnamurthy
*/
public class PykhtinPillar
{
private int _order = -1;
private double _cdf = java.lang.Double.NaN;
private double _variate = java.lang.Double.NaN;
private double _exposure = java.lang.Double.NaN;
private double _localVolatility = java.lang.Double.NaN;
/**
* PykhtinPillar Constructor
*
* @param exposure The Realization Point Exposure
* @param order The Realization Point Order
* @param cdf The Realization Point CDF
* @param variate The Realization Point Variate
* @param localVolatility The Realization Point Local Volatility
*
* @throws java.lang.Exception Thrown if the Inputs are Invalid
*/
public PykhtinPillar (
final double exposure,
final int order,
final double cdf,
final double variate,
final double localVolatility)
throws java.lang.Exception
{
if (!org.drip.numerical.common.NumberUtil.IsValid (_exposure = exposure) ||
0 > (_order = order) ||
!org.drip.numerical.common.NumberUtil.IsValid (_cdf = cdf) ||
!org.drip.numerical.common.NumberUtil.IsValid (_variate = variate) ||
!org.drip.numerical.common.NumberUtil.IsValid (_localVolatility = localVolatility))
{
throw new java.lang.Exception ("PykhtinPillar Constructor => Invalid Inputs");
}
}
/**
* Retrieve the Point Exposure
*
* @return The Point Exposure
*/
public double exposure()
{
return _exposure;
}
/**
* Retrieve the Point Exposure Order
*
* @return The Point Exposure Order
*/
public int order()
{
return _order;
}
/**
* Retrieve the Point Exposure CDF
*
* @return The Point Exposure CDF
*/
public double cdf()
{
return _cdf;
}
/**
* Retrieve the Point Exposure Variate
*
* @return The Point Exposure Variate
*/
public double variate()
{
return _variate;
}
/**
* Retrieve the Point Exposure Local Volatility
*
* @return The Point Exposure Local Volatility
*/
public double localVolatility()
{
return _localVolatility;
}
}