RelaxationTimeDistributionEstimate.java

  1. package org.drip.sample.scaledexponential;

  3. import org.drip.function.definition.R1ToR1;
  4. import org.drip.numerical.common.FormatUtil;
  5. import org.drip.service.env.EnvManager;
  6. import org.drip.specialfunction.definition.RelaxationTimeDistributionEstimator;
  7. import org.drip.specialfunction.gamma.NemesAnalytic;
  8. import org.drip.specialfunction.scaledexponential.RelaxationTimeDistributionSeriesEstimator;

  10. /*
  11.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  12.  */

  14. /*!
  15.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  16.  * 
  17.  *  This file is part of DROP, an open-source library targeting risk, transaction costs, exposure, margin
  18.  *      calculations, and portfolio construction within and across fixed income, credit, commodity, equity,
  19.  *      FX, and structured products.
  20.  *  
  21.  *      https://lakshmidrip.github.io/DROP/
  22.  *  
  23.  *  DROP is composed of three main modules:
  24.  *  
  25.  *  - DROP Analytics Core - https://lakshmidrip.github.io/DROP-Analytics-Core/
  26.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  27.  *  - DROP Numerical Core - https://lakshmidrip.github.io/DROP-Numerical-Core/
  28.  * 
  29.  *  DROP Analytics Core implements libraries for the following:
  30.  *  - Fixed Income Analytics
  31.  *  - Asset Backed Analytics
  32.  *  - XVA Analytics
  33.  *  - Exposure and Margin Analytics
  34.  * 
  35.  *  DROP Portfolio Core implements libraries for the following:
  36.  *  - Asset Allocation Analytics
  37.  *  - Transaction Cost Analytics
  38.  * 
  39.  *  DROP Numerical Core implements libraries for the following:
  40.  *  - Statistical Learning Library
  41.  *  - Numerical Optimizer Library
  42.  *  - Machine Learning Library
  43.  *  - Spline Builder Library
  44.  * 
  45.  *  Documentation for DROP is Spread Over:
  46.  * 
  47.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  48.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  49.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  50.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  51.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  52.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  53.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  54.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  55.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  56.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  57.  * 
  58.  *  Licensed under the Apache License, Version 2.0 (the "License");
  59.  *      you may not use this file except in compliance with the License.
  60.  *   
  61.  *  You may obtain a copy of the License at
  62.  *      http://www.apache.org/licenses/LICENSE-2.0
  63.  *  
  64.  *  Unless required by applicable law or agreed to in writing, software
  65.  *      distributed under the License is distributed on an "AS IS" BASIS,
  66.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  67.  *  
  68.  *  See the License for the specific language governing permissions and
  69.  *      limitations under the License.
  70.  */

  72. /**
  73.  * <i>RelaxationTimeDistributionEstimate</i> illustrates the Series-based Estimate for the Relaxation Time
  74.  * Distribution Function. The References are:
  75.  * 
  76.  * <br><br>
  77.  *  <ul>
  78.  *      <li>
  79.  *          Gradshteyn, I. S., I. M. Ryzhik, Y. V. Geronimus, M. Y. Tseytlin, and A. Jeffrey (2015):
  80.  *              <i>Tables of Integrals, Series, and Products</i> <b>Academic Press</b>
  81.  *      </li>
  82.  *      <li>
  83.  *          Hilfer, J. (2002): H-function Representations for Stretched Exponential Relaxation and non-Debye
  84.  *              Susceptibilities in Glassy Systems <i>Physical Review E</i> <b>65 (6)</b> 061510
  85.  *      </li>
  86.  *      <li>
  87.  *          Wikipedia (2019): Stretched Exponential Function
  88.  *              https://en.wikipedia.org/wiki/Stretched_exponential_function
  89.  *      </li>
  90.  *      <li>
  91.  *          Wuttke, J. (2012): Laplace-Fourier Transform of the Stretched Exponential Function: Analytic
  92.  *              Error-Bounds, Double Exponential Transform, and Open Source Implementation <i>libkw</i>
  93.  *              <i>Algorithm</i> <b>5 (4)</b> 604-628
  94.  *      </li>
  95.  *      <li>
  96.  *          Zorn, R. (2002): Logarithmic Moments of Relaxation Time Distributions <i>Journal of Chemical
  97.  *              Physics</i> <b>116 (8)</b> 3204-3209
  98.  *      </li>
  99.  *  </ul>
  100.  *
  101.  *  <br><br>
  102.  *  <ul>
  103.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalCore.md">Numerical Core Module</a></li>
  104.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalOptimizerLibrary.md">Numerical Optimizer</a></li>
  105.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/README.md">Special Function Project</a></li>
  106.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/specialfunction/ode/README.md">Special Function Ordinary Differential Equations</a></li>
  107.  *  </ul>
  108.  *
  109.  * @author Lakshmi Krishnamurthy
  110.  */

  112. public class RelaxationTimeDistributionEstimate
  113. {

  115.     private static final void RelaxationTimeDensity (
  116.         final R1ToR1 gammaEstimator,
  117.         final double[] tArray,
  118.         final double[] betaArray,
  119.         final int termCount)
  120.         throws Exception
  121.     {
  122.         for (double beta : betaArray)
  123.         {
  124.             RelaxationTimeDistributionEstimator relaxationTimeDistributionEstimator =
  125.                 RelaxationTimeDistributionSeriesEstimator.Standard (
  126.                     beta,
  127.                     gammaEstimator,
  128.                     termCount
  129.                 );

  131.             String display = "\t| [" + FormatUtil.FormatDouble (beta, 1, 1, 1., false) + "] => ";

  133.             for (double t : tArray)
  134.             {
  135.                 display = display + " " + FormatUtil.FormatDouble (
  136.                     relaxationTimeDistributionEstimator.relaxationTimeDensity (t), 1, 8, 1., false
  137.                 ) + " |";
  138.             }

  140.             System.out.println (display + "|");
  141.         }
  142.     }

  144.     public static final void main (
  145.         final String[] argumentArray)
  146.         throws Exception
  147.     {
  148.         EnvManager.InitEnv ("");

  150.         double[] tArray =
  151.         {
  152.              0.1,
  153.              0.2,
  154.              0.3,
  155.              0.4,
  156.              0.5,
  157.              1.0,
  158.              2.0,
  159.              5.0,
  160.             10.0,
  161.         };
  162.         double[] betaArray =
  163.         {
  164.              0.1,
  165.              0.2,
  166.              0.3,
  167.              0.4,
  168.              0.5,
  169.              0.6,
  170.              0.7,
  171.              0.8,
  172.              0.9,
  173.              1.0,
  174.         };
  175.         int[] termCountArray =
  176.         {
  177.             100,
  178.         };

  180.         R1ToR1 gammaEstimator = new NemesAnalytic (null);

  182.         System.out.println ("\t|------------------------------------------------------------------------------------------------------------------------------||");

  184.         System.out.println ("\t|                                                 KOHLRAUSCH MOMENT ESTIMATOR                                                  ||");

  186.         System.out.println ("\t|------------------------------------------------------------------------------------------------------------------------------||");

  188.         System.out.println ("\t|      L -> R:                                                                                                                 ||");

  190.         System.out.println ("\t|            - Beta                                                                                                            ||");

  192.         System.out.println ("\t|            - Density Estimate                                                                                                ||");

  194.         System.out.println ("\t|------------------------------------------------------------------------------------------------------------------------------||");

  196.         for (int termCount : termCountArray)
  197.         {
  198.             RelaxationTimeDensity (
  199.                 gammaEstimator,
  200.                 tArray,
  201.                 betaArray,
  202.                 termCount
  203.             );
  204.         }

  206.         System.out.println ("\t|------------------------------------------------------------------------------------------------------------------------------||");

  208.         EnvManager.TerminateEnv();
  209.     }
  210. }
Created with JaCoCo 0.7.9.201702052155