public class ParticipationRateLinear extends TransactionFunctionLinear
Constructor and Description |
---|
ParticipationRateLinear(double dblOffset,
double dblSlope)
ParticipationRateLinear Constructor
|
Modifier and Type | Method and Description |
---|---|
double |
derivative(double dblTradeRate,
int iOrder)
Calculate the derivative as a double
|
double |
evaluate(double dblTradeRate)
Evaluate for the given variate
|
double |
modulate(double dblTradeInterval)
Modulate/Scale the Impact Output
|
static ParticipationRateLinear |
NoImpact()
Construct a Vanilla Zero-Impact ParticipationRateLinear Instance
|
double |
offset()
Retrieve the Offset Market Impact Parameter
|
double |
regularize(double dblTradeInterval)
Regularize the Input Function using the specified Trade Inputs
|
double |
slope()
Retrieve the Linear Market Impact Slope Parameter
|
static ParticipationRateLinear |
SlopeOnly(double dblSlope)
Construct a Vanilla Slope-Only ParticipationRateLinear Instance
|
crossHoldingsDerivative, evaluate, leftHoldingsDerivative, rightHoldingsDerivative
differential, differential, integrate, maxima, maxima, minima, minima
public ParticipationRateLinear(double dblOffset, double dblSlope) throws java.lang.Exception
dblOffset
- The Offset Market Impact ParameterdblSlope
- The Linear Market Impact Slope Parameterjava.lang.Exception
- Propagated up from R1ToR1public static final ParticipationRateLinear NoImpact()
public static final ParticipationRateLinear SlopeOnly(double dblSlope)
dblSlope
- The Slopepublic double slope()
slope
in class TransactionFunctionLinear
public double offset()
offset
in class TransactionFunctionLinear
public double regularize(double dblTradeInterval) throws java.lang.Exception
TransactionFunction
regularize
in class TransactionFunction
dblTradeInterval
- The Trade Intervaljava.lang.Exception
- Thrown if the Inputs are Invalidpublic double modulate(double dblTradeInterval) throws java.lang.Exception
TransactionFunction
modulate
in class TransactionFunction
dblTradeInterval
- The Trade Intervaljava.lang.Exception
- Thrown if the Inputs are Invalidpublic double evaluate(double dblTradeRate) throws java.lang.Exception
R1ToR1
public double derivative(double dblTradeRate, int iOrder) throws java.lang.Exception
R1ToR1
derivative
in class R1ToR1
dblTradeRate
- Variate at which the derivative is to be calculatediOrder
- Order of the derivative to be computedjava.lang.Exception
- Thrown if Inputs are Invalid