R1ShapeScaleDistribution.java

  1. package org.drip.measure.gamma;

  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>R1ShapeScaleDistribution</i> implements the Shape and Scale Parameterization of the R<sup>1</sup> Gamma
  79.  *  Distribution. The References are:
  80.  * 
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Devroye, L. (1986): <i>Non-Uniform Random Variate Generation</i> <b>Springer-Verlag</b> New York
  85.  *      </li>
  86.  *      <li>
  87.  *          Gamma Distribution (2019): Gamma Distribution
  88.  *              https://en.wikipedia.org/wiki/Chi-squared_distribution
  89.  *      </li>
  90.  *      <li>
  91.  *          Louzada, F., P. L. Ramos, and E. Ramos (2019): A Note on Bias of Closed-Form Estimators for the
  92.  *              Gamma Distribution Derived From Likelihood Equations <i>The American Statistician</i> <b>73
  93.  *              (2)</b> 195-199
  94.  *      </li>
  95.  *      <li>
  96.  *          Minka, T. (2002): Estimating a Gamma distribution https://tminka.github.io/papers/minka-gamma.pdf
  97.  *      </li>
  98.  *      <li>
  99.  *          Ye, Z. S., and N. Chen (2017): Closed-Form Estimators for the Gamma Distribution Derived from
  100.  *              Likelihood Equations <i>The American Statistician</i> <b>71 (2)</b> 177-181
  101.  *      </li>
  102.  *  </ul>
  103.  *
  104.  *  <br><br>
  105.  *  <ul>
  106.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  107.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalAnalysisLibrary.md">Numerical Analysis Library</a></li>
  108.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/measure/README.md">R<sup>d</sup> Continuous/Discrete Probability Measures</a></li>
  109.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/measure/gamma/README.md">R<sup>1</sup> Gamma Distribution Implementation/Properties</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  115. public class R1ShapeScaleDistribution
  116.     extends org.drip.measure.continuous.R1Univariate
  117. {
  118.     private double _cdfScaler = java.lang.Double.NaN;
  119.     private double _pdfScaler = java.lang.Double.NaN;
  120.     private org.drip.function.definition.R1ToR1 _gammaEstimator = null;
  121.     private org.drip.function.definition.R1ToR1 _digammaEstimator = null;
  122.     private org.drip.measure.gamma.ShapeScaleParameters _shapeScaleParameters = null;
  123.     private org.drip.function.definition.R2ToR1 _lowerIncompleteGammaEstimator = null;

  125.     /**
  126.      * Construct a Gamma Distribution from Shape and Rate Parameters
  127.      * 
  128.      * @param shapeParameter Shape Parameter
  129.      * @param rateParameter Rate Parameter
  130.      * @param gammaEstimator Gamma Estimator
  131.      * @param digammaEstimator Digamma Estimator
  132.      * @param lowerIncompleteGammaEstimator Lower Incomplete Gamma Estimator
  133.      * 
  134.      * @return Gamma Distribution from Shape Alpha and Rate Beta Parameters
  135.      */

  137.     public static final R1ShapeScaleDistribution ShapeRate (
  138.         final double shapeParameter,
  139.         final double rateParameter,
  140.         final org.drip.function.definition.R1ToR1 gammaEstimator,
  141.         final org.drip.function.definition.R1ToR1 digammaEstimator,
  142.         final org.drip.function.definition.R2ToR1 lowerIncompleteGammaEstimator)
  143.     {
  144.         return R1ShapeScaleDistribution.Standard (
  145.             shapeParameter,
  146.             1. / rateParameter,
  147.             gammaEstimator,
  148.             digammaEstimator,
  149.             lowerIncompleteGammaEstimator
  150.         );
  151.     }

  153.     /**
  154.      * Shape Summation Based ShapeScaleDistribution
  155.      * 
  156.      * @param shapeParameterArray Shape Parameter Array
  157.      * @param scaleParameter Scale Parameter
  158.      * @param gammaEstimator Gamma Estimator
  159.      * @param digammaEstimator Digamma Estimator
  160.      * @param lowerIncompleteGammaEstimator Lower Incomplete Gamma Estimator
  161.      * 
  162.      * @return Shape Summation Based ShapeScaleDistribution
  163.      */

  165.     public static final R1ShapeScaleDistribution ShapeSummation (
  166.         final double[] shapeParameterArray,
  167.         final double scaleParameter,
  168.         final org.drip.function.definition.R1ToR1 gammaEstimator,
  169.         final org.drip.function.definition.R1ToR1 digammaEstimator,
  170.         final org.drip.function.definition.R2ToR1 lowerIncompleteGammaEstimator)
  171.     {
  172.         if (null == shapeParameterArray)
  173.         {
  174.             return null;
  175.         }

  177.         double shapeParameter = 0.;
  178.         int shapeParameterArraySize = shapeParameterArray.length;

  180.         if (0 == shapeParameterArraySize)
  181.         {
  182.             return null;
  183.         }

  185.         for (int shapeParameterIndex = 0;
  186.             shapeParameterIndex < shapeParameterArraySize;
  187.             ++shapeParameterIndex)
  188.         {
  189.             if (!org.drip.numerical.common.NumberUtil.IsValid (
  190.                 shapeParameterArray[shapeParameterIndex]
  191.             ))
  192.             {
  193.                 return null;
  194.             }

  196.             shapeParameter += shapeParameterArray[shapeParameterIndex];
  197.         }

  199.         return R1ShapeScaleDistribution.Standard (
  200.             shapeParameter,
  201.             scaleParameter,
  202.             gammaEstimator,
  203.             digammaEstimator,
  204.             lowerIncompleteGammaEstimator
  205.         );
  206.     }

  208.     /**
  209.      * Construct the Standard R1ShapeScaleDistribution Instance
  210.      * 
  211.      * @param shapeParameter Shape Parameter
  212.      * @param scaleParameter Scale Parameter
  213.      * @param gammaEstimator Gamma Estimator
  214.      * @param digammaEstimator Digamma Estimator
  215.      * @param lowerIncompleteGammaEstimator Lower Incomplete Gamma Estimator
  216.      * 
  217.      * @return The R1ShapeScaleDistribution Instance
  218.      */

  220.     public static final R1ShapeScaleDistribution Standard (
  221.         final double shapeParameter,
  222.         final double scaleParameter,
  223.         final org.drip.function.definition.R1ToR1 gammaEstimator,
  224.         final org.drip.function.definition.R1ToR1 digammaEstimator,
  225.         final org.drip.function.definition.R2ToR1 lowerIncompleteGammaEstimator)
  226.     {
  227.         try
  228.         {
  229.             return new R1ShapeScaleDistribution (
  230.                 new org.drip.measure.gamma.ShapeScaleParameters (
  231.                     shapeParameter,
  232.                     scaleParameter
  233.                 ),
  234.                 gammaEstimator,
  235.                 digammaEstimator,
  236.                 lowerIncompleteGammaEstimator
  237.             );
  238.         }
  239.         catch (java.lang.Exception e)
  240.         {
  241.             e.printStackTrace();
  242.         }

  244.         return null;
  245.     }

  247.     private double randomMarsaglia1977 (
  248.         final double shapeParameterIn)
  249.         throws java.lang.Exception
  250.     {
  251.         double shapeParameter = shapeParameterIn < 1. ? shapeParameterIn + 1. : shapeParameterIn;
  252.         double d = shapeParameter - 1. / 3.;
  253.         double v = 0.;
  254.         double u = 0.;

  256.         double c = 1. / java.lang.Math.sqrt (
  257.             9. * d
  258.         );

  260.         while (true)
  261.         {
  262.             double x = org.drip.measure.gaussian.NormalQuadrature.Random();

  264.             u = java.lang.Math.random();

  266.             v = 1. + c * x;
  267.             v = v * v * v;

  269.             if (v > 0. &&
  270.                 0.5 * x * x + d - d * v + d * java.lang.Math.log (
  271.                     v
  272.                 ) > java.lang.Math.log (
  273.                     u
  274.                 )
  275.             )
  276.             {
  277.                 double marsagliaRandom =_shapeScaleParameters.scale() * d * v;

  279.                 return shapeParameter != shapeParameterIn ?
  280.                     marsagliaRandom * java.lang.Math.pow (
  281.                         u,
  282.                         1. / shapeParameterIn
  283.                     ) : marsagliaRandom;
  284.             }
  285.         }
  286.     }

  288.     /**
  289.      * R1ShapeScaleDistribution Constructor
  290.      * 
  291.      * @param shapeScaleParameters Shape-Scale Parameters
  292.      * @param gammaEstimator Gamma Estimator
  293.      * @param digammaEstimator Digamma Estimator
  294.      * @param lowerIncompleteGammaEstimator Lower Incomplete Gamma Estimator
  295.      * 
  296.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  297.      */

  299.     public R1ShapeScaleDistribution (
  300.         final org.drip.measure.gamma.ShapeScaleParameters shapeScaleParameters,
  301.         final org.drip.function.definition.R1ToR1 gammaEstimator,
  302.         final org.drip.function.definition.R1ToR1 digammaEstimator,
  303.         final org.drip.function.definition.R2ToR1 lowerIncompleteGammaEstimator)
  304.         throws java.lang.Exception
  305.     {
  306.         if (null == (_shapeScaleParameters = shapeScaleParameters) ||
  307.             null == (_gammaEstimator = gammaEstimator) ||
  308.             null == (_digammaEstimator = digammaEstimator) ||
  309.             null == (_lowerIncompleteGammaEstimator = lowerIncompleteGammaEstimator)
  310.         )
  311.         {
  312.             throw new java.lang.Exception (
  313.                 "R1ShapeScaleDistribution Constructor => Invalid Inputs"
  314.             );
  315.         }

  317.         double shape = _shapeScaleParameters.shape();

  319.         _pdfScaler = (
  320.             _cdfScaler = 1. / _gammaEstimator.evaluate (
  321.                 shape
  322.             )
  323.         ) * java.lang.Math.pow (
  324.             _shapeScaleParameters.scale(),
  325.             -1. * shape
  326.         );
  327.     }

  329.     /**
  330.      * Retrieve the Shape-Scale Parameters
  331.      * 
  332.      * @return The Shape-Scale Parameters
  333.      */

  335.     public org.drip.measure.gamma.ShapeScaleParameters shapeScaleParameters()
  336.     {
  337.         return _shapeScaleParameters;
  338.     }

  340.     /**
  341.      * Retrieve the Gamma Estimator
  342.      * 
  343.      * @return Gamma Estimator
  344.      */

  346.     public org.drip.function.definition.R1ToR1 gammaEstimator()
  347.     {
  348.         return _gammaEstimator;
  349.     }

  351.     /**
  352.      * Retrieve the Digamma Estimator
  353.      * 
  354.      * @return Digamma Estimator
  355.      */

  357.     public org.drip.function.definition.R1ToR1 digammaEstimator()
  358.     {
  359.         return _digammaEstimator;
  360.     }

  362.     /**
  363.      * Retrieve the Lower Incomplete Gamma Estimator
  364.      * 
  365.      * @return Lower Incomplete Gamma Estimator
  366.      */

  368.     public org.drip.function.definition.R2ToR1 lowerIncompleteGammaEstimator()
  369.     {
  370.         return _lowerIncompleteGammaEstimator;
  371.     }

  373.     @Override public double[] support()
  374.     {
  375.         return new double[]
  376.         {
  377.             0.,
  378.             java.lang.Double.POSITIVE_INFINITY
  379.         };
  380.     }

  382.     @Override public double density (
  383.         final double t)
  384.         throws java.lang.Exception
  385.     {
  386.         if (!supported (
  387.             t
  388.         ))
  389.         {
  390.             throw new java.lang.Exception (
  391.                 "ShapeScaleDistribution::density => Variate not in Range"
  392.             );
  393.         }

  395.         return _pdfScaler * java.lang.Math.pow (
  396.             t,
  397.             _shapeScaleParameters.shape() - 1.
  398.         ) * java.lang.Math.exp (
  399.             -1. * t / _shapeScaleParameters.scale()
  400.         );
  401.     }

  403.     @Override public double cumulative (
  404.         final double t)
  405.         throws java.lang.Exception
  406.     {
  407.         if (!supported (
  408.             t
  409.         ))
  410.         {
  411.             throw new java.lang.Exception (
  412.                 "ShapeScaleDistribution::cumulative => Invalid Inputs"
  413.             );
  414.         }

  416.         return _cdfScaler * _lowerIncompleteGammaEstimator.evaluate (
  417.             _shapeScaleParameters.shape(),
  418.             t / _shapeScaleParameters.scale()
  419.         );
  420.     }

  422.     @Override public double mean()
  423.         throws java.lang.Exception
  424.     {
  425.         return _shapeScaleParameters.shape() * _shapeScaleParameters.scale();
  426.     }

  428.     @Override public double mode()
  429.         throws java.lang.Exception
  430.     {
  431.         double shape = _shapeScaleParameters.shape();

  433.         if (shape < 1.)
  434.         {
  435.             throw new java.lang.Exception (
  436.                 "ShapeScaleDistribution::mode => No Closed Form Available"
  437.             );
  438.         }

  440.         return (shape - 1.) * _shapeScaleParameters.scale();
  441.     }

  443.     @Override public double variance()
  444.         throws java.lang.Exception
  445.     {
  446.         double scale = _shapeScaleParameters.scale();

  448.         return _shapeScaleParameters.shape() * scale * scale;
  449.     }

  451.     @Override public double skewness()
  452.         throws java.lang.Exception
  453.     {
  454.         return 2. * java.lang.Math.sqrt (1. / _shapeScaleParameters.shape());
  455.     }

  457.     @Override public double excessKurtosis()
  458.         throws java.lang.Exception
  459.     {
  460.         return 6. / _shapeScaleParameters.shape();
  461.     }

  463.     @Override public double differentialEntropy()
  464.         throws java.lang.Exception
  465.     {
  466.         double shape = _shapeScaleParameters.shape();

  468.         return shape + java.lang.Math.log (
  469.             _shapeScaleParameters.scale() / _cdfScaler
  470.         ) + (1. - shape) * _digammaEstimator.evaluate (
  471.             shape
  472.         );
  473.     }

  475.     @Override public org.drip.function.definition.R1ToR1 momentGeneratingFunction()
  476.     {
  477.         final double scale = _shapeScaleParameters.scale();

  479.         return new org.drip.function.definition.R1ToR1 (
  480.             null
  481.         )
  482.         {
  483.             @Override public double evaluate (
  484.                 final double t)
  485.                 throws java.lang.Exception
  486.             {
  487.                 if (!org.drip.numerical.common.NumberUtil.IsValid (
  488.                         t
  489.                     ) || t >= 1. / scale
  490.                 )
  491.                 {
  492.                     throw new java.lang.Exception (
  493.                         "ShapeScaleDistribution::momentGeneratingFunction::evaluate => Invalid Input"
  494.                     );
  495.                 }

  497.                 return java.lang.Math.pow (
  498.                     1. - scale * t,
  499.                     -1. * _shapeScaleParameters.shape()
  500.                 );
  501.             }
  502.         };
  503.     }

  505.     /**
  506.      * Retrieve the Central Limit Theorem Equivalent Normal Distribution Proxy
  507.      * 
  508.      * @return The Central Limit Theorem Equivalent Normal Distribution Proxy
  509.      */

  511.     public org.drip.measure.gaussian.R1UnivariateNormal cltProxy()
  512.     {
  513.         double scale = _shapeScaleParameters.scale();

  515.         double shape = _shapeScaleParameters.shape();

  517.         try
  518.         {
  519.             return new org.drip.measure.gaussian.R1UnivariateNormal (
  520.                 shape * scale,
  521.                 scale * java.lang.Math.sqrt (
  522.                     shape
  523.                 )
  524.             );
  525.         }
  526.         catch (java.lang.Exception e)
  527.         {
  528.             e.printStackTrace();
  529.         }

  531.         return null;
  532.     }

  534.     /**
  535.      * Compute the Logarithmic Expectation
  536.      * 
  537.      * @return The Logarithmic Expectation
  538.      * 
  539.      * @throws java.lang.Exception Thrown if the Logarithmic Expectation cannot be computed
  540.      */

  542.     public double logarithmicExpectation()
  543.         throws java.lang.Exception
  544.     {
  545.         return _digammaEstimator.evaluate (
  546.             _shapeScaleParameters.shape()
  547.         ) - java.lang.Math.log (
  548.             _shapeScaleParameters.scale()
  549.         );
  550.     }

  552.     /**
  553.      * Compute the Banneheke-Ekayanake Approximation for the Median when k gte 1
  554.      * 
  555.      * @return The Banneheke-Ekayanake Approximation for the Median
  556.      * 
  557.      * @throws java.lang.Exception Thrown if the Median cannot be computed
  558.      */

  560.     public double bannehekeEkayanakeMedianApproximation()
  561.         throws java.lang.Exception
  562.     {
  563.         double shape = _shapeScaleParameters.shape();

  565.         if (1. > shape)
  566.         {
  567.             throw new java.lang.Exception (
  568.                 "ShapeScaleDistribution::bannehekeEkayanakeMedianApproximation => Invalid Shape Parameter"
  569.             );
  570.         }

  572.         return (3. * shape - 0.8) / (3. * shape - 0.2) * mean();
  573.     }

  575.     /**
  576.      * Compute the Ramanujan-Choi Approximation for the Median
  577.      * 
  578.      * @return The Ramanujan-Choi Approximation for the Median
  579.      */

  581.     public double ramanujanChoiMedianApproximation()
  582.     {
  583.         double shape = _shapeScaleParameters.shape();

  585.         double inverseShapeParameter = 1. / shape;

  587.         return shape - 1. / 3. +
  588.             8. * inverseShapeParameter / 405. +
  589.             184. * inverseShapeParameter * inverseShapeParameter / 25515. +
  590.             2248. * inverseShapeParameter * inverseShapeParameter * inverseShapeParameter / 3444525.;
  591.     }

  593.     /**
  594.      * Compute the Chen-Rubin Median Lower Bound
  595.      * 
  596.      * @return The Chen-Rubin Median Lower Bound
  597.      */

  599.     public double chenRubinMedianLowerBound()
  600.     {
  601.         return _shapeScaleParameters.shape() - 1. / 3.;
  602.     }

  604.     /**
  605.      * Compute the Chen-Rubin Median Upper Bound
  606.      * 
  607.      * @return The Chen-Rubin Median Upper Bound
  608.      */

  610.     public double chenRubinMedianUpperBound()
  611.     {
  612.         return _shapeScaleParameters.shape();
  613.     }

  615.     /**
  616.      * Generate a Scaled Gamma Distribution
  617.      * 
  618.      * @param scaleFactor The Gamma Distribution Scale Factor
  619.      * 
  620.      * @return Scaled Gamma Distribution
  621.      */

  623.     public R1ShapeScaleDistribution scale (
  624.         final double scaleFactor)
  625.     {
  626.         try
  627.         {
  628.             return new R1ShapeScaleDistribution (
  629.                 new org.drip.measure.gamma.ShapeScaleParameters (
  630.                     _shapeScaleParameters.shape(),
  631.                     _shapeScaleParameters.scale() * scaleFactor
  632.                 ),
  633.                 _gammaEstimator,
  634.                 _digammaEstimator,
  635.                 _lowerIncompleteGammaEstimator
  636.             );
  637.         }
  638.         catch (java.lang.Exception e)
  639.         {
  640.             e.printStackTrace();
  641.         }

  643.         return null;
  644.     }

  646.     /**
  647.      * Retrieve the Array of Natural Parameters
  648.      * 
  649.      * @return Array of Natural Parameters
  650.      */

  652.     public double[] naturalParameters()
  653.     {
  654.         return new double[]
  655.         {
  656.             _shapeScaleParameters.shape() - 1,
  657.             -1. / _shapeScaleParameters.scale()
  658.         };
  659.     }

  661.     /**
  662.      * Retrieve the Array of Natural Statistics
  663.      * 
  664.      * @param x X
  665.      * 
  666.      * @return Array of Natural Statistics
  667.      */

  669.     public double[] naturalStatistics (
  670.         final double x)
  671.     {
  672.         return org.drip.numerical.common.NumberUtil.IsValid (
  673.             x
  674.         ) ? new double[]
  675.         {
  676.             x,
  677.             java.lang.Math.log (
  678.                 x
  679.             )
  680.         } : null;
  681.     }

  683.     /**
  684.      * Generate the Exponential Family Representation
  685.      * 
  686.      * @param x X
  687.      * 
  688.      * @return Exponential Family Representation
  689.      */

  691.     public org.drip.measure.gamma.ExponentialFamilyRepresentation exponentialFamilyRepresentation (
  692.         final double x)
  693.     {
  694.         try
  695.         {
  696.             return new org.drip.measure.gamma.ExponentialFamilyRepresentation (
  697.                 naturalParameters(),
  698.                 naturalStatistics (
  699.                     x
  700.                 )
  701.             );
  702.         }
  703.         catch (java.lang.Exception e)
  704.         {
  705.             e.printStackTrace();
  706.         }

  708.         return null;
  709.     }

  711.     /**
  712.      * Compute the Laplacian
  713.      * 
  714.      * @param s S
  715.      * 
  716.      * @return The Laplacian
  717.      * 
  718.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  719.      */

  721.     public double laplacian (
  722.         final double s)
  723.         throws java.lang.Exception
  724.     {
  725.         if (0. > s)
  726.         {
  727.             throw new java.lang.Exception (
  728.                 "ShapeScaleDistribution::laplacian => Invalid Shape Parameter"
  729.             );
  730.         }

  732.         return java.lang.Math.pow (
  733.             1. + s * _shapeScaleParameters.scale(),
  734.             -1. * _shapeScaleParameters.shape()
  735.         );
  736.     }

  738.     /**
  739.      * Generate a Random Variable using the Ahrens-Dieter (1982) Scheme
  740.      * 
  741.      * @return Random Variable using the Ahrens-Dieter (1982) Scheme
  742.      * 
  743.      * @throws java.lang.Exception Thrown if the Random Instance cannot be estimated
  744.      */

  746.     public double randomAhrensDieter1982()
  747.         throws java.lang.Exception
  748.     {
  749.         double shape = _shapeScaleParameters.shape();

  751.         double eta = 0.;
  752.         double random = 0.;
  753.         double epsilon = 0.;
  754.         int k = (int) shape;
  755.         double delta = shape - k;

  757.         for (int index = 0;
  758.             index < k;
  759.             ++index)
  760.         {
  761.             random = random - java.lang.Math.log (
  762.                 java.lang.Math.random()
  763.             );
  764.         }

  766.         if (0. == delta)
  767.         {
  768.             return random;
  769.         }

  771.         while (true)
  772.         {
  773.             double u = java.lang.Math.random();

  775.             double v = java.lang.Math.random();

  777.             double w = java.lang.Math.random();

  779.             if (u <= java.lang.Math.E / (java.lang.Math.E + delta))
  780.             {
  781.                 epsilon = java.lang.Math.pow (
  782.                     v,
  783.                     1. / delta
  784.                 );

  786.                 eta = w * java.lang.Math.pow (
  787.                     epsilon,
  788.                     delta - 1.
  789.                 );
  790.             }
  791.             else
  792.             {
  793.                 epsilon = 1. - java.lang.Math.log (
  794.                     v
  795.                 );

  797.                 eta = w * java.lang.Math.exp (
  798.                     -1. * epsilon
  799.                 );
  800.             }

  802.             if (eta <= java.lang.Math.pow (
  803.                 epsilon,
  804.                 delta - 1.
  805.             ) * java.lang.Math.exp (
  806.                 -1. * epsilon
  807.                 )
  808.             )
  809.             {
  810.                 break;
  811.             }
  812.         }

  814.         return _shapeScaleParameters.scale() * (random + epsilon);
  815.     }

  817.     /**
  818.      * Generate a Random Variable using the Marsaglia (1977) Scheme
  819.      * 
  820.      * @return Random Variable using the Marsaglia (1977) Scheme
  821.      * 
  822.      * @throws java.lang.Exception Thrown if the Random Instance cannot be estimated
  823.      */

  825.     public double randomMarsaglia1977()
  826.         throws java.lang.Exception
  827.     {
  828.         return randomMarsaglia1977 (
  829.             _shapeScaleParameters.shape()
  830.         );
  831.     }
  832. }
Created with JaCoCo 0.7.9.201702052155