PowerImpactContinuous.java

  1. package org.drip.execution.optimum;

  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.  * Copyright (C) 2017 Lakshmi Krishnamurthy
  12.  * Copyright (C) 2016 Lakshmi Krishnamurthy
  13.  * 
  14.  *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
  15.  *      asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
  16.  *      analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
  17.  *      equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
  18.  *      numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
  19.  *      and computational support.
  20.  *  
  21.  *      https://lakshmidrip.github.io/DROP/
  22.  *  
  23.  *  DROP is composed of three modules:
  24.  *  
  25.  *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
  26.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  27.  *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
  28.  * 
  29.  *  DROP Product Core implements libraries for the following:
  30.  *  - Fixed Income Analytics
  31.  *  - Loan Analytics
  32.  *  - Transaction Cost Analytics
  33.  * 
  34.  *  DROP Portfolio Core implements libraries for the following:
  35.  *  - Asset Allocation Analytics
  36.  *  - Asset Liability Management Analytics
  37.  *  - Capital Estimation Analytics
  38.  *  - Exposure Analytics
  39.  *  - Margin Analytics
  40.  *  - XVA Analytics
  41.  * 
  42.  *  DROP Computational Core implements libraries for the following:
  43.  *  - Algorithm Support
  44.  *  - Computation Support
  45.  *  - Function Analysis
  46.  *  - Model Validation
  47.  *  - Numerical Analysis
  48.  *  - Numerical Optimizer
  49.  *  - Spline Builder
  50.  *  - Statistical Learning
  51.  * 
  52.  *  Documentation for DROP is Spread Over:
  53.  * 
  54.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  55.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  56.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  57.  *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
  58.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  59.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  60.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  61.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  62.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  63.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  64.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  65.  * 
  66.  *  Licensed under the Apache License, Version 2.0 (the "License");
  67.  *      you may not use this file except in compliance with the License.
  68.  *   
  69.  *  You may obtain a copy of the License at
  70.  *      http://www.apache.org/licenses/LICENSE-2.0
  71.  *  
  72.  *  Unless required by applicable law or agreed to in writing, software
  73.  *      distributed under the License is distributed on an "AS IS" BASIS,
  74.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  75.  *  
  76.  *  See the License for the specific language governing permissions and
  77.  *      limitations under the License.
  78.  */

  80. /**
  81.  * <i>PowerImpactContinuous</i> contains the Trading Trajectory generated by the Almgren (2003) Power Impact
  82.  * Scheme under the Criterion of No-Drift. The References are:
  83.  * 
  84.  * <br><br>
  85.  *  <ul>
  86.  *      <li>
  87.  *          Almgren, R., and N. Chriss (1999): Value under Liquidation <i>Risk</i> <b>12 (12)</b>
  88.  *      </li>
  89.  *      <li>
  90.  *          Almgren, R. F., and N. Chriss (2000): Optimal Execution of Portfolio Transactions <i>Journal of
  91.  *              Risk</i> <b>3 (2)</b> 5-39
  92.  *      </li>
  93.  *      <li>
  94.  *          Almgren, R. (2003): Optimal Execution with Nonlinear Impact Functions and Trading-Enhanced Risk
  95.  *              <i>Applied Mathematical Finance</i> <b>10 (1)</b> 1-18
  96.  *      </li>
  97.  *      <li>
  98.  *          Almgren, R., and N. Chriss (2003): Bidding Principles <i>Risk</i> 97-102
  99.  *      </li>
  100.  *      <li>
  101.  *          Bertsimas, D., and A. W. Lo (1998): Optimal Control of Execution Costs <i>Journal of Financial
  102.  *              Markets</i> <b>1</b> 1-50
  103.  *      </li>
  104.  *  </ul>
  105.  *
  106.  *  <br><br>
  107.  *  <ul>
  108.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ProductCore.md">Product Core Module</a></li>
  109.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/TransactionCostAnalyticsLibrary.md">Transaction Cost Analytics</a></li>
  110.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/execution/README.md">Optimal Impact/Capture Based Trading Trajectories - Deterministic, Stochastic, Static, and Dynamic</a></li>
  111.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/execution/optimum/README.md">Almgren-Chriss Efficient Trading Trajectories</a></li>
  112.  *  </ul>
  113.  * 
  114.  * @author Lakshmi Krishnamurthy
  115.  */

  117. public class PowerImpactContinuous extends org.drip.execution.optimum.EfficientTradingTrajectoryContinuous {
  118.     private double _dblExecutionTimeUpperBound = java.lang.Double.NaN;
  119.     private double _dblHyperboloidBoundaryValue = java.lang.Double.NaN;

  121.     /**
  122.      * Construct the Standard PowerImpactContinuous Instance
  123.      * 
  124.      * @param dblExecutionTime The Execution Time
  125.      * @param dblTransactionCostExpectation The Expected Transaction Cost
  126.      * @param dblTransactionCostVariance The Variance of the Transaction Cost
  127.      * @param dblCharacteristicTime The Optimal Trajectory's "Characteristic" Time
  128.      * @param dblExecutionTimeUpperBound The Optimal Trajectory's Execution Time Upper Bound (if it exists)
  129.      * @param dblHyperboloidBoundaryValue The Hyperboloid Boundary Value
  130.      * @param dblMarketPower The Dimension-less Relative Market Impact
  131.      * @param r1ToR1Holdings The Optimal Trajectory R^1 To R^1 Holdings Function
  132.      * @param r1ToR1TransactionCostExpectation The Transaction Cost Expectation Function
  133.      * @param r1ToR1TransactionCostVariance The Transaction Cost Variance Function
  134.      * 
  135.      * @return The Standard PowerImpactContinuous Instance
  136.      */

  138.     public static PowerImpactContinuous Standard (
  139.         final double dblExecutionTime,
  140.         final double dblTransactionCostExpectation,
  141.         final double dblTransactionCostVariance,
  142.         final double dblCharacteristicTime,
  143.         final double dblExecutionTimeUpperBound,
  144.         final double dblHyperboloidBoundaryValue,
  145.         final double dblMarketPower,
  146.         final org.drip.function.definition.R1ToR1 r1ToR1Holdings,
  147.         final org.drip.function.definition.R1ToR1 r1ToR1TransactionCostExpectation,
  148.         final org.drip.function.definition.R1ToR1 r1ToR1TransactionCostVariance)
  149.     {
  150.         if (null == r1ToR1Holdings) return null;

  152.         try {
  153.             org.drip.function.definition.R1ToR1 r1ToR1TradeRate = new org.drip.function.definition.R1ToR1
  154.                 (null) {
  155.                 @Override public double evaluate (
  156.                     final double dblVariate)
  157.                     throws java.lang.Exception
  158.                 {
  159.                     return r1ToR1Holdings.derivative (dblVariate, 1);
  160.                 }
  161.             };

  163.             return new PowerImpactContinuous (dblExecutionTime, dblTransactionCostExpectation,
  164.                 dblTransactionCostVariance, dblCharacteristicTime, dblExecutionTimeUpperBound,
  165.                     dblHyperboloidBoundaryValue, dblMarketPower, r1ToR1Holdings, r1ToR1TradeRate,
  166.                         r1ToR1TransactionCostExpectation, r1ToR1TransactionCostVariance);
  167.         } catch (java.lang.Exception e) {
  168.             e.printStackTrace();
  169.         }

  171.         return null;
  172.     }

  174.     /**
  175.      * PowerImpactContinuous Constructor
  176.      * 
  177.      * @param dblExecutionTime The Execution Time
  178.      * @param dblTransactionCostExpectation The Expected Transaction Cost
  179.      * @param dblTransactionCostVariance The Variance of the Transaction Cost
  180.      * @param dblCharacteristicTime The Optimal Trajectory's "Characteristic" Time
  181.      * @param dblExecutionTimeUpperBound The Optimal Trajectory's Execution Time Upper Bound (if it exists)
  182.      * @param dblHyperboloidBoundaryValue The Hyperboloid Boundary Value
  183.      * @param dblMarketPower The Dimension-less Relative Market Impact
  184.      * @param r1ToR1Holdings The Optimal Trajectory R^1 To R^1 Holdings Function
  185.      * @param r1ToR1TradeRate The Optimal Trajectory R^1 To R^1 Trade Rate Function
  186.      * @param r1ToR1TransactionCostExpectation The Transaction Cost Expectation Function
  187.      * @param r1ToR1TransactionCostVariance The Transaction Cost Variance Function
  188.      * 
  189.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  190.      */

  192.     public PowerImpactContinuous (
  193.         final double dblExecutionTime,
  194.         final double dblTransactionCostExpectation,
  195.         final double dblTransactionCostVariance,
  196.         final double dblCharacteristicTime,
  197.         final double dblExecutionTimeUpperBound,
  198.         final double dblHyperboloidBoundaryValue,
  199.         final double dblMarketPower,
  200.         final org.drip.function.definition.R1ToR1 r1ToR1Holdings,
  201.         final org.drip.function.definition.R1ToR1 r1ToR1TradeRate,
  202.         final org.drip.function.definition.R1ToR1 r1ToR1TransactionCostExpectation,
  203.         final org.drip.function.definition.R1ToR1 r1ToR1TransactionCostVariance)
  204.         throws java.lang.Exception
  205.     {
  206.         super (dblExecutionTime, dblTransactionCostExpectation, dblTransactionCostVariance,
  207.             dblCharacteristicTime, dblMarketPower, r1ToR1Holdings, r1ToR1TradeRate,
  208.                 r1ToR1TransactionCostExpectation, r1ToR1TransactionCostVariance);

  210.         if (!org.drip.numerical.common.NumberUtil.IsValid (_dblHyperboloidBoundaryValue =
  211.             dblHyperboloidBoundaryValue))
  212.             throw new java.lang.Exception ("PowerImpactContinuous Constructor => Invalid Inputs");

  214.         _dblExecutionTimeUpperBound = dblExecutionTimeUpperBound;
  215.     }

  217.     /**
  218.      * Retrieve the Optimal Trajectory Execution Time Upper Bound (if it exists)
  219.      * 
  220.      * @return The Optimal Trajectory Execution Time Upper Bound (if it exists)
  221.      */

  223.     public double executionTimeUpperBound()
  224.     {
  225.         return _dblExecutionTimeUpperBound;
  226.     }

  228.     /**
  229.      * Retrieve the Optimal Trajectory Hyperboloid Boundary Value
  230.      * 
  231.      * @return The Optimal Trajectory Hyperboloid Boundary Value
  232.      */

  234.     public double hyperboloidBoundaryValue()
  235.     {
  236.         return _dblHyperboloidBoundaryValue;
  237.     }
  238. }
Created with JaCoCo 0.7.9.201702052155