This page contins the documentation of all of the functions in the QuantLib Add-In that are defined in "gensrc" XML files. This means that this should include all QuantLib functions that are usable from the add-in and also some auxiliary and helper functions from other sub-projects.
Returns the instantaneous volatility as function of residual time to maturity u=T-t: [a + b*u] * e^{-c*u} + d.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| U: | double | 5.0,4.0,3.0,2.0,1.0 | False |
Return value: double
Returns covariance at calendar time u between T and S rates fixing times.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| U: | double | 0.0,0.5,1.0 | False |
| T: | double | 0.0 | False |
| S: | double | 1.0 | False |
Return value: double
Returns variance at calendar time(s) u of T-fixing rate.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| U: | double | 0.0,0.5,1.0 | False |
| T: | double | 1.0 | False |
Return value: double
Returns volatility/ies at calendar time(s) u of T-fixing rate.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| U: | double | 0.0,0.5,1.0 | False |
| T: | double | 1.0 | False |
Return value: QuantLib::Volatility
Returns covariance(s) in [tMin,tMax] between T and S rate fixing times.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| TMin: | double | 0.0 | False |
| TMax: | double | 0.25,0.5 | False |
| T: | double | 0.5 | False |
| S: | double | 1.0 | False |
Return value: double
Returns variance(s) in [tMin,tMax] of T rate fixing time.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| TMin: | double | 0.0 | False |
| TMax: | double | 0.5,1.0 | False |
| T: | double | 1.0 | False |
Return value: double
Returns volatility/ies in [tMin,tMax] of T rate fixing time.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction | ||
| TMin: | double | 1.0 | False |
| TMax: | double | 0.5,1.0 | False |
| T: | double | 1.0 | False |
Return value: QuantLib::Volatility
Returns the short term volatility implied by Abcd volatility.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: QuantLib::Volatility
Returns the long term volatility implied by Abcd volatility.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: QuantLib::Volatility
Returns, if b is positive, the location of the Abcd volatility maximum.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: QuantLib::Time
Returns, if b is positive, the maximum of the Abcd volatility.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: QuantLib::Volatility
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: double
Returns the b coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: double
Returns the c coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: double
Returns the d coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: double
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdFunction |
Return value: double
compute calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: void
Returns the 'k' adjustment factors needed to match Black vols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration | ||
| Times: | QuantLib::Time | N/S | N/S |
| BlackVols: | QuantLib::Volatility | N/S | N/S |
Return value: double
Returns the root mean squared error between the abdc implied Black vols and a given Black vol vector.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
Returs the max error between the abdc implied Black vols and a given Black vol vector.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
Calibrates the a, b, c, d parameters of the vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: QuantLib::EndCriteria::Type
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdCalibration |
Return value: double
return multiple path values.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AccountingEngine | ||
| Paths: | long | 8191 | N/S |
| SequenceStats: | QuantLib::SequenceStatisticsInc | N/S | N/S |
Return value: void
returns the Alpha Form value at time i.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AlphaForm | ||
| Time: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Real
set the Alpha parameter value to Alpha Form.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AlphaForm | ||
| Alpha: | QuantLib::Real | 1 | N/S |
Return value: void
The bond leg cash flow analysis.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AssetSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
The floating leg cash flow analysis.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AssetSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
the fair rate of the asset swap, i.e. the asset swap spread.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: QuantLib::Spread
the BPS of the floating leg.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: double
the fair price of the bond in the asset swap.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: QuantLib::Real
the fair non par repayment of the bond in the asset swap.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: QuantLib::Real
Returns TRUE if par swap
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: bool
Returns TRUE if it is a bond coupon payer swap
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AssetSwap |
Return value: bool
Returns the number of settlement days of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: QuantLib::Natural
Returns the calendar of the bond, e.g. TARGET.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: QuantLib::Calendar
Returns the notionals of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: QuantLib::Real
Returns the notional of the bond at a given date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond | ||
| SettlementDate: | QuantLib::Date | N/S | False |
Return value: QuantLib::Real
Returns the maturity date of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: QuantLib::Date
Returns the issue date of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: QuantLib::Date
Returns TRUE if the given Bond is tradable at the given settlement date. The current bond settlement is used if no date is given.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond | ||
| SettlementDate: | QuantLib::Date | N/S | False |
Return value: bool
Returns the settlement date of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond | ||
| EvaluationDate: | QuantLib::Date | N/S | False |
Return value: QuantLib::Date
Returns the clean price for the given bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Bond |
Return value: double
Returns the bond description string.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond |
Return value: string
Returns the bond currency.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond |
Return value: string
Returns the redemption amount of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond |
Return value: QuantLib::Real
Returns the redemption payment date of the bond.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond |
Return value: QuantLib::Date
Returns the bond cash flow analysis.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
Set the coupon pricer at the given Bond object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond | ||
| FloatingRateCouponPricer: | QuantLib::FloatingRateCouponPricer | N/S | N/S |
Return value: void
Set the coupon pricer at the given Bond object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Bond | ||
| FloatingRateCouponPricer: | QuantLib::FloatingRateCouponPricer | N/S | N/S |
Return value: void
Returns the number of BTPs in the RendistatoBasket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoBasket |
Return value: QuantLib::Size
Returns the overall outstanding of the BTPs in the RendistatoBasket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoBasket |
Return value: QuantLib::Real
Returns the outstandings of the BTPs in the RendistatoBasket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoBasket |
Return value: QuantLib::Real
Returns the weights of the BTPs in the RendistatoBasket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoBasket |
Return value: QuantLib::Real
Returns RendistatoCalculator's yield.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns RendistatoCalculator's duration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Returns the yields of the BTPs in the RendistatoCalculator's underlying basket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns the durations of the BTPs in the RendistatoCalculator's underlying basket.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Returns RendistatoCalculator's equivalent swaps' lengths.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Returns RendistatoCalculator's equivalent swaps' rates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns RendistatoCalculator's equivalent swaps' yields.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns RendistatoCalculator's equivalent swaps' durations.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Returns RendistatoCalculator's equivalent swap rate.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns RendistatoCalculator's equivalent swap yield.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Rate
Returns RendistatoCalculator's equivalent swap duration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Returns RendistatoCalculator's equivalent swap spread.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Spread
Returns RendistatoCalculator's equivalent swap lenght in years.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RendistatoCalculator |
Return value: QuantLib::Time
Set the priging engine for the given SwaptionHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CalibrationHelper | ||
| PricingEngine: | QuantLib::PricingEngine | PricingEngineID | N/S |
Return value: void
Set the priging engine for the given SwaptionHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CalibrationHelper | ||
| TargetValue: | QuantLib::Real | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| MaxEvaluations: | QuantLib::Size | N/S | N/S |
| MinVol: | QuantLib::Volatility | N/S | N/S |
| MaxVol: | QuantLib::Volatility | N/S | N/S |
Return value: QuantLib::Volatility
Set the priging engine for the given SwaptionHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionHelper |
Return value: double
calibrate a model.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneFactorAffineModel | ||
| CalibrationHelpers: | QuantLib::CalibrationHelper | N/S | N/S |
| Weights: | QuantLib::Real | N/S | N/S |
| FixedCoeff: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Constraint: | QuantLib::Constraint | N/S | N/S |
Return value: void
calibrate a model.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 | ||
| CalibrationHelpers: | QuantLib::CalibrationHelper | N/S | N/S |
| Weights: | QuantLib::Real | N/S | N/S |
| FixedCoeff: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Constraint: | QuantLib::Constraint | N/S | N/S |
Return value: void
Returns the type (e.g. Cap, Floor) for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor |
Return value: QuantLib::CapFloor::Type
Returns the cap rates for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor |
Return value: QuantLib::Rate
Returns the floor rates for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor |
Return value: QuantLib::Rate
Returns the at-the-money rate for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor | ||
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
Return value: QuantLib::Rate
Returns the start (i.e. first accrual) date for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor |
Return value: QuantLib::Date
Returns the maturity (i.e. last payment) date for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor |
Return value: QuantLib::Date
Returns the volatility implied by the given price for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloor | ||
| Price: | QuantLib::Real | 0.2 | N/S |
| Guess: | QuantLib::Volatility | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| MaxIter: | QuantLib::Natural | N/S | N/S |
| MinVol: | QuantLib::Volatility | N/S | N/S |
| MaxVol: | QuantLib::Volatility | N/S | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
Return value: QuantLib::Volatility
Returns the cash flow analysis for the given CapFloor object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CapFloor | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
Returns volatility from the given OptionletVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletVolatilityStructure | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns volatility from the given OptionletVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the black variance corresponding to a given strike for a given exercise date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletVolatilityStructure | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Real
Returns the black variance corresponding to a given strike for a given exercise date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Real
Returns optionlet strike from the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Rate
Returns optionlet volatilities from the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Volatility
Returns optionlet fixing dates from the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::Date
Returns optionlet fixing times from the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::Time
Returns atm optionlet rates from the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::Rate
Returns the DayCounter used by the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::DayCounter
Returns the calendar used by the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::Calendar
Returns the number of settlement days for the given StrippedOptionletBase object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::Natural
Returns the business day convention used in tenor to date conversion.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrippedOptionletBase |
Return value: QuantLib::BusinessDayConvention
Returns optionlet fixing tenors from the given OptionletStripper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper |
Return value: QuantLib::Period
Returns optionlet payment dates from the given OptionletStripper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper |
Return value: QuantLib::Date
Returns optionlet accrual periods from the given OptionletStripper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper |
Return value: QuantLib::Time
Returns option prices matrix from the given OptionletStripper1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper1 |
Return value: QuantLib::Matrix
Returns option volatilities matrix from the given OptionletStripper1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper1 |
Return value: QuantLib::Matrix
Returns optionlet prices matrix from the given OptionletStripper1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper1 |
Return value: QuantLib::Matrix
Returns option switch strike from the given OptionletStripper1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper1 |
Return value: QuantLib::Rate
Returns optionlet spread (with respect to ATM) vols from the given OptionletStripper2 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper2 |
Return value: QuantLib::Spread
Returns ATM option prices from the given OptionletStripper2 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper2 |
Return value: QuantLib::Real
Returns option ATM strikes from the given OptionletStripper2 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OptionletStripper2 |
Return value: QuantLib::Rate
Returns volatility from the given CapFloorTermVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolatilityStructure | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns volatility from the given CapFloorTermVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the option tenors from the given CapFloorTermVolCurve object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolCurve |
Return value: QuantLib::Period
Returns the option dates from the given CapFloorTermVolCurve object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolCurve |
Return value: QuantLib::Date
Returns the option tenors from the given CapFloorTermVolSurface object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolSurface |
Return value: QuantLib::Period
Returns the option dates from the given CapFloorTermVolSurface object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolSurface |
Return value: QuantLib::Date
Returns the option strikes from the given CapFloorTermVolSurface object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CapFloorTermVolSurface |
Return value: QuantLib::Rate
return the market and implied spreads matrix.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarket |
Return value: any
Return the best beta and mean reversion.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarketCalibration | ||
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| OptimizationMethod: | QuantLib::OptimizationMethod | N/S | N/S |
| Guess: | QuantLib::Array | N/S | N/S |
| IsMeanRevFixed: | bool | FALSE | N/S |
Return value: QuantLib::Array
Returns the error of the simultaneous calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CmsMarketCalibration |
Return value: double
Returns the optimization end criteria of the simultaneous calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CmsMarketCalibration |
Return value: QuantLib::EndCriteria::Type
Returns the elapsed time of the simultaneous calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarketCalibration |
Return value: double
returns results of Sabr calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarketCalibration |
Return value: any
returns results of Sabr calibration.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarketCalibration |
Return value: any
return the market and implied spreads matrix.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CmsMarketCalibration |
Return value: any
Returns vector of historic dates for which some fixing is missing.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalForwardRatesAnalysis |
Return value: QuantLib::Date
Returns vector of error messages for historic dates with missing fixing.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalForwardRatesAnalysis |
Return value: string
Returns vector of dates for which forward rates could not be calculated.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalForwardRatesAnalysis |
Return value: QuantLib::Date
Returns vector of error messages for dates on which forward rates could not be calculated.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalForwardRatesAnalysis |
Return value: string
Returns the forward rates time grid.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalForwardRatesAnalysis |
Return value: QuantLib::Period
Returns vector of historic dates for which some fixing is missing.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalRatesAnalysis |
Return value: QuantLib::Date
Returns vector of error messages for historic dates with missing fixing.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::HistoricalRatesAnalysis |
Return value: string
Returns the pseudo-root of the equivalent covariance swap rates matrix.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantCorrelation | ||
| TimeIndex: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Matrix
Piecewise Constant Correlation Times.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantCorrelation |
Return value: double
Piecewise Constant Correlation Number of Rates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantCorrelation |
Return value: QuantLib::Size
Returns the upper limit of the integral.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::NumericHaganPricer |
Return value: double
Returns the CL NPV.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CreditDefaultSwap |
Return value: QuantLib::Real
Returns the DL NPV.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CreditDefaultSwap |
Return value: QuantLib::Real
Returns the running spread that, given the quoted recovery rate, will make the running-only CDS have an NPV of 0.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CreditDefaultSwap |
Return value: QuantLib::Rate
Returns the upfront spread that, given the running spread and the quoted recovery rate, will make the instrument have an NPV of 0.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CreditDefaultSwap |
Return value: QuantLib::Rate
Dates on which the hazard rate interpolation is performed.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseHazardRateCurve |
Return value: QuantLib::Date
Dates on which the hazard rate interpolation is performed.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseHazardRateCurve |
Return value: QuantLib::Real
Implied black CDS option volatility.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CdsOption | ||
| Price: | QuantLib::Real | N/S | N/S |
| RecoveryRate: | QuantLib::Real | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| DefaultCurve: | QuantLib::DefaultProbabilityTermStructure | N/S | N/S |
Return value: QuantLib::Volatility
Returns the interpolated base correlation value.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::BaseCorrelationTermStructure | ||
| Date: | QuantLib::Date | N/S | N/S |
| LossLevel: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
calibrate.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration | ||
| NumberOfFactors: | QuantLib::Natural | 3 | N/S |
| MaxIter: | QuantLib::Natural | N/S | N/S |
| Tol: | QuantLib::Real | N/S | N/S |
| InnerMaxIter: | QuantLib::Natural | N/S | N/S |
| InnerTol: | QuantLib::Real | N/S | N/S |
Return value: bool
failures.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Natural
deformationSize.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
market caplet volalitilies.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
model caplet volalitilies.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
capletRmsError.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
capletMaxError.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
market swaption volalitilies.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
model swaption volalitilies.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
swaptionRmsError.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
swaptionMaxError.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration |
Return value: QuantLib::Real
swapPseudoRoot.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Matrix
timeDependentCalibratedSwaptionVols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Volatility
timeDependentUnCalibratedSwaptionVols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletCalibration | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Volatility
alpha.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CTSMMCapletAlphaFormCalibration |
Return value: QuantLib::Real
return the rate times of the CurveState object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CurveState |
Return value: QuantLib::Time
return the rate taus of the CurveState object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CurveState |
Return value: QuantLib::Time
Returns the current forward rates of the CurveState object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CurveState |
Return value: QuantLib::Rate
Returns the current swap rates of the CurveState object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CurveState |
Return value: QuantLib::Rate
Returns the current swap rates of the CurveState object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CurveState | ||
| SpanningForwards: | QuantLib::Size | 4 | N/S |
Return value: QuantLib::Rate
set the CurveState object on given vector of coterminal swaps.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CMSwapCurveState | ||
| CMSwapRates: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
Return value: void
set the CurveState object on given vector of coterminal swaps.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CoterminalSwapCurveState | ||
| CoterminalSwaps: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
Return value: void
set the CurveState object on given vector of forward rates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::LMMCurveState | ||
| Rates: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
Return value: void
set the CurveState object on given vector of discount ratios.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::LMMCurveState | ||
| DiscountRatios: | double | 1.0,1.0,1.0,1.0,1.0 | N/S |
Return value: void
Assigns a Default Loss Model to a given basket. Subsequent basket computations will use that model.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DefaultLossModel: | QuantLib::DefaultLossModel | N/S | N/S |
Return value: void
Number of counterparties at inception.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket |
Return value: QuantLib::Size
Non defaulted portfolio outstanding notional.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket |
Return value: QuantLib::Real
Losses from default events.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket |
Return value: QuantLib::Real
Remaining attach amount.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket |
Return value: QuantLib::Real
Remaining detach amount.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket |
Return value: QuantLib::Real
Basket expected tranche according to the basket loss model.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateForLoss: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Basket loss percentile amount (tranched).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateForLoss: | QuantLib::Date | N/S | N/S |
| PercentileValue: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
Basket loss expected shortfall amount (tranched).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateForLoss: | QuantLib::Date | N/S | N/S |
| PercentileValue: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
Probability of each basket name to default in the given order.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| EventOrder: | QuantLib::Size | N/S | N/S |
| DateForLoss: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Probability of basket losses to be over a value at a given date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateForLoss: | QuantLib::Date | N/S | N/S |
| LossFractionValue: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
Splits a loss amount by counterparty contribution.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateForLoss: | QuantLib::Date | N/S | N/S |
| LossValue: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
Default correlation between two basket issuers.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Basket | ||
| DateCorrel: | QuantLib::Date | N/S | N/S |
| IndexIssuer1: | QuantLib::Size | N/S | N/S |
| IndexIssuer2: | QuantLib::Size | N/S | N/S |
Return value: QuantLib::Real
Returns the probability of default between the reference date and the given date from the given DefaultProbabilityTermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::DefaultProbabilityTermStructure | ||
| Dates: | QuantLib::Date | '1Y,2Y,3Y,4Y,5Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Probability
Full factor drift computation using the LMMDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Reduced factor (Joshi algorithm) drift computation using the LMMDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Reduced factor (Joshi algorithm) drift computation using the LMMDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Full factor drift computation using the LMMNormalDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMNormalDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Reduced factor (Joshi algorithm) drift computation using the LMMNormalDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMNormalDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Reduced factor (Joshi algorithm) drift computation using the LMMNormalDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::LMMNormalDriftCalculator | ||
| CurveState: | QuantLib::LMMCurveState | N/S | N/S |
Return value: double
Full factor drift computation using the CMSMMDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CMSMMDriftCalculator | ||
| CurveState: | QuantLib::CMSwapCurveState | N/S | N/S |
Return value: double
Full factor drift computation using the SMMDriftCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SMMDriftCalculator | ||
| CurveState: | QuantLib::CoterminalSwapCurveState | N/S | N/S |
Return value: double
rates fixing times for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: QuantLib::Time
rate taus for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: QuantLib::Time
evolution times for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: QuantLib::Time
first alive rate at each evolution time for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: QuantLib::Size
number of rates for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: long
number of steps for the EvolutionDescription object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EvolutionDescription |
Return value: long
Returns all exercise dates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Exercise |
Return value: QuantLib::Date
Returns last exercise date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Exercise |
Return value: QuantLib::Date
Returns the relevant forward rate associated with the FRA term.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::ForwardRateAgreement |
Return value: QuantLib::Rate
Returns the forward value of the FRA.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::ForwardRateAgreement |
Return value: double
Returns the spot value of the FRA.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::ForwardRateAgreement |
Return value: double
ID of object to which this handle is linked - empty string if none.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Handle |
Return value: string
True if handle is empty, False if not.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Handle |
Return value: bool
Relink the RelinkableHandle to the given object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::RelinkableHandle | ||
| CurrentLink: | string | N/S | N/S |
Return value: void
Returns the name for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index |
Return value: string
Returns the calendar (e.g. TARGET) for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index |
Return value: QuantLib::Calendar
Returns TRUE if the fixing date is a valid one for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index | ||
| FixingDate: | QuantLib::Date | 10-Feb-2007 | N/S |
Return value: bool
Returns the fixing for the given Index object. The fixing is retrieved from the time series if available, otherways it is forecasted.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index | ||
| FixingDate: | QuantLib::Date | 02-Jan-2007 | N/S |
| ForecastToday: | bool | N/S | False |
Return value: QuantLib::Real
Adds fixings for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Index | ||
| FixingDates: | QuantLib::Date | N/S | N/S |
| FixingValues: | QuantLib::Real | N/S | N/S |
| ForceOverwrite: | bool | N/S | False |
Return value: void
Adds fixings for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index | ||
| ForceOverwrite: | bool | N/S | False |
| TimeSeriesID: | QuantLib::TimeSeriesDef | N/S | N/S |
Return value: void
Clear all fixings for the given Index object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Index |
Return value: void
Returns the family name (e.g. EURIBOR) for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex |
Return value: string
Returns the tenor (i.e. length, e.g. 6M, 10Y) for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex |
Return value: QuantLib::Period
Returns the fixing days (e.g. 2) for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex |
Return value: QuantLib::Natural
Returns the currency (e.g. EUR) for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex |
Return value: QuantLib::Currency
Returns the DayCounter (e.g. Actual/360) for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex |
Return value: QuantLib::DayCounter
Returns the value date for the given fixing date for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex | ||
| FixingDate: | QuantLib::Date | 02-Jan-2007 | N/S |
Return value: QuantLib::Date
Returns the fixing date for the given value date for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex | ||
| ValueDate: | QuantLib::Date | 02-Jan-2007 | N/S |
Return value: QuantLib::Date
Returns the maturity date for the given value date for the given InterestRateIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRateIndex | ||
| ValueDate: | QuantLib::Date | 02-Jan-2007 | N/S |
Return value: QuantLib::Date
Returns the business day convention (e.g. Modified Following) for the given IborIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::IborIndex |
Return value: QuantLib::BusinessDayConvention
Returns TRUE if the given IborIndex object follows the 'end of month' convention.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::IborIndex |
Return value: bool
Returns the fixed leg tenor (e.g. 1Y) for the given SwapIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwapIndex |
Return value: QuantLib::Period
Returns the business day convention (e.g. Modified Following) for the given SwapIndex object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwapIndex |
Return value: QuantLib::BusinessDayConvention
Returns the NPV for the given Instrument object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Instrument |
Return value: double
Returns the NPV error estimation (for e.g. Monte Carlo simulation) for the given Instrument object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Instrument |
Return value: double
Returns the date to which the net present value refers.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Instrument |
Return value: QuantLib::Date
Returns the required result (if available) for the given Instrument object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Instrument | ||
| ResultType: | string | vega | N/S |
Return value: double
Returns TRUE if the given Instrument object is expired.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Instrument |
Return value: bool
Sets a new pricing engine to the given Instrument object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Instrument | ||
| PricingEngine: | QuantLibAddin::PricingEngine | PricingEngineID | N/S |
Return value: void
Sets the enable extrapolation flag to the given Extrapolator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Extrapolator | ||
| ExtrapolationFlag: | bool | N/S | N/S |
Return value: void
Returns interpolated values using the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Interpolation | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| AllowExtrapolation: | bool | N/S | false |
Return value: QuantLib::Real
Returns the first derivative function values using the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Interpolation | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| AllowExtrapolation: | bool | N/S | false |
Return value: QuantLib::Real
Returns the second derivative function values using the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Interpolation | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| AllowExtrapolation: | bool | N/S | false |
Return value: QuantLib::Real
Returns the primitive function values using the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Interpolation | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| AllowExtrapolation: | bool | N/S | false |
Return value: QuantLib::Real
Returns TRUE if the input value is in the allowed interpolation range for the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
Return value: bool
Returns the minimum value of the x array for the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation |
Return value: QuantLib::Real
Returns the maximum value of the x array for the given Interpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation |
Return value: QuantLib::Real
Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CubicInterpolation |
Return value: QuantLib::Real
Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CubicInterpolation |
Return value: QuantLib::Real
Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CubicInterpolation |
Return value: QuantLib::Real
Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CubicInterpolation |
Return value: QuantLib::Real
Returns a vector of bool (one per cubic) indicating if there has been a monotonicity adjustment.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::CubicInterpolation |
Return value: bool
Returns the a in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the b in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the c in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the d in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the error of the fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the max error of the fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::Real
Returns the optimization end criteria of the fit for the given AbcdInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::AbcdInterpolation |
Return value: QuantLib::EndCriteria::Type
Returns the expiry time in years for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SABRInterpolation |
Return value: QuantLib::Time
Returns the forward for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SABRInterpolation |
Return value: QuantLib::Real
Returns the alpha of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the alpha of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the nu of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the rho of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the error of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the max error of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the optimization end criteria of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::EndCriteria::Type
Returns the weights of the fit for the given SABRInterpolation object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SABRInterpolation |
Return value: QuantLib::Real
Returns the minimum value of the x array for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the maximum value of the x array for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the x array grid for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the minimum value of the y array for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the maximum value of the y array for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the y array grid for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Real
Returns the z data matrix grid for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D |
Return value: QuantLib::Matrix
Returns TRUE if the (x,y) input value is in the allowed interpolation range for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D | ||
| XValues: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| YValue: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
Return value: bool
Returns interpolated values for the (x,y) input for the given Interpolation2D object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Interpolation2D | ||
| XValue: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| YValue: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | false |
| AllowExtrapolation: | bool | N/S | false |
Return value: QuantLib::Real
Default probability correlation.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::GaussianDefProbLM | ||
| CorrelationDate: | QuantLib::Date | N/S | N/S |
| NameindexA: | QuantLib::Size | N/S | N/S |
| NameindexB: | QuantLib::Size | N/S | N/S |
Return value: QuantLib::Real
Default probability correlation.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::GaussianDefProbLM | ||
| NameindexA: | QuantLib::Size | N/S | N/S |
| NameindexB: | QuantLib::Size | N/S | N/S |
Return value: QuantLib::Real
Probability of having a given number of defaults or more.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::GaussianDefProbLM | ||
| NumDefaults: | QuantLib::Size | N/S | N/S |
| ProbabilityDate: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Default probability correlation.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TDefProbLM | ||
| CorrelationDate: | QuantLib::Date | N/S | N/S |
| NameindexA: | QuantLib::Size | N/S | N/S |
| NameindexB: | QuantLib::Size | N/S | N/S |
Return value: QuantLib::Real
Default probability correlation.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TDefProbLM | ||
| NameindexA: | QuantLib::Size | N/S | N/S |
| NameindexB: | QuantLib::Size | N/S | N/S |
Return value: QuantLib::Real
Probability of having a given number of defaults or more.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TDefProbLM | ||
| NumDefaults: | QuantLib::Size | N/S | N/S |
| ProbabilityDate: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Returns the flow analysis for the given Leg object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Leg | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
Set the coupon pricer at the given Leg object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Leg | ||
| FloatingRateCouponPricer: | QuantLibAddin::FloatingRateCouponPricer | N/S | N/S |
Return value: void
Returns the rate in the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate |
Return value: QuantLib::Rate
Returns the DayCounter in the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate |
Return value: QuantLib::DayCounter
Returns the Compounding in the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate |
Return value: QuantLib::Compounding
Returns the Frequency in the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate |
Return value: QuantLib::Frequency
Returns the discount factor between two dates based on the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate | ||
| StartDate: | QuantLib::Date | 40070 | N/S |
| EndDate: | QuantLib::Date | 40100 | N/S |
| RefPeriodStart: | QuantLib::Date | N/S | N/S |
| RefPeriodEnd: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Returns the compound factor between two dates based on the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate | ||
| StartDate: | QuantLib::Date | 40070 | N/S |
| EndDate: | QuantLib::Date | 40100 | N/S |
| RefPeriodStart: | QuantLib::Date | N/S | N/S |
| RefPeriodEnd: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
Returns the equivalent rate for a compounding period between two dates based on the given InterestRate object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::InterestRate | ||
| DayCounter: | QuantLib::DayCounter | "Actual/365 (Fixed)" | N/S |
| Compounding: | QuantLib::Compounding | "Simple" | False |
| Frequency: | QuantLib::Frequency | N/S | False |
| StartDate: | QuantLib::Date | 40070 | N/S |
| EndDate: | QuantLib::Date | 40100 | N/S |
| RefPeriodStart: | QuantLib::Date | N/S | N/S |
| RefPeriodEnd: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Real
start a new path for the MarketModelEvolver object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelEvolver |
Return value: double
advance a single step in the current path for the MarketModelEvolver object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelEvolver |
Return value: double
returns the current step index in the current path for the MarketModelEvolver object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelEvolver |
Return value: QuantLib::Size
returns the current step index in the current path for the MarketModelEvolver object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelEvolver |
Return value: QuantLib::Size
initial rates for the MarketModel object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel |
Return value: QuantLib::Rate
rates' displacemets for the MarketModel object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel |
Return value: QuantLib::Spread
number of rates for the MarketModel object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel |
Return value: long
number of factors for the MarketModel object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel |
Return value: long
number of steps for the MarketModel object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel |
Return value: long
Returns the pseudo root for the i-th step.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Matrix
Returns the covariance matrix for the i-th step.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Matrix
Returns the covariance matrix from start up to the i-th step.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Matrix
Returns the time dependent vol for rate i.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModel | ||
| Index: | QuantLib::Size | 0 | N/S |
Return value: QuantLib::Volatility
Returns the eigenvalues for the given SymmetricSchurDecomposition object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SymmetricSchurDecomposition |
Return value: QuantLib::Array
Returns the eigenvectors for the given SymmetricSchurDecomposition object. Eigenvectors are returned columnwise.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SymmetricSchurDecomposition |
Return value: QuantLib::Matrix
Returns the variance vector for the given CovarianceDecomposition object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CovarianceDecomposition |
Return value: QuantLib::Array
Returns the standard deviation (i.e. volatility times square root of time) vector for the given CovarianceDecomposition object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CovarianceDecomposition |
Return value: QuantLib::Array
Returns the correlation matrix for the given CovarianceDecomposition object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::CovarianceDecomposition |
Return value: QuantLib::Matrix
Returns the number of max interation for the given EndCriteria object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EndCriteria |
Return value: QuantLib::Size
Returns the number of max interation in a stationary state for the given EndCriteria object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EndCriteria |
Return value: QuantLib::Size
Returns the function epsilon for the given EndCriteria object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EndCriteria |
Return value: QuantLib::Real
Returns the gradient norm epsilon for the given EndCriteria object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::EndCriteria |
Return value: QuantLib::Real
delta of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
delta forward of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
elasticity of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
gamma of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
theta of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
theta per day of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
vega of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
rho of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
dividend rho of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
itm cash probability of an option.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OneAssetOption |
Return value: QuantLib::Real
returns the BPS of the fixed rate leg for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: double
returns the NPV of the fixed rate leg for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: double
returns the fair fixed leg rate which would zero the swap NPV for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::Rate
returns the BPS of the overnight rate leg for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: double
returns the NPV of the overnight rate leg for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: double
returns the fair spread over the overnight rate which would zero the swap NPV for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::Spread
returns the swap type (Payer or Receiver) of the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::OvernightIndexedSwap::Type
returns the swap nominal for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: double
returns the fixed rate for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::Rate
returns the fixed rate day count convention for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::DayCounter
returns the spread over overnight rate for the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::OvernightIndexedSwap |
Return value: QuantLib::Spread
returns the fixed rate leg cash flow analysis of the given OvernightIndexedSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::OvernightIndexedSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
returns the overnight rate leg cash flow analysis.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::OvernightIndexedSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
returns the type (e.g. Vanilla, CashOrNothing, etc.) for the given Payoff object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Payoff |
Return value: string
returns the description (e.g. CashOrNothing, strike 32.2, cash payoff 2.5) for the given Payoff object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Payoff |
Return value: string
returns the payoff value given an underlying reference level for the given Payoff object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Payoff | ||
| Underlying: | QuantLib::Real | 0.01 | N/S |
Return value: double
returns the option-type (e.g. Call, Put) for the given Payoff object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TypePayoff |
Return value: QuantLib::Option::Type
returns the strike for the given Payoff object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::StrikedTypePayoff |
Return value: QuantLib::Real
returns the third parameter of a StrikedType payoff.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::StrikedTypePayoff |
Return value: QuantLib::Real
Retrieve list of Times for the given PiecewiseYieldCurve<Traits, Interpolator>.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseYieldCurve |
Return value: QuantLib::Time
Retrieve list of Dates for the given PiecewiseYieldCurve<Traits, Interpolator>.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseYieldCurve |
Return value: QuantLib::Date
Retrieve Data for the given PiecewiseYieldCurve<Traits, Interpolator>.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseYieldCurve |
Return value: QuantLib::Real
Retrieve list of jump times for the given PiecewiseYieldCurve<Traits, Interpolator>.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseYieldCurve |
Return value: QuantLib::Time
Retrieve list of jump dates for the given PiecewiseYieldCurve<Traits, Interpolator>.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::PiecewiseYieldCurve |
Return value: QuantLib::Date
returns the option value for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the sensitivity to change in the underlying forward price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the sensitivity to change in the underlying spot price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| Spot: | QuantLib::Real | N/S | N/S |
Return value: double
returns the sensitivity in percent to a percent change in the underlying forward price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the sensitivity in percent to a percent change in the underlying spot price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| Spot: | QuantLib::Real | N/S | N/S |
Return value: double
returns the second order derivative with respect to change in the underlying forward price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the second order derivative with respect to change in the underlying spot price for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| Spot: | QuantLib::Real | N/S | N/S |
Return value: double
returns the sensitivity to time to maturity for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| Spot: | QuantLib::Real | N/S | N/S |
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the sensitivity to time to maturity per day, assuming 365 days per year, for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| Spot: | QuantLib::Real | N/S | N/S |
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the sensitivity to volatility for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the sensitivity to discounting rate for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the sensitivity to dividend/growth rate for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator | ||
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the probability of being in the money in the bond martingale measure for the given BlackCalculator object. It is a risk-neutral probability, not the real world probability.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the probability of being in the money in the asset martingale measure for the given BlackCalculator object. It is a risk-neutral probability, not the real world probability.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the sensitivity to strike for the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the alpha of the internal formulation of the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the beta of the internal formulation of the given BlackCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackCalculator |
Return value: double
returns the sensitivity to change in the underlying spot price for the given BlackScholesCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackScholesCalculator |
Return value: double
returns the sensitivity in percent to a percent change in the underlying spot price for the given BlackScholesCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackScholesCalculator |
Return value: double
returns the second order derivative with respect to change in the underlying spot price for the given BlackScholesCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackScholesCalculator |
Return value: double
returns the sensitivity to time to maturity for the given BlackScholesCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackScholesCalculator | ||
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
returns the sensitivity to time to maturity per day, assuming 365 days per year, for the given BlackScholesCalculator object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackScholesCalculator | ||
| TimeToMaturity: | QuantLib::Time | N/S | N/S |
Return value: double
Add new product to MarketModelComposite object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MultiProductComposite | ||
| Product: | QuantLib::MarketModelMultiProduct | N/S | N/S |
Return value: void
finalize the MarketModelComposite object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MultiProductComposite |
Return value: void
suggested Numeraires for the MarketModelMultiProduct object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelMultiProduct |
Return value: QuantLib::Size
possible cash flow times for the MarketModelMultiProduct object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelMultiProduct |
Return value: QuantLib::Time
number of products in the MarketModelMultiProduct object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelMultiProduct |
Return value: long
Max number of cashflows per product per step for the MarketModelMultiProduct object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::MarketModelMultiProduct |
Return value: long
Returns the current value of the given Quote object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Quote |
Return value: QuantLib::Real
Returns TRUE if the given Quote object has a valid value.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Quote |
Return value: bool
resets the given SimpleQuote object to the uninitialized state.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SimpleQuote |
Return value: void
sets a new value to the given SimpleQuote object and returns the difference with the previous value.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SimpleQuote | ||
| Value: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
sets the tick value of the given SimpleQuote object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SimpleQuote | ||
| Value: | QuantLib::Real | 0.0001 | N/S |
Return value: void
returns the tick value of the given SimpleQuote object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SimpleQuote |
Return value: QuantLib::Real
Return the value of HW volatility.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FuturesConvAdjustmentQuote |
Return value: QuantLib::Real
Return the value of HW mean reversion.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FuturesConvAdjustmentQuote |
Return value: QuantLib::Real
Return the IMM date of futures.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FuturesConvAdjustmentQuote |
Return value: QuantLib::Date
Return the value of futures underlying.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FuturesConvAdjustmentQuote |
Return value: QuantLib::Real
Return the date of the last fixing
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::LastFixingQuote |
Return value: QuantLib::Date
generate variates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::RandomSequenceGenerator | ||
| Samples: | long | 5 | N/S |
Return value: double
Set the coupon pricer at the given coupon object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon | ||
| RangeAccrualPricer: | QuantLib::RangeAccrualPricer | N/S | N/S |
Return value: void
Return the observation Dates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon |
Return value: QuantLib::Date
Return the accrual start Date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon |
Return value: QuantLib::Date
Return the accrual end Date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon |
Return value: QuantLib::Date
Return the observations number.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon |
Return value: QuantLib::Size
return the price of Range Accrual Floater Coupon.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon | ||
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
Return value: double
return the price of Simple Floater Coupon.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RangeAccrualFloatersCoupon | ||
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
Return value: double
returns the earliest date for the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: QuantLib::Date
returns the latest relevant date for the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: QuantLib::Date
returns the pillar date for the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: QuantLib::Date
returns the maturity date for the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: QuantLib::Date
returns the objectID of the Quote wrapped in the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::RateHelper |
Return value: string
returns the value of the Quote wrapped in the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: double
returns the isValid boolean of the Quote wrapped in the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: double
returns the curve implied quote of the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: double
returns the error between the curve implied quote and the value of the Quote wrapped in the given RateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::RateHelper |
Return value: double
returns the spread for the given SwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwapRateHelper |
Return value: QuantLib::Spread
returns the forward start period for the given SwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwapRateHelper |
Return value: QuantLib::Period
returns the convexity adjustment for the given FuturesRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FuturesRateHelper |
Return value: QuantLib::Spread
returns the fx spot quote value for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: QuantLib::Real
returns the tenor for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: QuantLib::Period
returns the number of fixing days for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: QuantLib::Natural
returns the calendar for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: QuantLib::Calendar
returns the business day convention for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: QuantLib::BusinessDayConvention
returns the end of month flag for the given FxSwapRateHelper object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: bool
returns TRUE if the base currency of the fx currency pair is the one used as collateral, FALSE otherwise.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::FxSwapRateHelper |
Return value: bool
returns the number of dates in the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Size
returns the highest date in the given Schedule object preceding the input reference date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule | ||
| RefDate: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Date
returns the lowest date in the given Schedule object following the input reference date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule | ||
| RefDate: | QuantLib::Date | N/S | N/S |
Return value: QuantLib::Date
returns the dates for the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Date
returns TRUE if the selected period in the given Schedule object is regular.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule | ||
| Index: | QuantLib::Size | 1 | N/S |
Return value: bool
returns TRUE if the given Schedule object is empty.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: bool
returns the Calendar used to calculate the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Calendar
returns the start date of the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Date
returns the end date of the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Date
returns the tenor used to calculate the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::Period
returns the business day convention used to calculate the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::BusinessDayConvention
returns the business day convention used to calculate the termination date of the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::BusinessDayConvention
returns the DateGeneration::Rule of the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: QuantLib::DateGeneration::Rule
returns TRUE if end-of-month convention has been used to calculate the given Schedule object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Schedule |
Return value: bool
Returns the number of samples collected for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Size
Returns the sum of data weights for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the mean for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the variance for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the the standard deviation for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the variance of observations below zero for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the square root of the downside variance for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the variance of observations below the mean for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the square root of the semivariance for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the error estimate on the mean value for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the skewness for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the excess kurtosis for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the minimum sample value for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the maximum sample value for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Real
Returns the x-th percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the x-th percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the reciprocal of VAR at a given percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the reciprocal of VAR at a given percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Centile: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the value-at-risk at a given percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the value-at-risk at a given percentile for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the variance of observations below target for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the probability of missing the given target for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the probability of missing the given target for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the averaged shortfallness for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the averaged shortfallness for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the size (sample dimensionality) for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Size
Returns the covariance Matrix for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Matrix
Returns the correlation Matrix for the given SequenceStatistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SequenceStatistics |
Return value: QuantLib::Matrix
returns mean reverting speed a, with dr(t) = a(b-r(t))dt + sigma dW(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Vasicek |
Return value: QuantLib::Real
returns short-rate limit value b, with dr(t) = a(b-r(t))dt + sigma dW(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Vasicek |
Return value: QuantLib::Real
returns the risk premium.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Vasicek |
Return value: QuantLib::Real
returns the volatility sigma, with dr(t) = a(b-r(t))dt + sigma dW(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Vasicek |
Return value: QuantLib::Real
returns the drift of x(t) dynamics with r(t) = x(t) + y(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 |
Return value: QuantLib::Real
returns the volatility of x(t) dynamics with r(t) = x(t) + y(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 |
Return value: QuantLib::Real
returns the drift of y(t) dynamics with r(t) = x(t) + y(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 |
Return value: QuantLib::Real
returns the volatility of y(t) dynamics with r(t) = x(t) + y(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 |
Return value: QuantLib::Real
returns the correlation between x(t) and y(t) with r(t) = x(t) + y(t).
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::G2 |
Return value: QuantLib::Real
Returns the volatility at a given strike from the SmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SmileSection | ||
| Strike: | QuantLib::Rate | N/S | N/S |
Return value: QuantLib::Volatility
Returns the variance at a given strike from the SmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SmileSection | ||
| Strike: | QuantLib::Rate | N/S | N/S |
Return value: double
Returns the current value of the SmileSection underlying.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SmileSection |
Return value: double
Returns the exercise date of the SmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SmileSection |
Return value: QuantLib::Date
Returns the DayCounter of the SmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SmileSection |
Return value: QuantLib::DayCounter
Returns the alpha of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the beta of the SABR fit.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the nu of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the rho of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the error of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the max error of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: double
Returns the optimization end criteria of the SABR fit for the given SabrInterpolatedSmileSection object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrInterpolatedSmileSection |
Return value: QuantLib::EndCriteria::Type
Returns the number of samples collected for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Size
Returns the sum of data weights for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the mean for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the variance for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the the standard deviation for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the error estimate on the mean value for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the skewness for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the excess kurtosis for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the minimum sample value for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the maximum sample value for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the x-th percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the x-th top percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the variance of observations below zero for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the square root of the downside variance for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the variance of observations below the target for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the x-th percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the x-th top percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| X: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the reciprocal of VAR at a given percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the value-at-risk at a given percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the expected loss in case that the loss exceeded a VaR threshold for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | N/S | N/S |
Return value: QuantLib::Real
Returns the probability of missing the given target for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the averaged shortfallness for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the variance of observations below the mean for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the square root of the semivariance for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the variance of observations below zero for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the square root of the downside variance for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics |
Return value: QuantLib::Real
Returns the variance of observations below target for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the reciprocal of VAR at a given percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Centile: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the value-at-risk at a given percentile for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the expected loss in case that the loss exceeded a VaR threshold for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Centile: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the probability of missing the given target for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
Returns the averaged shortfallness for the given Statistics object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Statistics | ||
| Target: | QuantLib::Real | 0.5 | N/S |
Return value: QuantLib::Real
returns the BPS of the i-th leg for the given Swap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swap | ||
| LegNumber: | long | 1 | N/S |
Return value: double
returns the NPV of the i-th leg for the given Swap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swap | ||
| LegNumber: | long | 1 | N/S |
Return value: double
Returns the start (i.e. first accrual) date for the given Swap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swap |
Return value: QuantLib::Date
Returns the maturity (i.e. last payment) date for the given Swap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swap |
Return value: QuantLib::Date
Returns the cash flow analysis of the i-th leg for the given Swap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::Swap | ||
| LegNumber: | long | 1 | N/S |
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
returns the type (Payer or Receiver) for the given Swaption object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swaption |
Return value: QuantLib::VanillaSwap::Type
returns the settlement type (Cash or Delivery) for the given Swaption object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swaption |
Return value: QuantLib::Settlement::Type
Returns the volatility implied by the given price for the given Swaption object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::Swaption | ||
| Price: | QuantLib::Real | 0.2 | N/S |
| Guess: | QuantLib::Volatility | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| MaxIter: | QuantLib::Natural | N/S | N/S |
| MinVol: | QuantLib::Volatility | N/S | N/S |
| MaxVol: | QuantLib::Volatility | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
Return value: QuantLib::Volatility
Returns volatility from the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns volatility from the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns variance from the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: double
Returns variance from the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Strike: | QuantLib::Rate | 0.04 | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: double
Returns the max swap tenor (i.e. length) for which the given SwaptionVolatilityStructure object can return vols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure |
Return value: QuantLib::Period
Returns the business day convention used for option date calculation by the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure |
Return value: QuantLib::BusinessDayConvention
Returns the option date corresponding to a given option tenor, taking calendar and business day convention into account, for the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| OptionTenor: | QuantLib::Period | 2y | N/S |
Return value: QuantLib::Date
Returns the swap length corresponding to a given swap tenor for the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| SwapTenor: | QuantLib::Period | 2y | N/S |
Return value: QuantLib::Time
Returns the swap length corresponding to a given swap start/end dates for the given SwaptionVolatilityStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityStructure | ||
| SwapStart: | QuantLib::Date | 2y | N/S |
| SwapEnd: | QuantLib::Date | 2y | N/S |
Return value: QuantLib::Time
Returns the vector of swaption exercise dates for the given SwaptionVolatilityDiscrete object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityDiscrete |
Return value: QuantLib::Date
Returns the vector of swaption exercise tenors for the given SwaptionVolatilityDiscrete object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityDiscrete |
Return value: QuantLib::Period
Returns the vector of underlying swap tenors for the given SwaptionVolatilityDiscrete object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityDiscrete |
Return value: QuantLib::Period
Returns the lower indexes of surrounding volatility matrix corners for the given SwaptionVolatilityMatrix object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SwaptionVolatilityMatrix | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
Return value: long
Returns the at-the-money swaption strike, for a given exercise date and underlying swap length, for the given SwaptionVolatilityCube object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityCube | ||
| OptionDate: | QuantLib::Date | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
Return value: QuantLib::Rate
Returns the at-the-money swaption strike, for a given option tenor and underlying swap length, for the given SwaptionVolatilityCube object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SwaptionVolatilityCube | ||
| OptionTenor: | QuantLib::Period | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
Return value: QuantLib::Rate
returns results of Sabr calibration for the given SwaptionVolCube1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SwaptionVolCube1 |
Return value: any
returns results of Sabr calibration for the given SwaptionVolCube1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SwaptionVolCube1 |
Return value: any
returns the market volatility cube for the given SwaptionVolCube1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SwaptionVolCube1 |
Return value: any
returns the volatility cube calibrated to ATM matrix for the given SwaptionVolCube1 object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SwaptionVolCube1 |
Return value: any
Returns the DayCounter used by the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure |
Return value: QuantLib::DayCounter
Returns the max date for the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure |
Return value: QuantLib::Date
Returns the reference date for the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure |
Return value: QuantLib::Date
Returns the time from the reference date for the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure | ||
| Date: | QuantLib::Date | 1Y | N/S |
Return value: QuantLib::Time
Returns the calendar used by the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure |
Return value: QuantLib::Calendar
Returns the number of settlement days for the given TermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TermStructure |
Return value: QuantLib::Natural
Returns a discount factor from the given YieldTermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::YieldTermStructure | ||
| DfDates: | QuantLib::Date | '1Y,2Y,3Y,4Y,5Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::DiscountFactor
Returns the forward interest rate from the given YieldTermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::YieldTermStructure | ||
| D1: | QuantLib::Date | 1M | N/S |
| D2: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| ResultDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Compounding: | QuantLib::Compounding | N/S | False |
| Frequency: | QuantLib::Frequency | N/S | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::InterestRate
Returns the forward interest rate from the given YieldTermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::YieldTermStructure | ||
| Date: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| Period: | QuantLib::Period | 1Y | N/S |
| ResultDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Compounding: | QuantLib::Compounding | N/S | False |
| Frequency: | QuantLib::Frequency | N/S | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::InterestRate
Returns the zero interest rate from the given YieldTermStructure object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::YieldTermStructure | ||
| Dates: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| ResultDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Compounding: | QuantLib::Compounding | N/S | False |
| Frequency: | QuantLib::Frequency | N/S | False |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::InterestRate
Retrieve list of Times for the given InterpolatedYieldCurve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::InterpolatedYieldCurve |
Return value: QuantLib::Time
Retrieve list of Dates for the given InterpolatedYieldCurve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::InterpolatedYieldCurve |
Return value: QuantLib::Date
Retrieve Data for the given InterpolatedYieldCurve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::InterpolatedYieldCurve |
Return value: QuantLib::Real
Retrieve list of jump times for the given InterpolatedYieldCurve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::InterpolatedYieldCurve |
Return value: QuantLib::Time
Retrieve list of jump dates for the given InterpolatedYieldCurve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::InterpolatedYieldCurve |
Return value: QuantLib::Date
Returns the first date for which a historical datum exists.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: QuantLib::Date
Returns the last date for which a historical datum exists.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: QuantLib::Date
Returns the size of the time series.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: QuantLib::Size
Returns whether the series contains any data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: bool
Returns the dates for which historical data exist.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: QuantLib::Date
Returns the historical data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::TimeSeriesDef |
Return value: QuantLib::Real
Returns returns the data corresponding to the given dates.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::TimeSeriesDef | ||
| Dates: | QuantLib::Date | 02-Jan-2007 | N/S |
Return value: QuantLib::Real
returns the BPS of the fixed rate leg for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: double
returns the NPV of the fixed rate leg for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: double
returns the fair fixed leg rate which would zero the swap NPV for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::Rate
returns the BPS of the floating rate leg for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: double
returns the NPV of the floating rate leg for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: double
returns the fair spread over the floating rate which would zero the swap NPV for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::Spread
returns the swap type (Payer or Receiver) of the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::VanillaSwap::Type
returns the swap nominal for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: double
returns the fixed leg rate for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::Rate
returns the fixed rate day count convention for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::DayCounter
returns the spread over floating rate for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::Spread
returns the floating leg day count convention for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::DayCounter
returns the payment business day convention for the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VanillaSwap |
Return value: QuantLib::BusinessDayConvention
returns the fixed rate leg cash flow analysis of the given VanillaSwap object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::VanillaSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
returns the floating rate leg cash flow analysis.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::VanillaSwap | ||
| AfterDate: | QuantLib::Date | N/S | False |
Return value: any
Returns the business day convention used in tenor to date conversion.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VolatilityTermStructure |
Return value: QuantLib::BusinessDayConvention
Returns the option date corrisponding to a given option tenor.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VolatilityTermStructure | ||
| Tenor: | QuantLib::Period | 1Y | N/S |
Return value: QuantLib::Date
Returns the minimum strike for which the given VolatilityTermStructure can return vols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VolatilityTermStructure |
Return value: QuantLib::Rate
Returns the maximum strike for which the given VolatilityTermStructure can return vols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::VolatilityTermStructure |
Return value: QuantLib::Rate
Returns the spot at-the-money (no-smile) volatility at a given option date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionDate: | QuantLib::Date | 1Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the spot at-the-money (no-smile) volatility at a given option tenor.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionTenor: | QuantLib::Period | 1Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the spot at-the-money (no-smile) volatility at a given option time.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionTime: | QuantLib::Time | 1.0 | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the spot at-the-money (no-smile) variance at a given option date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionDate: | QuantLib::Date | 1Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the spot at-the-money (no-smile) variance at a given option tenor.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionTenor: | QuantLib::Period | 1Y | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the spot at-the-money (no-smile) variance at a given option time.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackAtmVolCurve | ||
| OptionTime: | QuantLib::Time | 1.0 | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the black spot volatility at a given option date and strike.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackVolTermStructure | ||
| OptionDate: | QuantLib::Date | 1Y | N/S |
| Strike: | QuantLib::Real | 5% | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the black spot variance at a given option date and strike.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackVolTermStructure | ||
| OptionDate: | QuantLib::Date | 1Y | N/S |
| Strike: | QuantLib::Real | 5% | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Real
Returns the black forward (at-the-money) volatility at a given option date and strike.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackVolTermStructure | ||
| ForwardDate: | QuantLib::Date | 6M | N/S |
| OptionDate: | QuantLib::Date | 1Y | N/S |
| Strike: | QuantLib::Real | 5% | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Volatility
Returns the black forward (at-the-money) variance at a given option date and strike.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::BlackVolTermStructure | ||
| ForwardDate: | QuantLib::Date | 6M | N/S |
| OptionDate: | QuantLib::Date | 1Y | N/S |
| Strike: | QuantLib::Real | 5% | N/S |
| AllowExtrapolation: | bool | N/S | False |
Return value: QuantLib::Real
Returns the options tenors of the atm volatility curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Period
Returns the options tenors used in the fitting of the atm volatility curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Period
Returns the options dates of the atm volatility curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Date
Returns the options times to maturity of the atm volatility curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Time
Returns the root mean squared error between the abcd implied Black vols and the given Black vols vector.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the max error between the abcd implied Black vols and the given Black vols vector.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the a coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the b coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the c coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the d coefficient in the abcd vol parametrization.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the k adjustments factors needed to match the input Black vols.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve |
Return value: QuantLib::Real
Returns the k adjustments factors needed to match the input Black vols at a given time.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::AbcdAtmVolCurve | ||
| Time: | QuantLib::Time | 1M | N/S |
Return value: QuantLib::Real
Returns the volatilities spread at a given date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrVolSurface | ||
| OptionDate: | QuantLib::Date | 1Y | N/S |
Return value: QuantLib::Volatility
Returns the volatilities spread at a given date.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::SabrVolSurface | ||
| OptionTenor: | QuantLib::Period | 1Y | N/S |
Return value: QuantLib::Volatility
Returns the Atm volatility curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLibAddin::SabrVolSurface |
Return value: string
Returns the piecewise constant variances.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance |
Return value: double
Returns the piecewise constant volatilities.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance |
Return value: double
Returns the rate time of the PiecewiseConstantVariance object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance |
Return value: double
Returns the piecewise constant variance at a given time index.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance | ||
| TimeIndex: | QuantLib::Size | 0 | N/S |
Return value: double
Returns the piecewise constant volatility at a given time index.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance | ||
| TimeIndex: | QuantLib::Size | 0 | N/S |
Return value: double
Returns the total variance at a given time index of the PiecewiseConstantVariance object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance | ||
| TimeIndex: | QuantLib::Size | 0 | N/S |
Return value: double
Returns the total variance at a given time index of the PiecewiseConstantVariance object.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Input object | QuantLib::PiecewiseConstantVariance | ||
| TimeIndex: | QuantLib::Size | 0 | N/S |
Return value: double
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| A: | double | N/S | N/S |
| B: | double | N/S | N/S |
| C: | double | N/S | N/S |
| D: | double | N/S | N/S |
| Output object | AbcdFunction |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Times: | QuantLib::Time | 0.01, 0.02, 0.03, 0.04 | N/S |
| BlackVols: | QuantLib::Volatility | N/S | N/S |
| A: | double | N/S | N/S |
| B: | double | N/S | N/S |
| C: | double | N/S | N/S |
| D: | double | N/S | N/S |
| AIsFixed: | bool | N/S | N/S |
| BIsFixed: | bool | N/S | N/S |
| CIsFixed: | bool | N/S | N/S |
| DIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Method: | QuantLib::OptimizationMethod | N/S | N/S |
| Output object | AbcdCalibration |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| MarketModelEvolver: | QuantLib::MarketModelEvolver | N/S | N/S |
| InitialNumeraireValue: | double | N/S | N/S |
| Product: | QuantLib::MarketModelMultiProduct | N/S | N/S |
| Output object | AccountingEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Alpha: | QuantLib::Real | 5 | N/S |
| Output object | AlphaFormInverseLinear |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Alpha: | QuantLib::Real | 5 | N/S |
| Output object | AlphaFormLinearHyperbolic |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayBondCoupon: | bool | N/S | N/S |
| Bond: | QuantLib::Bond | DE0003088704 | N/S |
| CleanPrice: | double | 99.16 | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| FloatingLegDayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| ParAssetSwap: | bool | N/S | N/S |
| FloatingLegSchedule: | QuantLib::Schedule | N/S | N/S |
| Output object | AssetSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ParAssetSwap: | bool | N/S | N/S |
| Bond: | QuantLib::Bond | DE0003088704 | N/S |
| CleanPrice: | double | 99.16 | N/S |
| NonParRepayment: | double | 101.0 | N/S |
| Gearing: | double | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| FloatingLegDayCounter: | QuantLib::DayCounter | N/S | N/S |
| DealMaturity: | QuantLib::Date | N/S | N/S |
| PayBondCoupon: | bool | N/S | N/S |
| Output object | AssetSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Correlation: | QuantLib::Real | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Output object | GaussianLHPLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Correlation: | QuantLib::Real | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| NumBuckets: | QuantLib::Size | N/S | N/S |
| Output object | IHGaussPoolLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Correlation: | QuantLib::Real | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Ttraits: | double | N/S | N/S |
| NumBuckets: | QuantLib::Size | N/S | N/S |
| Output object | IHStudentPoolLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Output object | GaussianBinomialLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Ttraits: | double | N/S | N/S |
| Output object | TBinomialLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BaseModel: | string | GLHP, GBINOMKR, TBINOMKR, INHOM | N/S |
| Recoveries: | QuantLib::Real | N/S | N/S |
| InitiTraits: | QuantLib::Real | N/S | N/S |
| Output object | BaseCorrelationLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| NumSimulations: | QuantLib::Size | N/S | N/S |
| Output object | GaussianRandomDefaultLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| ModelA: | QuantLib::Real | N/S | N/S |
| NumSimulations: | QuantLib::Size | N/S | N/S |
| Output object | GaussianRandomLossLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Ttraits: | double | N/S | N/S |
| NumSimulations: | QuantLib::Size | N/S | N/S |
| Output object | TRandomDefaultLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Ttraits: | double | N/S | N/S |
| ModelA: | QuantLib::Real | N/S | N/S |
| NumSimulations: | QuantLib::Size | N/S | N/S |
| Output object | TRandomLossLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Output object | SaddlePointLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Ttraits: | double | N/S | N/S |
| Output object | TSaddlePointLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| RecoveryRates: | double | N/S | N/S |
| Output object | RecursiveGaussLossModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | 3 | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| Coupons: | QuantLib::Rate | 0.04 | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| PaymentCalendar: | QuantLib::Calendar | TARGET | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FixedRateBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | 3 | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| Coupons: | QuantLib::InterestRate | N/S | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| PaymentCalendar: | QuantLib::Calendar | TARGET | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FixedRateBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | 3 | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Floors: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| Caps: | QuantLib::Rate | N/S | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FloatingRateBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | 3 | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Floors: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| Caps: | QuantLib::Rate | N/S | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | CmsRateBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | 3 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| Maturity: | QuantLib::Date | 45348 | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| Output object | ZeroCouponBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| SettlementDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| FaceAmount: | QuantLib::Real | N/S | N/S |
| MaturityDate: | QuantLib::Date | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| LegID: | QuantLib::Leg | N/S | N/S |
| Output object | Bond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Seed: | long | N/S | N/S |
| Output object | MTBrownianGeneratorFactory |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| MaturityDate: | QuantLib::Date | 45678 | N/S |
| Spread: | QuantLib::Spread | 0.80% | N/S |
| StartDate: | QuantLib::Date | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| FwdCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | CCTEU |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| MaturityDate: | QuantLib::Date | 45678 | N/S |
| Coupon: | QuantLib::Rate | 0.04 | N/S |
| StartDate: | QuantLib::Date | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| Output object | BTP |
Construct an object of class BTP and return its id, allowing for non-100 redemption.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Description: | string | N/S | N/S |
| MaturityDate: | QuantLib::Date | 45678 | N/S |
| Coupon: | QuantLib::Rate | 0.04 | N/S |
| Redemption: | QuantLib::Real | N/S | N/S |
| StartDate: | QuantLib::Date | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| Output object | BTP |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BTPs: | QuantLib::BTP | N/S | N/S |
| Outstandings: | QuantLib::Real | N/S | N/S |
| Prices: | QuantLib::Quote | N/S | N/S |
| Output object | RendistatoBasket |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RendistatoBasket: | QuantLib::RendistatoBasket | N/S | N/S |
| Euribor: | QuantLib::Euribor | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | RendistatoCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RendistatoCalculator: | QuantLib::RendistatoCalculator | N/S | N/S |
| Output object | RendistatoEquivalentSwapLengthQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RendistatoCalculator: | QuantLib::RendistatoCalculator | N/S | N/S |
| Output object | RendistatoEquivalentSwapSpreadQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionTenor: | QuantLib::Period | 5Y | N/S |
| Length: | QuantLib::Period | 5Y | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| FixedLegTenor: | QuantLib::Period | N/S | N/S |
| FixedLegDayCounter: | QuantLib::DayCounter | N/S | N/S |
| FloatingLegDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Volatility: | QuantLib::Quote | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | SwaptionHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionType: | QuantLib::CapFloor::Type | N/S | N/S |
| Strikes: | QuantLib::Rate | .04 | N/S |
| LegID: | QuantLib::Leg | N/S | N/S |
| Output object | CapFloor |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionType: | QuantLib::CapFloor::Type | Cap | N/S |
| Length: | QuantLib::Period | 10Y | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| Strike: | QuantLib::Rate | N/S | N/S |
| ForwardStart: | QuantLib::Period | N/S | N/S |
| PricingEngineID: | QuantLib::PricingEngine | CapFloorEngineID | N/S |
| Output object | CapFloor |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurrentLink: | string | N/S | N/S |
| Output object | RelinkableHandleImpl<QuantLibAddin::OptionletVolatilityStructure, QuantLib::OptionletVolatilityStructure> |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | "Following" | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| Volatility: | QuantLib::Quote | N/S | N/S |
| Output object | ConstantOptionletVolatility |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BaseVolStructure: | QuantLib::OptionletVolatilityStructure | N/S | N/S |
| Spread: | QuantLib::Quote | 0.01 | N/S |
| Output object | SpreadedOptionletVolatility |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| StrippedOptionletBase: | QuantLib::StrippedOptionletBase | N/S | N/S |
| Output object | StrippedOptionletAdapter |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | "Following" | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| OptionletDates: | QuantLib::Date | 5Y, 10Y | N/S |
| Strikes: | QuantLib::Rate | 0.03, 0.04, 0.05 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| Volatilities: | QuantLib::Quote | N/S | N/S |
| Output object | StrippedOptionlet |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| SwitchStrike: | QuantLib::Rate | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| MaxIter: | QuantLib::Natural | N/S | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| TermVolSurface: | QuantLib::CapFloorTermVolSurface | N/S | N/S |
| Output object | OptionletStripper1 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionletStripper1: | QuantLib::OptionletStripper1 | N/S | N/S |
| TermVolCurve: | QuantLib::CapFloorTermVolCurve | N/S | N/S |
| Output object | OptionletStripper2 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDays: | QuantLib::Size | 0 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | "Following" | N/S |
| OptionTenors: | QuantLib::Period | 3Y, 5Y, 7Y, 10Y | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Volatilities: | QuantLib::Quote | 0.30, 0.27, 0.25, 0.21 | N/S |
| Output object | CapFloorTermVolCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDays: | QuantLib::Size | 0 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | "Following" | N/S |
| OptionTenors: | QuantLib::Period | 5Y, 10Y | N/S |
| Strikes: | QuantLib::Rate | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Volatilities: | QuantLib::Quote | N/S | N/S |
| Output object | CapFloorTermVolSurface |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapLengths: | QuantLib::Period | 2Y,5Y,10Y,20Y,30Y | N/S |
| SwapIndexes: | QuantLib::SwapIndex | EuriborSwapIsdaFixA2Y,EuriborSwapIsdaFixA5Y,EuriborSwapIsdaFixA10Y,EuriborSwapIsdaFixA20Y,EuriborSwapIsdaFixA30Y | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor3M | N/S |
| CmsCouponPricers: | QuantLib::CmsCouponPricer | N/S | N/S |
| BidAskSpreads: | QuantLib::Quote | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | CmsMarket |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CmsMarket: | QuantLib::CmsMarket | N/S | N/S |
| Weights: | QuantLib::Matrix | N/S | N/S |
| CalibrationType: | QuantLib::CmsMarketCalibration::CalibrationType | N/S | N/S |
| VolCube: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| Output object | CmsMarketCalibration |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Size: | long | 4 | N/S |
| Rho: | double | 0.5 | N/S |
| Beta: | double | .6 | N/S |
| Factors: | long | N/S | N/S |
| Output object | LmLinearExponentialCorrelationModel |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| StartDate: | QuantLib::Date | 37413 | N/S |
| EndDate: | QuantLib::Date | 39248 | N/S |
| Step: | QuantLib::Period | 1D | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| InitialGap: | QuantLib::Period | 3M | N/S |
| Horizon: | QuantLib::Period | 30Y | N/S |
| IborIndexes: | QuantLib::IborIndex | N/S | N/S |
| SwapIndexes: | QuantLib::SwapIndex | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| TraitsID: | string | N/S | N/S |
| InterpolatorID: | string | N/S | N/S |
| BootstrapAccuracy: | QuantLib::Real | N/S | N/S |
| SequenceStats: | QuantLib::SequenceStatistics | N/S | N/S |
| Output object | HistoricalForwardRatesAnalysis |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| StartDate: | QuantLib::Date | 37413 | N/S |
| EndDate: | QuantLib::Date | 39248 | N/S |
| Step: | QuantLib::Period | 1D | N/S |
| InterestRateIndexes: | QuantLib::InterestRateIndex | N/S | N/S |
| SequenceStats: | QuantLib::SequenceStatistics | N/S | N/S |
| Output object | HistoricalRatesAnalysis |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FwdCorrMatrix: | QuantLib::Matrix | N/S | N/S |
| RateTimes: | QuantLib::Time | N/S | N/S |
| Output object | TimeHomogeneousForwardCorrelation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | N/S | N/S |
| LongTermCorr: | QuantLib::Real | 0.5 | N/S |
| Beta: | QuantLib::Real | 0.2 | N/S |
| Gamma: | QuantLib::Real | 0.9 | N/S |
| Times: | QuantLib::Time | N/S | N/S |
| Output object | ExponentialForwardCorrelation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Displacement: | QuantLib::Spread | N/S | N/S |
| FwdCorr: | QuantLib::PiecewiseConstantCorrelation | PiecewiseConstantCorrelationID | N/S |
| CurveState: | QuantLib::CurveState | CurveStateID | N/S |
| Output object | CotSwapFromFwdCorrelation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| Coupons: | QuantLib::Rate | 0.04 | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FixedRateLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| Coupons: | QuantLib::InterestRate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FixedRateLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Floors: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| Caps: | QuantLib::Rate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | IborLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Gearings: | double | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| CallStrikes: | QuantLib::Rate | N/S | N/S |
| CallSpecs: | string | N/S | N/S |
| CallPayoff: | QuantLib::Rate | N/S | N/S |
| PutStrikes: | QuantLib::Rate | N/S | N/S |
| PutSpecs: | string | N/S | N/S |
| PutPayoff: | QuantLib::Rate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Replication: | QuantLib::DigitalReplication | N/S | N/S |
| Output object | DigitalIborLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Floors: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| Caps: | QuantLib::Rate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | CmsLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Gearings: | double | N/S | N/S |
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| CallStrikes: | QuantLib::Rate | N/S | N/S |
| CallSpecs: | string | N/S | N/S |
| CallPayoff: | QuantLib::Rate | N/S | N/S |
| PutStrikes: | QuantLib::Rate | N/S | N/S |
| PutSpecs: | string | N/S | N/S |
| PutPayoff: | QuantLib::Rate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Replication: | QuantLib::DigitalReplication | N/S | N/S |
| Output object | DigitalCmsLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| LowerStrikes: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| UpperStrikes: | QuantLib::Rate | N/S | N/S |
| ObservationsTenor: | QuantLib::Period | 1d | N/S |
| ObservationsBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | RangeAccrualLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Nominals: | double | 1000000 | N/S |
| FixingDays: | QuantLib::Natural | N/S | N/S |
| IsInArrears: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| Floors: | QuantLib::Rate | N/S | N/S |
| Gearings: | double | N/S | N/S |
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| Spreads: | QuantLib::Spread | N/S | N/S |
| Caps: | QuantLib::Rate | N/S | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | CmsZeroLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IborCouponPricerType: | string | IborByBlack | N/S |
| Volatility: | QuantLib::OptionletVolatilityStructure | EURCapletVol | N/S |
| Output object | IborCouponPricer |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CmsCouponPricerType: | string | ConundrumByNumericalIntegration | N/S |
| YieldCurveModel: | QuantLib::GFunctionFactory::YieldCurveModel | N/S | N/S |
| Volatility: | QuantLib::SwaptionVolatilityStructure | EURSwaptionVol | N/S |
| MeanReversion: | QuantLib::Quote | 0.1 | N/S |
| Output object | CmsCouponPricer |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurveModel: | QuantLib::GFunctionFactory::YieldCurveModel | N/S | N/S |
| LowerLimit: | QuantLib::Real | N/S | N/S |
| UpperLimit: | QuantLib::Real | N/S | N/S |
| Precision: | QuantLib::Real | N/S | N/S |
| SwaptionVol: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| MeanReversion: | QuantLib::Quote | N/S | N/S |
| Output object | NumericHaganPricer |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Replication: | QuantLib::Replication::Type | N/S | N/S |
| Gap: | QuantLib::Real | N/S | N/S |
| Output object | DigitalReplication |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BuyerSeller: | QuantLib::Protection::Side | N/S | N/S |
| Notional: | QuantLib::Real | N/S | N/S |
| Upfront: | QuantLib::Rate | N/S | N/S |
| Spread: | QuantLib::Rate | N/S | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| SettlesAccrual: | bool | N/S | False |
| PayAtDefault: | bool | N/S | False |
| ProtectionStart: | QuantLib::Date | N/S | N/S |
| UpfrontDate: | QuantLib::Date | N/S | N/S |
| PremiumSchedule: | QuantLib::Schedule | N/S | N/S |
| Output object | CreditDefaultSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RecoveryRate: | QuantLib::Real | N/S | N/S |
| DefaultCurve: | QuantLib::DefaultProbabilityTermStructure | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | MidPointCdsEngine |
Creates a backward flat interpolated hazard rate curve.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurveDates: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| CurveRates: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | HazardRateCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | QuantLib::Period | 10Y | N/S |
| SettlementDays: | QuantLib::Natural | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Frequency: | QuantLib::Frequency | Annual | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | ModifiedFollowing | N/S |
| GenRule: | QuantLib::DateGeneration::Rule | Backward | N/S |
| DayCounter: | QuantLib::DayCounter | 30/360 (Bond Basis) | N/S |
| RecoveryRate: | QuantLib::Real | N/S | N/S |
| SettleAccrual: | bool | N/S | False |
| PayAtDefault: | bool | N/S | False |
| RunningSpread: | QuantLib::Quote | 0.042322 | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | SpreadCdsHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RunningSpread: | QuantLib::Rate | 0.042322 | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| SettlementDays: | QuantLib::Natural | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Frequency: | QuantLib::Frequency | Annual | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | ModifiedFollowing | N/S |
| GenRule: | QuantLib::DateGeneration::Rule | Backward | N/S |
| DayCounter: | QuantLib::DayCounter | 30/360 (Bond Basis) | N/S |
| RecRate: | QuantLib::Real | N/S | N/S |
| UpfSettlDays: | QuantLib::Natural | N/S | N/S |
| SettlAccr: | bool | N/S | False |
| PayAtDefault: | bool | N/S | False |
| UpfrontSpread: | QuantLib::Quote | 0.042322 | N/S |
| DiscCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | UpfrontCdsHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Helpers: | QuantLib::DefaultProbabilityHelper | CDS1Y, CDS5Y, CDS10Y | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Interpolation: | string | LINEAR, BACKWARDFLAT | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| Output object | PiecewiseHazardRateCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ReferenceDate: | QuantLib::Date | N/S | N/S |
| RateHelpers: | QuantLib::RateHelper | EUROND,EURTND,EURSND,EURSWD,EUR2WD | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| Output object | PiecewiseFlatForwardCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Bondname: | string | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| Recovery: | double | N/S | N/S |
| Rate: | QuantLib::Rate | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | N/S | N/S |
| Notional: | double | N/S | N/S |
| PricingDate: | QuantLib::Date | N/S | N/S |
| DefaultCurve: | QuantLib::DefaultProbabilityTermStructure | N/S | N/S |
| Schedule: | QuantLib::Schedule | N/S | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | RiskyFixedBond |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| DefaultEvents: | QuantLib::DefaultEventSet | N/S | N/S |
| Output object | Issuer |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EventType: | string | FailureToPayEvent, BankruptcyEvent | N/S |
| EventDate: | QuantLib::Date | N/S | N/S |
| Currency: | QuantLib::Currency | N/S | N/S |
| Seniority: | QuantLib::Seniority | SeniorSec | N/S |
| SettlementDate: | QuantLib::Date | N/S | N/S |
| SettledRecovery: | double | N/S | N/S |
| Output object | DefaultEventSet |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Basket: | QuantLib::Basket | N/S | N/S |
| BuyerSeller: | QuantLib::Protection::Side | N/S | N/S |
| Upfront: | QuantLib::Rate | N/S | N/S |
| Spread: | QuantLib::Rate | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | N/S | N/S |
| PremiumSchedule: | QuantLib::Schedule | N/S | N/S |
| Output object | SyntheticCDO |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | MidPointCDOEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Basket: | QuantLib::Basket | N/S | N/S |
| Order: | QuantLib::Size | N/S | N/S |
| BuyerSeller: | QuantLib::Protection::Side | N/S | N/S |
| Upfront: | QuantLib::Rate | N/S | N/S |
| Spread: | QuantLib::Rate | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| Notional: | QuantLib::Real | N/S | N/S |
| SettlesAccrual: | bool | N/S | N/S |
| PremiumSchedule: | QuantLib::Schedule | N/S | N/S |
| Output object | NthToDefault |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IntegrationStep: | QuantLib::Period | 3M | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | IntegralNtdEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RecoveryRate: | QuantLib::Real | N/S | N/S |
| DefaultCurve: | QuantLib::DefaultProbabilityTermStructure | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| BlackVol: | QuantLib::Quote | N/S | N/S |
| Output object | BlackCdsOptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| UnderlyingCDS: | QuantLib::CreditDefaultSwap | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | CdsOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| InterpolatorType: | string | BILIN, BICUBIC | N/S |
| SettlementDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| Convention: | QuantLib::BusinessDayConvention | ModifiedFollowing | N/S |
| Tenors: | QuantLib::Period | N/S | N/S |
| LossLevel: | QuantLib::Real | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Correlations: | QuantLib::Quote | N/S | N/S |
| Output object | BaseCorrelationTermStructure |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapPiecewiseConstantVariances: | QuantLib::PiecewiseConstantVariance | N/S | N/S |
| CapletVols: | QuantLib::Volatility | 0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1 | N/S |
| Displacement: | QuantLib::Volatility | N/S | N/S |
| Alphas: | QuantLib::Real | 0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01 | N/S |
| LowestRoot: | bool | N/S | N/S |
| UseFullApprox: | bool | TRUE | N/S |
| Evolution: | QuantLib::EvolutionDescription | EvolutionDescriptionID | N/S |
| Correlations: | QuantLib::PiecewiseConstantCorrelation | N/S | N/S |
| CurveState: | QuantLib::CurveState | CurveStateID | N/S |
| Output object | CTSMMCapletOriginalCalibration |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapPiecewiseConstantVariances: | QuantLib::PiecewiseConstantVariance | N/S | N/S |
| CapletVols: | QuantLib::Volatility | 0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1 | N/S |
| Displacement: | QuantLib::Volatility | N/S | N/S |
| AlphaInitial: | QuantLib::Real | 0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01 | N/S |
| AlphaMax: | QuantLib::Real | N/S | N/S |
| AlphaMin: | QuantLib::Real | N/S | N/S |
| MaximizeHomogeneity: | bool | N/S | N/S |
| AlphaForm: | QuantLib::AlphaForm | AlphaFormID | N/S |
| Evolution: | QuantLib::EvolutionDescription | EvolutionDescriptionID | N/S |
| Correlations: | QuantLib::PiecewiseConstantCorrelation | N/S | N/S |
| CurveState: | QuantLib::CurveState | CurveStateID | N/S |
| Output object | CTSMMCapletAlphaFormCalibration |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapPiecewiseConstantVariances: | QuantLib::PiecewiseConstantVariance | N/S | N/S |
| CapletVols: | QuantLib::Volatility | 0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1 | N/S |
| Displacement: | QuantLib::Volatility | N/S | N/S |
| Caplet0Swaption1Priority: | QuantLib::Real | N/S | N/S |
| Evolution: | QuantLib::EvolutionDescription | EvolutionDescriptionID | N/S |
| Correlations: | QuantLib::PiecewiseConstantCorrelation | N/S | N/S |
| CurveState: | QuantLib::CurveState | CurveStateID | N/S |
| Output object | CTSMMCapletMaxHomogeneityCalibration |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| SpanningForwards: | QuantLib::Size | 5 | N/S |
| Output object | CMSwapCurveState |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Output object | CoterminalSwapCurveState |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Output object | LMMCurveState |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IssuerNames: | string | N/S | N/S |
| Issuers: | QuantLib::Issuer | N/S | N/S |
| Notionals: | double | N/S | N/S |
| ReferenceDate: | QuantLib::Date | N/S | N/S |
| AttachmentRatio: | double | N/S | N/S |
| DettachmentRatio: | double | N/S | N/S |
| Amortizing: | bool | N/S | N/S |
| Output object | Basket |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurrentLink: | string | N/S | N/S |
| Output object | RelinkableHandleImpl<QuantLibAddin::DefaultProbabilityTermStructure, QuantLib::DefaultProbabilityTermStructure> |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Rate: | QuantLib::Quote | 0.044 | N/S |
| Output object | FlatHazardRate |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Pseudo_square_root: | QuantLib::Matrix | N/S | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| Taus: | QuantLib::Time | 0.5,0.5,0.5,0.5,0.5 | N/S |
| Numeraire: | QuantLib::Size | 5 | N/S |
| Alive: | QuantLib::Size | 1 | N/S |
| Output object | LMMDriftCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Pseudo_square_root: | QuantLib::Matrix | N/S | N/S |
| Taus: | QuantLib::Time | 0.5,0.5,0.5,0.5,0.5 | N/S |
| Numeraire: | QuantLib::Size | 5 | N/S |
| Alive: | QuantLib::Size | 1 | N/S |
| Output object | LMMNormalDriftCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Pseudo_square_root: | QuantLib::Matrix | N/S | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| Taus: | QuantLib::Time | 0.5,0.5,0.5,0.5,0.5 | N/S |
| Numeraire: | QuantLib::Size | 5 | N/S |
| Alive: | QuantLib::Size | 1 | N/S |
| SpanningFwds: | QuantLib::Size | 5 | N/S |
| Output object | CMSMMDriftCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Pseudo_square_root: | QuantLib::Matrix | N/S | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| Taus: | QuantLib::Time | 0.5,0.5,0.5,0.5,0.5 | N/S |
| Numeraire: | QuantLib::Size | 5 | N/S |
| Alive: | QuantLib::Size | 1 | N/S |
| Output object | SMMDriftCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| EvolutionTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Output object | EvolutionDescription |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Product: | QuantLib::MarketModelMultiProduct | N/S | N/S |
| Output object | EvolutionDescription |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EarliestDate: | QuantLib::Date | 1Y | N/S |
| LatestDate: | QuantLib::Date | 2Y | N/S |
| PayoffAtExpiry: | bool | N/S | N/S |
| Output object | AmericanExercise |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ExpiryDate: | QuantLib::Date | 1Y | N/S |
| Output object | EuropeanExercise |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dates: | QuantLib::Date | '1Y,2Y | N/S |
| PayoffAtExpiry: | bool | N/S | N/S |
| Output object | BermudanExercise |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ValueDate: | QuantLib::Date | 3M | N/S |
| MaturityDate: | QuantLib::Date | 6M | N/S |
| Position: | QuantLib::Position::Type | Long | N/S |
| Strike: | QuantLib::Rate | 0.02 | N/S |
| Notional: | double | 1000000 | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | ForwardRateAgreement |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FamilyName: | string | Euribor | N/S |
| Tenor: | QuantLib::Period | 6M | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Currency: | QuantLib::Currency | EUR | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BDayConvention: | QuantLib::BusinessDayConvention | Modified Following | N/S |
| EndOfMonth: | bool | TRUE | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| FwdCurve: | QuantLib::YieldTermStructure | EURYC6M | N/S |
| Output object | IborIndex |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FamilyName: | string | Eonia | N/S |
| FixingDays: | QuantLib::Natural | 0 | N/S |
| Currency: | QuantLib::Currency | EUR | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | OvernightIndex |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | string | 6M | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | Euribor |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | string | 6M | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | Euribor365 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | Eonia |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Currency: | QuantLib::Currency | N/S | N/S |
| Tenor: | string | 6M | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | Libor |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | Sonia |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FamilyName: | string | EuriborSwapIsdaFixA10Y | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Currency: | QuantLib::Currency | EUR | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| FixedLegTenor: | QuantLib::Period | 1Y | N/S |
| FixedLegBDC: | QuantLib::BusinessDayConvention | Unadjusted | N/S |
| FixedLegDayCounter: | QuantLib::DayCounter | 30/360 (Bond Basis) | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| DiscCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | SwapIndex |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FixingType: | QuantLibAddin::SwapIndex::FixingType | N/S | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| FwdCurve: | QuantLib::YieldTermStructure | EURYC6M | N/S |
| DiscCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | EuriborSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Currency: | QuantLib::Currency | N/S | N/S |
| FixingType: | QuantLibAddin::SwapIndex::FixingType | N/S | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| FwdCurve: | QuantLib::YieldTermStructure | EURYC6M | N/S |
| DiscCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | LiborSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | QuantLib::Period | 10Y | N/S |
| FwdCurve: | QuantLib::YieldTermStructure | EURYC6M | N/S |
| DiscCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | EuriborSwapIsdaFixA |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | USDYC | N/S |
| Output object | BMAIndex |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FamilyName: | string | Euribor | N/S |
| Tenor: | QuantLib::Period | 6M | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Currency: | QuantLib::Currency | EUR | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BDayConvention: | QuantLib::BusinessDayConvention | Modified Following | N/S |
| EndOfMonth: | bool | TRUE | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Gearing: | QuantLib::Quote | 1.0 | N/S |
| Spread: | QuantLib::Quote | 0.005 | N/S |
| Output object | ProxyIbor |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| InterpolationType: | string | N/S | N/S |
| XArray: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | N/S |
| YArray: | QuantLib::Quote | 2.0,4.0,6.0,8.0,10.0,12.0 | N/S |
| Output object | GenericInterp |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| XArray: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0 | N/S |
| SwitchIndex: | QuantLib::Size | N/S | N/S |
| DerApprox: | QuantLib::CubicInterpolation::DerivativeApprox | N/S | N/S |
| Monotonic: | bool | N/S | N/S |
| LeftConditionType: | QuantLib::CubicInterpolation::BoundaryCondition | N/S | N/S |
| LeftConditionValue: | QuantLib::Real | N/S | N/S |
| RightConditionType: | QuantLib::CubicInterpolation::BoundaryCondition | N/S | N/S |
| RightConditionValue: | QuantLib::Real | N/S | N/S |
| YArray: | QuantLib::Quote | 1.0,8.0,27.0,64.0,125.0 | N/S |
| Output object | MixedLinearCubicInterpolation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| XArray: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0 | N/S |
| DerApprox: | QuantLib::CubicInterpolation::DerivativeApprox | N/S | N/S |
| Monotonic: | bool | N/S | N/S |
| LeftConditionType: | QuantLib::CubicInterpolation::BoundaryCondition | N/S | N/S |
| LeftConditionValue: | QuantLib::Real | N/S | N/S |
| RightConditionType: | QuantLib::CubicInterpolation::BoundaryCondition | N/S | N/S |
| RightConditionValue: | QuantLib::Real | N/S | N/S |
| YArray: | QuantLib::Quote | 1.0,8.0,27.0,64.0,125.0 | N/S |
| Output object | CubicInterpolation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| XArray: | QuantLib::Real | 0.0300,0.0400,0.0500,0.0700 | N/S |
| A: | QuantLib::Real | N/S | N/S |
| B: | QuantLib::Real | N/S | N/S |
| C: | QuantLib::Real | N/S | N/S |
| D: | QuantLib::Real | N/S | N/S |
| AIsFixed: | bool | N/S | N/S |
| BIsFixed: | bool | N/S | N/S |
| CIsFixed: | bool | N/S | N/S |
| DIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| OptimizationMeth: | QuantLib::OptimizationMethod | N/S | N/S |
| YArray: | QuantLib::Quote | 0.0850,0.0733,0.0844,0.1082 | N/S |
| Output object | AbcdInterpolation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| XArray: | QuantLib::Real | 0.0300,0.0400,0.0500,0.0700 | N/S |
| Expiry: | QuantLib::Time | 1.0 | N/S |
| Alpha: | QuantLib::Real | N/S | N/S |
| Beta: | QuantLib::Real | N/S | N/S |
| Nu: | QuantLib::Real | N/S | N/S |
| Rho: | QuantLib::Real | N/S | N/S |
| AlphaIsFixed: | bool | N/S | N/S |
| BetaIsFixed: | bool | N/S | N/S |
| NuIsFixed: | bool | N/S | N/S |
| RhoIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| OptimizationMeth: | QuantLib::OptimizationMethod | N/S | N/S |
| YArray: | QuantLib::Quote | 0.0850,0.0733,0.0844,0.1082 | N/S |
| Forward: | QuantLib::Quote | 0.039 | N/S |
| Output object | SABRInterpolation |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| InterpolationType: | string | N/S | N/S |
| XArray: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | N/S |
| YArray: | QuantLib::Real | 1.0,2.0,3.0,4.0,5.0,6.0 | N/S |
| ZMatrix: | QuantLib::Matrix | N/S | N/S |
| Output object | Interpolation2D |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Factors: | double | N/S | N/S |
| Basket: | QuantLib::Basket | N/S | N/S |
| Output object | GaussianDefProbLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Torders: | QuantLib::Integer | N/S | N/S |
| Factors: | double | N/S | N/S |
| Basket: | QuantLib::Basket | N/S | N/S |
| Output object | TDefProbLM |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Amounts: | double | 1000000.0,500000.0 | N/S |
| Dates: | QuantLib::Date | 40238,40330 | N/S |
| ToBeSorted: | bool | N/S | N/S |
| Output object | Leg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CapFloor: | QuantLib::CapFloor | N/S | N/S |
| Output object | Leg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Swap: | QuantLib::Swap | N/S | N/S |
| LegNumber: | long | 1 | N/S |
| Output object | Leg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| LegIDs: | QuantLibAddin::Leg | N/S | N/S |
| ToBeSorted: | bool | N/S | N/S |
| Output object | MultiPhaseLeg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Rate: | QuantLib::Rate | 0.04 | N/S |
| DayCounter: | QuantLib::DayCounter | "Actual/365 (Fixed)" | N/S |
| Compounding: | QuantLib::Compounding | "Simple" | False |
| Frequency: | QuantLib::Frequency | N/S | False |
| Output object | InterestRate |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BrownianGeneratorFactory: | QuantLib::BrownianGeneratorFactory | N/S | N/S |
| Numeraires: | QuantLib::Size | 5,5,5,5,5 | N/S |
| MarketModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | LogNormalFwdRatePc |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BrownianGeneratorFactory: | QuantLib::BrownianGeneratorFactory | N/S | N/S |
| Numeraires: | QuantLib::Size | 5,5,5,5,5 | N/S |
| MarketModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | LogNormalFwdRateIpc |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BrownianGeneratorFactory: | QuantLib::BrownianGeneratorFactory | N/S | N/S |
| Numeraires: | QuantLib::Size | 5,5,5,5,5 | N/S |
| MarketModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | NormalFwdRatePc |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Volatilities: | QuantLib::Volatility | 0.2,0.2,0.2,0.2,0.2 | N/S |
| Factors: | long | 5 | N/S |
| InitialRates: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| Correlations: | QuantLib::PiecewiseConstantCorrelation | N/S | N/S |
| EvolutionDescription: | QuantLib::EvolutionDescription | N/S | N/S |
| Output object | FlatVol |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| A: | double | -0.06 | N/S |
| B: | double | 0.17 | N/S |
| C: | double | 0.54 | N/S |
| D: | double | 0.17 | N/S |
| Ks: | double | 1.0,1.0,1.0,1.0,1.0 | N/S |
| Factors: | long | 5 | N/S |
| InitialRates: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| Correlations: | QuantLib::PiecewiseConstantCorrelation | N/S | N/S |
| EvolutionDescription: | QuantLib::EvolutionDescription | N/S | N/S |
| Output object | AbcdVol |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Calibrator: | QuantLib::CTSMMCapletCalibration | N/S | N/S |
| Output object | PseudoRootFacade |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CoterminalModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | CotSwapToFwdAdapter |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Period: | QuantLib::Size | 2 | N/S |
| Offset: | QuantLib::Size | 0 | N/S |
| Displacements: | QuantLib::Spread | 0.0,0.0,0.0,0.0,0.0 | N/S |
| LargeModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | FwdPeriodAdapter |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ForwardModel: | QuantLib::MarketModel | N/S | N/S |
| Output object | FwdToCotSwapAdapter |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| LongTermCorr: | double | 0.5 | N/S |
| Beta: | double | 0.2 | N/S |
| Times: | QuantLib::Time | 0.1,0.2,0.3,0.4,0.5 | N/S |
| Volatilities: | QuantLib::Volatility | 0.2,0.2,0.2,0.2,0.2 | N/S |
| Displacement: | QuantLib::Spread | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | FlatVolFactory |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SymmetricMatrix: | QuantLib::Matrix | N/S | N/S |
| Output object | SymmetricSchurDecomposition |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SymmetricMatrix: | QuantLib::Matrix | N/S | N/S |
| Tolerance: | double | N/S | N/S |
| Output object | CovarianceDecomposition |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| MaxIterations: | long | 1000 | N/S |
| MaxStationaryStateIterations: | long | 100 | N/S |
| RootEpsilon: | double | 1e-8 | N/S |
| FunctionEpsilon: | double | 1e-8 | N/S |
| GradientNormEpsilon: | double | 1e-8 | N/S |
| Output object | EndCriteria |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Output object | NoConstraint |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Lambda: | double | 0.01 | N/S |
| Output object | Simplex |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Epsfcn: | double | N/S | N/S |
| Xtol: | double | N/S | N/S |
| Gtol: | double | N/S | N/S |
| Output object | LevenbergMarquardt |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| LineSearch: | QuantLib::LineSearch | N/S | N/S |
| Output object | ConjugateGradient |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| LineSearch: | QuantLib::LineSearch | N/S | N/S |
| Output object | SteepestDescent |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Epsilon: | double | N/S | N/S |
| Alpha: | double | N/S | N/S |
| Beta: | double | N/S | N/S |
| Output object | ArmijoLineSearch |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BarrierType: | QuantLib::Barrier::Type | N/S | N/S |
| Barrier: | QuantLib::Real | 1.0 | N/S |
| Rebate: | QuantLib::Real | 1.0 | N/S |
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | BarrierOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| AverageType: | QuantLib::Average::Type | N/S | N/S |
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | ContinuousAveragingAsianOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| AverageType: | QuantLib::Average::Type | N/S | N/S |
| RunningAccumulator: | QuantLib::Real | 1.0 | N/S |
| PastFixings: | QuantLib::Size | 3 | N/S |
| FixingDates: | QuantLib::Date | 1Y,2Y | N/S |
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | DiscreteAveragingAsianOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| DividendDates: | QuantLib::Date | 1Y,2Y | N/S |
| Dividends: | QuantLib::Real | 0.01,0.01 | N/S |
| Output object | DividendVanillaOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Moneyness: | QuantLib::Real | 1.0 | N/S |
| ResetDate: | QuantLib::Date | 1Y | N/S |
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | ForwardVanillaOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | VanillaOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | EuropeanOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | QuantoVanillaOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Moneyness: | QuantLib::Real | 1.0 | N/S |
| ResetDate: | QuantLib::Date | 1Y | N/S |
| Payoff: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| Output object | QuantoForwardVanillaOption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayerReceiver: | QuantLib::OvernightIndexedSwap::Type | N/S | N/S |
| Nominal: | QuantLib::Real | N/S | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| FixDayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| OvernightIndex: | QuantLib::OvernightIndex | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| Schedule: | QuantLib::Schedule | OisSchedule | N/S |
| Output object | OvernightIndexedSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlDays: | QuantLib::Natural | N/S | N/S |
| SwapTenor: | QuantLib::Period | 5Y | N/S |
| OvernightIndex: | QuantLib::OvernightIndex | Eonia | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| FixDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| Output object | OvernightIndexedSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| StartDate: | QuantLib::Date | N/S | N/S |
| EndDate: | QuantLib::Date | N/S | N/S |
| OvernightIndex: | QuantLib::OvernightIndex | Eonia | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| FixDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| Output object | OvernightIndexedSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OISRateHelper: | QuantLib::OISRateHelper | N/S | N/S |
| Output object | OvernightIndexedSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayoffID: | string | N/S | N/S |
| OptionType: | QuantLib::Option::Type | Call | N/S |
| Strike: | QuantLib::Real | 100.0 | N/S |
| ThirdParameter: | double | N/S | N/S |
| Output object | StrikedTypePayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Type1: | QuantLib::Real | -1.0 | N/S |
| Type2: | QuantLib::Real | -1.0 | N/S |
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Gearing3: | QuantLib::Real | 1.2 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| Spread3: | QuantLib::Real | 0.003 | N/S |
| InitialValue1: | QuantLib::Real | 0.02 | N/S |
| InitialValue2: | QuantLib::Real | 0.03 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | DoubleStickyRatchetPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| InitialValue: | QuantLib::Real | 0.02 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | RatchetPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| InitialValue: | QuantLib::Real | 0.02 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | StickyPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Gearing3: | QuantLib::Real | 1.2 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| Spread3: | QuantLib::Real | 0.003 | N/S |
| InitialValue1: | QuantLib::Real | 0.02 | N/S |
| InitialValue2: | QuantLib::Real | 0.03 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | RatchetMaxPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Gearing3: | QuantLib::Real | 1.2 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| Spread3: | QuantLib::Real | 0.003 | N/S |
| InitialValue1: | QuantLib::Real | 0.02 | N/S |
| InitialValue2: | QuantLib::Real | 0.03 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | RatchetMinPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Gearing3: | QuantLib::Real | 1.2 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| Spread3: | QuantLib::Real | 0.003 | N/S |
| InitialValue1: | QuantLib::Real | 0.02 | N/S |
| InitialValue2: | QuantLib::Real | 0.03 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | StickyMaxPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Gearing1: | QuantLib::Real | 1.0 | N/S |
| Gearing2: | QuantLib::Real | 1.1 | N/S |
| Gearing3: | QuantLib::Real | 1.2 | N/S |
| Spread1: | QuantLib::Real | 0.001 | N/S |
| Spread2: | QuantLib::Real | 0.002 | N/S |
| Spread3: | QuantLib::Real | 0.003 | N/S |
| InitialValue1: | QuantLib::Real | 0.02 | N/S |
| InitialValue2: | QuantLib::Real | 0.03 | N/S |
| AccrualFactor: | QuantLib::Real | 0.5 | N/S |
| Output object | StickyMinPayoff |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Natural | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| RateHelpers: | QuantLib::RateHelper | EUROND,EURTND,EURSND,EURSWD,EUR2WD | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| JumpDates: | QuantLib::Date | 1Y | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| TraitsID: | string | N/S | N/S |
| InterpolatorID: | string | N/S | N/S |
| Jumps: | QuantLib::Quote | 1.0 | N/S |
| Output object | PiecewiseYieldCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Natural | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| RateHelpers: | QuantLib::RateHelper | EUROND,EURTND,EURSND,EURSWD,EUR2WD | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| JumpDates: | QuantLib::Date | 1Y | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| TraitsID: | string | N/S | N/S |
| InterpolatorID: | string | N/S | N/S |
| MixedInterpolationBehavior: | QuantLib::MixedInterpolation::Behavior | N/S | N/S |
| PillarsBeforeChange: | QuantLib::Size | 3 | N/S |
| Jumps: | QuantLib::Quote | 1.0 | N/S |
| Output object | PiecewiseYieldCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayoffID: | QuantLib::StrikedTypePayoff | N/S | N/S |
| AtmForwardValue: | QuantLib::Real | 100.0 | N/S |
| StdDev: | QuantLib::Real | 0.20 | N/S |
| Deflator: | QuantLib::Real | N/S | N/S |
| Output object | BlackCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionType: | QuantLib::Option::Type | N/S | N/S |
| Strike: | QuantLib::Real | 100.0 | N/S |
| AtmForwardValue: | QuantLib::Real | 100.0 | N/S |
| StdDev: | QuantLib::Real | 0.20 | N/S |
| Deflator: | QuantLib::Real | N/S | N/S |
| Output object | BlackCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayoffID: | QuantLib::StrikedTypePayoff | N/S | N/S |
| Spot: | QuantLib::Real | 100.0 | N/S |
| Growth: | QuantLib::DiscountFactor | N/S | N/S |
| StdDev: | QuantLib::Real | 0.20 | N/S |
| Deflator: | QuantLib::Real | N/S | N/S |
| Output object | BlackScholesCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionType: | QuantLib::Option::Type | N/S | N/S |
| Strike: | QuantLib::Real | 100.0 | N/S |
| Spot: | QuantLib::Real | 100.0 | N/S |
| Growth: | QuantLib::DiscountFactor | N/S | N/S |
| StdDev: | QuantLib::Real | 0.20 | N/S |
| Deflator: | QuantLib::Real | N/S | N/S |
| Output object | BlackScholesCalculator |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EngineID: | string | N/S | N/S |
| ProcessID: | QuantLib::GeneralizedBlackScholesProcess | N/S | N/S |
| Output object | PricingEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IncludeSettlDate: | bool | N/S | False |
| SettlementDate: | QuantLib::Date | N/S | False |
| NpvDate: | QuantLib::Date | N/S | False |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | DiscountingSwapEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EngineID: | string | N/S | N/S |
| TimeSteps: | long | N/S | N/S |
| ProcessID: | QuantLib::GeneralizedBlackScholesProcess | N/S | N/S |
| Output object | PricingEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| VolTS: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| Output object | BlackSwaptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Displacement: | QuantLib::Real | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Vol: | QuantLib::Quote | N/S | N/S |
| Output object | BlackSwaptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Displacement: | QuantLib::Real | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| VolTS: | QuantLib::OptionletVolatilityStructure | EUROptionlet6M | N/S |
| Output object | BlackCapFloorEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Displacement: | QuantLib::Real | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Vol: | QuantLib::Quote | N/S | N/S |
| Output object | BlackCapFloorEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| VolTS: | QuantLib::OptionletVolatilityStructure | EUROptionlet6M | N/S |
| Output object | BachelierCapFloorEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Vol: | QuantLib::Quote | N/S | N/S |
| Output object | BachelierCapFloorEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| HandleModel: | QuantLib::AffineModel | N/S | N/S |
| Output object | AnalyticCapFloorEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | BondEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Model: | QuantLib::OneFactorAffineModel | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | JamshidianSwaptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Model: | QuantLib::OneFactorAffineModel | N/S | N/S |
| Nsteps: | QuantLib::Size | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | TreeSwaptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Model: | QuantLib::G2 | N/S | N/S |
| Range: | QuantLib::Real | N/S | N/S |
| Intervals: | QuantLib::Size | N/S | N/S |
| Output object | G2SwaptionEngine |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BlackVolID: | QuantLib::BlackVolTermStructure | N/S | N/S |
| Underlying: | double | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| SettlementDate: | QuantLib::Date | N/S | N/S |
| RiskFreeRate: | double | N/S | N/S |
| DividendYield: | double | N/S | N/S |
| Output object | GeneralizedBlackScholesProcess |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Output object | MultiProductComposite |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Accruals: | double | 1.0,1.0,1.0,1.0,1.0 | N/S |
| PaymentTimes: | QuantLib::Time | 1.0,2.0,3.0,4.0,5.0 | N/S |
| Strikes: | QuantLib::Rate | 0.01,0.01,0.01,0.01,0.01 | N/S |
| Output object | OneStepForwards |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Accruals: | double | 1.0,1.0,1.0,1.0,1.0 | N/S |
| PaymentTimes: | QuantLib::Time | 1.0,2.0,3.0,4.0,5.0 | N/S |
| GearingOfFloor: | QuantLib::Real | 1.0 | N/S |
| GearingOfFixing: | QuantLib::Real | 1.0 | N/S |
| SpreadOfFloor: | QuantLib::Real | 0.0 | N/S |
| SpreadOfFixing: | QuantLib::Real | 0.0 | N/S |
| InitialFloor: | QuantLib::Real | 0.01 | N/S |
| Payer: | bool | true | N/S |
| Output object | MultiStepRatchet |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Accruals: | QuantLib::Time | N/S | N/S |
| PaymentTimes: | QuantLib::Time | N/S | N/S |
| Payoffs: | QuantLib::Payoff | N/S | N/S |
| Output object | OneStepOptionlets |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Value: | QuantLib::Real | N/S | N/S |
| TickValue: | QuantLib::Real | 0.0001 | N/S |
| Output object | SimpleQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| FixingDate: | QuantLib::Date | N/S | N/S |
| Output object | ForwardValueQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| Spread: | QuantLib::Quote | 0.0 | N/S |
| Output object | ForwardSwapQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionType: | QuantLib::Option::Type | N/S | N/S |
| Strike: | QuantLib::Real | N/S | N/S |
| Guess: | QuantLib::Real | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| AtmForwardValue: | QuantLib::Quote | N/S | N/S |
| OptionPrice: | QuantLib::Quote | N/S | N/S |
| Output object | ImpliedStdDevQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Strike: | QuantLib::Real | N/S | N/S |
| Guess: | QuantLib::Real | N/S | N/S |
| Accuracy: | QuantLib::Real | N/S | N/S |
| AtmForwardValue: | QuantLib::Quote | N/S | N/S |
| CallPrice: | QuantLib::Quote | N/S | N/S |
| PutPrice: | QuantLib::Quote | N/S | N/S |
| Output object | EurodollarFuturesImpliedStdDevQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Operator: | string | N/S | N/S |
| Element1: | QuantLib::Quote | N/S | N/S |
| Element2: | QuantLib::Quote | N/S | N/S |
| Output object | CompositeQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| ImmCode: | string | N/S | N/S |
| FuturesQuote: | QuantLib::Quote | N/S | N/S |
| Volatility: | QuantLib::Quote | N/S | N/S |
| MeanReversion: | QuantLib::Quote | N/S | N/S |
| Output object | FuturesConvAdjustmentQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Index: | QuantLib::Index | N/S | N/S |
| Output object | LastFixingQuote |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurrentLink: | string | N/S | N/S |
| Output object | RelinkableHandleImpl<QuantLibAddin::Quote, QuantLib::Quote> |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | long | 3 | N/S |
| Seed: | long | 2 | N/S |
| Output object | MersenneTwisterRsg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | long | 2 | N/S |
| Output object | FaureRsg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | long | 2 | N/S |
| Seed: | long | 2 | N/S |
| Output object | HaltonRsg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | long | 3 | N/S |
| Seed: | long | 2 | N/S |
| Output object | SobolRsg |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Nominal: | double | N/S | N/S |
| PaymentDate: | QuantLib::Date | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| StartDate: | QuantLib::Date | N/S | N/S |
| EndDate: | QuantLib::Date | N/S | N/S |
| FixingDays: | long | N/S | N/S |
| DayCountID: | QuantLib::DayCounter | N/S | N/S |
| Gearings: | double | N/S | N/S |
| Spreads: | double | N/S | N/S |
| RefPeriodStart: | QuantLib::Date | N/S | N/S |
| RefPeriodEnd: | QuantLib::Date | N/S | N/S |
| LowerTrigger: | double | N/S | N/S |
| UpperTrigger: | double | N/S | N/S |
| ObserSchedID: | QuantLib::Schedule | N/S | N/S |
| Output object | RangeAccrualFloatersCoupon |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Position: | QuantLib::Size | N/S | N/S |
| RangeAccrualLeg: | QuantLib::Leg | N/S | N/S |
| Output object | RangeAccrualFloatersCoupon |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Correlation: | double | N/S | N/S |
| WithSmile: | bool | N/S | N/S |
| ByCallSpread: | bool | N/S | N/S |
| SmileOnStartDateID: | QuantLib::SmileSection | N/S | N/S |
| SmileOnEndDateID: | QuantLib::SmileSection | N/S | N/S |
| Output object | RangeAccrualPricerByBgm |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| Rate: | QuantLib::Quote | 0.036565 | N/S |
| Output object | DepositRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | QuantLib::Period | 6M | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Convention: | QuantLib::BusinessDayConvention | Modified Following | N/S |
| EndOfMonth: | bool | true | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| Rate: | QuantLib::Quote | 0.036565 | N/S |
| Output object | DepositRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapIndex: | QuantLib::SwapIndex | EuriborSwapIsdaFixA10Y | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| PillarDate: | QuantLib::Pillar::Choice | N/S | N/S |
| CustomPillarDate: | QuantLib::Date | N/S | N/S |
| Rate: | QuantLib::Quote | 0.042322 | N/S |
| Spread: | QuantLib::Quote | 0.0 | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | SwapRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlDays: | QuantLib::Natural | N/S | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| FixedLegFrequency: | QuantLib::Frequency | Annual | N/S |
| FixedLegConvention: | QuantLib::BusinessDayConvention | ModifiedFollowing | N/S |
| FixedLegDayCounter: | QuantLib::DayCounter | 30/360 (Bond Basis) | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| PillarDate: | QuantLib::Pillar::Choice | N/S | N/S |
| CustomPillarDate: | QuantLib::Date | N/S | N/S |
| Rate: | QuantLib::Quote | 0.042322 | N/S |
| Spread: | QuantLib::Quote | 0.0 | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | SwapRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlDays: | QuantLib::Natural | 2 | N/S |
| Tenor: | QuantLib::Period | 10Y | N/S |
| ONIndex: | QuantLib::OvernightIndex | Eonia | N/S |
| FixedRate: | QuantLib::Quote | 0.00423 | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | OISRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| StartDate: | QuantLib::Date | 39000 | N/S |
| EndDate: | QuantLib::Date | 40000 | N/S |
| ONIndex: | QuantLib::OvernightIndex | Eonia | N/S |
| FixedRate: | QuantLib::Quote | 0.00423 | N/S |
| DiscountingCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | DatedOISRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PeriodToStart: | QuantLib::Period | 3M | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| PillarDate: | QuantLib::Pillar::Choice | N/S | N/S |
| CustomPillarDate: | QuantLib::Date | N/S | N/S |
| Rate: | QuantLib::Quote | 0.041234 | N/S |
| Output object | FraRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PeriodToStart: | QuantLib::Period | 3M | N/S |
| LengthInMonths: | QuantLib::Natural | 9 | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Convention: | QuantLib::BusinessDayConvention | ModifiedFollowing | N/S |
| EndOfMonth: | bool | true | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| PillarDate: | QuantLib::Pillar::Choice | N/S | N/S |
| CustomPillarDate: | QuantLib::Date | N/S | N/S |
| Rate: | QuantLib::Quote | 0.041234 | N/S |
| Output object | FraRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Bond: | QuantLib::Bond | DE0003088704 | N/S |
| UseCleanPrice: | bool | N/S | N/S |
| Price: | QuantLib::Quote | 100.4332 | N/S |
| Output object | BondHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDays: | QuantLib::Size | 3 | N/S |
| FaceAmount: | double | N/S | N/S |
| Coupons: | QuantLib::Rate | 0.04 | N/S |
| DayCounter: | QuantLib::DayCounter | Actual/Actual (ISMA) | N/S |
| PaymentBDC: | QuantLib::BusinessDayConvention | N/S | N/S |
| Redemption: | double | N/S | N/S |
| IssueDate: | QuantLib::Date | N/S | N/S |
| PaymentCalendar: | QuantLib::Calendar | TARGET | N/S |
| ExCouponPeriod: | QuantLib::Period | 10D | N/S |
| ExCouponCalendar: | QuantLib::Calendar | TARGET | N/S |
| ExCouponBDC: | QuantLib::BusinessDayConvention | Modified Following | N/S |
| ExCouponEndOfMonth: | bool | true | N/S |
| UseCleanPrice: | bool | true | N/S |
| Price: | QuantLib::Quote | 100.4332 | N/S |
| ScheduleID: | QuantLib::Schedule | N/S | N/S |
| Output object | FixedRateBondHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FuturesType: | QuantLib::Futures::Type | N/S | N/S |
| FuturesDate: | QuantLib::Date | N/S | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Price: | QuantLib::Quote | 95.9285 | N/S |
| ConvexityAdjQuote: | QuantLib::Quote | 0.0 | N/S |
| Output object | FuturesRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FuturesType: | QuantLib::Futures::Type | N/S | N/S |
| FuturesDate: | QuantLib::Date | N/S | N/S |
| LengthInMonths: | long | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Convention: | QuantLib::BusinessDayConvention | N/S | N/S |
| EndOfMonth: | bool | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Price: | QuantLib::Quote | 95.9285 | N/S |
| ConvexityAdjQuote: | QuantLib::Quote | 0.0 | N/S |
| Output object | FuturesRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FuturesType: | QuantLib::Futures::Type | N/S | N/S |
| FuturesDate: | QuantLib::Date | N/S | N/S |
| EndDate: | QuantLib::Date | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Price: | QuantLib::Quote | 95.9285 | N/S |
| ConvexityAdjQuote: | QuantLib::Quote | 0.0 | N/S |
| Output object | FuturesRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Tenor: | QuantLib::Period | 3M | N/S |
| FixingDays: | QuantLib::Natural | 2 | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Convention: | QuantLib::BusinessDayConvention | Modified Following | N/S |
| EndOfMonth: | bool | true | N/S |
| IsFxBaseCurrencyCollateralCurrency: | bool | true | N/S |
| FwdPoint: | QuantLib::Quote | 0.136565 | N/S |
| SpotFx: | QuantLib::Quote | 1.076565 | N/S |
| CollateralCurve: | QuantLib::YieldTermStructure | EURON | N/S |
| Output object | FxSwapRateHelper |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EffectiveDate: | QuantLib::Date | N/S | N/S |
| TerminationDate: | QuantLib::Date | 122M | N/S |
| Tenor: | QuantLib::Period | 1Y | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| Convention: | QuantLib::BusinessDayConvention | N/S | N/S |
| TermDateConv: | QuantLib::BusinessDayConvention | N/S | N/S |
| GenRule: | QuantLib::DateGeneration::Rule | N/S | N/S |
| EndOfMonth: | bool | N/S | N/S |
| FirstDate: | QuantLib::Date | N/S | N/S |
| NextToLastDate: | QuantLib::Date | N/S | N/S |
| Output object | Schedule |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| EffectiveDate: | QuantLib::Date | N/S | N/S |
| Output object | Schedule |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| TruncationDate: | QuantLib::Date | 54M | N/S |
| OriginalSchedule: | QuantLib::Schedule | N/S | N/S |
| Output object | Schedule |
Statistics analysis of N-dimensional (sequence) data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | QuantLib::Size | N/S | N/S |
| Output object | SequenceStatistics |
Statistics analysis of N-dimensional (sequence) data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | QuantLib::Size | N/S | N/S |
| Values: | QuantLib::Matrix | N/S | N/S |
| Weights: | QuantLib::Real | N/S | N/S |
| Output object | SequenceStatistics |
Statistics analysis of N-dimensional (sequence) data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | QuantLib::Size | N/S | N/S |
| Output object | SequenceStatisticsInc |
Statistics analysis of N-dimensional (sequence) data.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dimension: | QuantLib::Size | N/S | N/S |
| Values: | QuantLib::Matrix | N/S | N/S |
| Weights: | QuantLib::Real | N/S | N/S |
| Output object | SequenceStatisticsInc |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| A: | double | 0.03 | N/S |
| Sigma: | double | 0.15 | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | HullWhite |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| R0: | double | N/S | N/S |
| A: | double | N/S | N/S |
| B: | double | N/S | N/S |
| Sigma: | double | N/S | N/S |
| Lambda: | double | N/S | N/S |
| Output object | Vasicek |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| A: | double | N/S | N/S |
| Sigma: | double | N/S | N/S |
| B: | double | N/S | N/S |
| Eta: | double | N/S | N/S |
| Correlation: | double | N/S | N/S |
| YieldCurve: | QuantLib::YieldTermStructure | EURYC | N/S |
| Output object | G2 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionDate: | QuantLib::Date | 3m | N/S |
| Volatility: | QuantLib::Volatility | 0.14 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| RefDate: | QuantLib::Date | 34567 | N/S |
| AtmValue: | QuantLib::Real | 0.04 | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| Output object | FlatSmileSection |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionDate: | QuantLib::Date | 3m | N/S |
| ForwardRate: | QuantLib::Rate | N/S | N/S |
| Strike: | QuantLib::Rate | 0.01, 0.02, 0.03, 0.04 | N/S |
| FloatingStrike: | bool | N/S | N/S |
| AtmVolatility: | QuantLib::Volatility | 0.045 | N/S |
| VolatilitySpreads: | QuantLib::Rate | N/S | N/S |
| Alpha: | double | N/S | N/S |
| Beta: | double | N/S | N/S |
| Nu: | double | N/S | N/S |
| Rho: | double | N/S | N/S |
| AlphaIsFixed: | bool | N/S | N/S |
| BetaIsFixed: | bool | N/S | N/S |
| NuIsFixed: | bool | N/S | N/S |
| RhoIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Method: | QuantLib::OptimizationMethod | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | SabrInterpolatedSmileSection |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionDate: | QuantLib::Date | 3m | N/S |
| Strike: | QuantLib::Rate | 0.01, 0.02, 0.03, 0.04 | N/S |
| FloatingStrike: | bool | N/S | N/S |
| Alpha: | double | N/S | N/S |
| Beta: | double | N/S | N/S |
| Nu: | double | N/S | N/S |
| Rho: | double | N/S | N/S |
| AlphaIsFixed: | bool | N/S | N/S |
| BetaIsFixed: | bool | N/S | N/S |
| NuIsFixed: | bool | N/S | N/S |
| RhoIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Method: | QuantLib::OptimizationMethod | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| ForwardRate: | QuantLib::Quote | N/S | N/S |
| AtmVolatility: | QuantLib::Quote | 0.045 | N/S |
| VolatilitySpreads: | QuantLib::Quote | N/S | N/S |
| Output object | SabrInterpolatedSmileSection |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionTime: | QuantLib::Time | 1.0 | N/S |
| Strikes: | QuantLib::Rate | 0.01, 0.02, 0.03, 0.04 | N/S |
| Alpha: | double | N/S | N/S |
| Beta: | double | N/S | N/S |
| Nu: | double | N/S | N/S |
| Rho: | double | N/S | N/S |
| AlphaIsFixed: | bool | N/S | N/S |
| BetaIsFixed: | bool | N/S | N/S |
| NuIsFixed: | bool | N/S | N/S |
| RhoIsFixed: | bool | N/S | N/S |
| VegaWeighted: | bool | N/S | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| Method: | QuantLib::OptimizationMethod | N/S | N/S |
| StdDevs: | QuantLib::Quote | 0.1, 0.2, 0.3, 0.4 | N/S |
| Forward: | QuantLib::Quote | 0.045 | N/S |
| Output object | SabrSmileSection |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionDate: | QuantLib::Date | 3m | N/S |
| Strikes: | QuantLib::Rate | 0.01, 0.02, 0.03, 0.04 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| VolatilityType: | QuantLib::VolatilityType | N/S | N/S |
| Displacement: | QuantLib::Real | N/S | N/S |
| StdDevs: | QuantLib::Quote | 0.1, 0.2, 0.3, 0.4 | N/S |
| AtmLevel: | QuantLib::Quote | 0.1 | N/S |
| Output object | InterpolatedSmileSection |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionTime: | QuantLib::Time | N/S | N/S |
| SabrVolSurface: | QuantLib::SabrVolSurface | N/S | N/S |
| Output object | SmileSectionFromSabrVolSurface |
Statistics and risk measures tool.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Values: | QuantLib::Real | 1.0,1.5,2.0 | N/S |
| Weights: | QuantLib::Real | 1.0,1.0,1.0 | N/S |
| Output object | Statistics |
Statistics and risk measures tool.
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Values: | QuantLib::Real | 1.0,1.5,2.0 | N/S |
| Weights: | QuantLib::Real | 1.0,1.0,1.0 | N/S |
| Output object | IncrementalStatistics |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| LegIDs: | QuantLibAddin::Leg | N/S | N/S |
| Payer: | bool | N/S | N/S |
| Output object | Swap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapTenor: | QuantLib::Period | 10Y | N/S |
| SwapIndex: | QuantLib::SwapIndex | EuriborSwapIsdaFixA10Y | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor3M | N/S |
| IborSpread: | QuantLib::Spread | N/S | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| CmsCouponPricer: | QuantLib::CmsCouponPricer | CmsCouponPricerID | N/S |
| Output object | Swap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| VanillaSwap: | QuantLib::VanillaSwap | N/S | N/S |
| Exercise: | QuantLib::Exercise | N/S | N/S |
| SettlementType: | QuantLib::Settlement::Type | N/S | N/S |
| Output object | Swaption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapIndex: | QuantLib::SwapIndex | EuriborSwapIsdaFixA10Y | N/S |
| OptionTenor: | QuantLib::Period | 5Y | N/S |
| Strike: | QuantLib::Rate | N/S | N/S |
| PricingEngineID: | QuantLib::PricingEngine | SwaptionEngineID | N/S |
| Output object | Swaption |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurrentLink: | string | N/S | N/S |
| Output object | RelinkableHandleImpl<QuantLibAddin::SwaptionVolatilityStructure, QuantLib::SwaptionVolatilityStructure> |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Volatility: | QuantLib::Quote | N/S | N/S |
| Output object | ConstantSwaptionVolatility |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BaseVolStructure: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| Spread: | QuantLib::Quote | 0.01 | N/S |
| Output object | SpreadedSwaptionVolatility |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Calendar: | QuantLib::Calendar | N/S | N/S |
| BusinessDayConvention: | QuantLib::BusinessDayConvention | "Following" | N/S |
| OptionTenors: | QuantLib::Period | 2y, 5y | N/S |
| SwapTenors: | QuantLib::Period | 2y, 5y | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Volatilities: | QuantLib::Quote | N/S | N/S |
| Output object | SwaptionVolatilityMatrix |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionTenor: | QuantLib::Period | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| StrikeSpreads: | QuantLib::Spread | .01, .02, .03 | N/S |
| SwapIndexBase: | QuantLib::SwapIndex | N/S | N/S |
| ShortSwapIndexBase: | QuantLib::SwapIndex | N/S | N/S |
| VegaWeightedSmileFit: | bool | N/S | N/S |
| AtmVolStructure: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| SpreadVols: | QuantLib::Quote | N/S | N/S |
| Output object | SwaptionVolCube2 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| OptionTenors: | QuantLib::Period | 5y | N/S |
| SwapTenors: | QuantLib::Period | 2y | N/S |
| StrikeSpreads: | QuantLib::Spread | .01, .02, .03 | N/S |
| SwapIndexBase: | QuantLib::SwapIndex | N/S | N/S |
| ShortSwapIndexBase: | QuantLib::SwapIndex | N/S | N/S |
| VegaWeightedSmileFit: | bool | N/S | N/S |
| IsFixed: | bool | FALSE, TRUE, FALSE, FALSE | N/S |
| IsAtmCalibrated: | bool | FALSE | N/S |
| EndCriteria: | QuantLib::EndCriteria | N/S | N/S |
| MaxErrorTol: | double | N/S | N/S |
| OptMethod: | QuantLib::OptimizationMethod | N/S | N/S |
| AtmVolStructure: | QuantLib::SwaptionVolatilityStructure | N/S | N/S |
| SpreadVols: | QuantLib::Quote | N/S | N/S |
| Guess: | QuantLib::Quote | N/S | N/S |
| Output object | SwaptionVolCube1 |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| VolCube: | QuantLib::SwaptionVolatilityCube | N/S | N/S |
| OptionDate: | QuantLib::Date | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Output object | SmileSectionByCube |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| VolCube: | QuantLib::SwaptionVolatilityCube | N/S | N/S |
| OptionDate: | QuantLib::Period | 5y | N/S |
| SwapTenor: | QuantLib::Period | 2y | N/S |
| Output object | SmileSectionByCube |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurrentLink: | string | N/S | N/S |
| Output object | RelinkableHandleImpl<QuantLibAddin::YieldTermStructure, QuantLib::YieldTermStructure> |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurveDates: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| CurveDiscounts: | QuantLib::DiscountFactor | 1.0,0.95,0.9,0.85,0.8 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | DiscountCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurveDates: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| CurveYields: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | ZeroCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| CurveDates: | QuantLib::Date | '2M,3M,4M,5M,6M | N/S |
| ForwardYields: | QuantLib::Rate | 0.02,0.02,0.02,0.02,0.02 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | ForwardCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| NDays: | QuantLib::Size | N/S | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Compounding: | QuantLib::Compounding | N/S | N/S |
| Frequency: | QuantLib::Frequency | N/S | N/S |
| Rate: | QuantLib::Quote | 0.044 | N/S |
| Output object | FlatForward |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| BaseYieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Spread: | QuantLib::Quote | 0.0 | N/S |
| Output object | ForwardSpreadedTermStructure |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| ReferenceDate: | QuantLib::Date | 1D | N/S |
| BaseYieldCurve: | QuantLib::YieldTermStructure | N/S | N/S |
| Output object | ImpliedTermStructure |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dates: | QuantLib::Date | 0D,1M,3M,6M,1Y,2Y,3Y,5Y,10Y | N/S |
| Data: | QuantLib::Real | 1.0,0.99,0.96,0.94,0.9,0.8,0.7,0.6,0.4 | N/S |
| Calendar: | QuantLib::Calendar | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| JumpDates: | QuantLib::Date | 1Y | N/S |
| TraitsID: | string | N/S | N/S |
| InterpolatorID: | string | N/S | N/S |
| MixedInterpolationBehavior: | QuantLib::MixedInterpolation::Behavior | N/S | N/S |
| NRateHelper: | QuantLib::Size | N/S | N/S |
| Jumps: | QuantLib::Quote | 1.0 | N/S |
| Output object | InterpolatedYieldCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Dates: | QuantLib::Date | N/S | N/S |
| Values: | QuantLib::Real | N/S | N/S |
| Output object | TimeSeriesDef |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| Index: | QuantLib::Index | N/S | N/S |
| Output object | TimeSeriesDef |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| PayerReceiver: | QuantLib::VanillaSwap::Type | N/S | N/S |
| Nominal: | double | N/S | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| FixDayCounter: | QuantLib::DayCounter | 30/360 (Bond Basis) | N/S |
| IborIndex: | QuantLib::IborIndex | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| FloatingLegDayCounter: | QuantLib::DayCounter | Actual/360 | N/S |
| PaymentConvention: | QuantLib::BusinessDayConvention | N/S | N/S |
| FixSchedule: | QuantLib::Schedule | FixedSchedule | N/S |
| FloatingLegSchedule: | QuantLib::Schedule | FloatingSchedule | N/S |
| Output object | VanillaSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlDays: | QuantLib::Natural | N/S | N/S |
| SwapTenor: | QuantLib::Period | 5Y | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor6M | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| ForwardStart: | QuantLib::Period | "0D" | N/S |
| FixDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| PricingEngineID: | QuantLib::PricingEngine | DiscountSwapEngineID | N/S |
| Output object | VanillaSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapTenor: | QuantLib::Period | 2Y | N/S |
| IborIndex: | QuantLib::IborIndex | Euribor3M | N/S |
| FixedRate: | QuantLib::Rate | N/S | N/S |
| FirstImmDate: | QuantLib::Date | N/S | N/S |
| FixDayCounter: | QuantLib::DayCounter | N/S | N/S |
| Spread: | QuantLib::Spread | N/S | N/S |
| PricingEngineID: | QuantLib::PricingEngine | DiscountSwapEngineID | N/S |
| Output object | VanillaSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapIndex: | QuantLib::SwapIndex | N/S | N/S |
| FixingDate: | QuantLib::Date | N/S | N/S |
| Output object | VanillaSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SwapRateHelper: | QuantLib::SwapRateHelper | N/S | N/S |
| Output object | VanillaSwap |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDate: | QuantLib::Date | 0D | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Volatility: | double | 0.2 | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | BlackConstantVol |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDate: | QuantLib::Date | 0D | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| Dates: | QuantLib::Date | 3m, 1y, 5y | N/S |
| Strikes: | double | 0.03, 0.05, 0.10 | N/S |
| Volatilities: | QuantLib::Matrix | N/S | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| Output object | BlackVarianceSurface |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| SettlementDays: | QuantLib::Natural | 2D | N/S |
| Calendar: | QuantLib::Calendar | TARGET | N/S |
| OptionTenors: | QuantLib::Period | N/S | N/S |
| InclusionInInterpolation: | bool | N/S | N/S |
| Convention: | QuantLib::BusinessDayConvention | Following | N/S |
| DayCounter: | QuantLib::DayCounter | N/S | N/S |
| VolatilitiesQuotes: | QuantLib::Quote | N/S | N/S |
| Output object | AbcdAtmVolCurve |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| InterestRateIndex: | QuantLib::InterestRateIndex | N/S | N/S |
| OptionTenors: | QuantLib::Period | N/S | N/S |
| AtmRateSpreads: | QuantLib::Spread | N/S | N/S |
| BlackAtmVolCurve: | QuantLib::BlackAtmVolCurve | N/S | N/S |
| VolatilitiesQuotes: | QuantLib::Quote | N/S | N/S |
| Output object | SabrVolSurface |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| A: | double | N/S | N/S |
| B: | double | N/S | N/S |
| C: | double | N/S | N/S |
| D: | double | N/S | N/S |
| ResetIndex: | long | 0 | N/S |
| RateTimes: | QuantLib::Time | 0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5 | N/S |
| Output object | PiecewiseConstantAbcdVariance |
| Parameter name | Type (in C++) | Example value | Const? |
|---|---|---|---|
| FixingTimes: | double | 0.0,1.0,2.0,3.0,4.0,5.0 | N/S |
| A: | double | 1.0 | N/S |
| B: | double | 1.0 | N/S |
| C: | double | 1.0 | N/S |
| D: | double | 1.0 | N/S |
| Output object | LmExtLinearExponentialVolModel |