AlphaForm

Overview

functions to construct and use AlphaForm objects.

Function List

qlAlphaFormInverseLinear ()
qlAlphaFormLinearHyperbolic ()
qlAlphaFormOperator ()
qlAlphaFormSetAlpha ()

Function Documentation

qlAlphaFormInverseLinear

string returnValue
qlAlphaFormInverseLinear(
string ObjectId
vector<double> RateTimes
double Alpha
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class AlphaFormInverseLinear and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
RateTimesrate fixing times.
Alphaalpha coefficient.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlAlphaFormLinearHyperbolic

string returnValue
qlAlphaFormLinearHyperbolic(
string ObjectId
vector<double> RateTimes
double Alpha
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class AlphaFormLinearHyperbolic and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
RateTimesrate fixing times.
Alphaalpha coefficient.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlAlphaFormOperator

double returnValue
qlAlphaFormOperator(
string ObjectId
long Time
any Trigger)
Description:

returns the Alpha Form value at time i.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::AlphaForm object
Timeinteger corresponding to i-th time.
Triggerdependency tracking trigger

qlAlphaFormSetAlpha

void returnValue
qlAlphaFormSetAlpha(
string ObjectId
double Alpha
any Trigger)
Description:

set the Alpha parameter value to Alpha Form.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::AlphaForm object
AlphaAlpha parameter value for Alpha Form.
Triggerdependency tracking trigger