QuantLib Services
Bojan Nikolic / BN Algorithms Ltd

[QuantLib home]|[website home]|[BN Algorithms]

Overview

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.

qlAbcdFunctionInstantaneousValue

Returns the instantaneous volatility as function of residual time to maturity u=T-t: [a + b*u] * e^{-c*u} + d.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
U: double5.0,4.0,3.0,2.0,1.0False

Return value: double

qlAbcdFunctionInstantaneousCovariance

Returns covariance at calendar time u between T and S rates fixing times.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
U: double0.0,0.5,1.0False
T: double0.0False
S: double1.0False

Return value: double

qlAbcdFunctionInstantaneousVariance

Returns variance at calendar time(s) u of T-fixing rate.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
U: double0.0,0.5,1.0False
T: double1.0False

Return value: double

qlAbcdFunctionInstantaneousVolatility

Returns volatility/ies at calendar time(s) u of T-fixing rate.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
U: double0.0,0.5,1.0False
T: double1.0False

Return value: QuantLib::Volatility

qlAbcdFunctionCovariance

Returns covariance(s) in [tMin,tMax] between T and S rate fixing times.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
TMin: double0.0False
TMax: double0.25,0.5False
T: double0.5False
S: double1.0False

Return value: double

qlAbcdFunctionVariance

Returns variance(s) in [tMin,tMax] of T rate fixing time.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
TMin: double0.0False
TMax: double0.5,1.0False
T: double1.0False

Return value: double

qlAbcdFunctionVolatility

Returns volatility/ies in [tMin,tMax] of T rate fixing time.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction
TMin: double1.0False
TMax: double0.5,1.0False
T: double1.0False

Return value: QuantLib::Volatility

qlAbcdFunctionShortTermVolatility

Returns the short term volatility implied by Abcd volatility.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: QuantLib::Volatility

qlAbcdFunctionLongTermVolatility

Returns the long term volatility implied by Abcd volatility.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: QuantLib::Volatility

qlAbcdFunctionMaximumLocation

Returns, if b is positive, the location of the Abcd volatility maximum.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: QuantLib::Time

qlAbcdFunctionMaximumVolatility

Returns, if b is positive, the maximum of the Abcd volatility.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: QuantLib::Volatility

qlAbcdFunctionA

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: double

qlAbcdFunctionB

Returns the b coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: double

qlAbcdFunctionC

Returns the c coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: double

qlAbcdFunctionD

Returns the d coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: double

qlAbcdDFunction

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdFunction

Return value: double

qlAbcdCalibrationCompute

compute calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: void

qlAbcdCalibrationK

Returns the 'k' adjustment factors needed to match Black vols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration
Times: QuantLib::TimeN/SN/S
BlackVols: QuantLib::VolatilityN/SN/S

Return value: double

qlAbcdCalibrationError

Returns the root mean squared error between the abdc implied Black vols and a given Black vol vector.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAbcdCalibrationMaxError

Returs the max error between the abdc implied Black vols and a given Black vol vector.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAbcdCalibrationEndCriteria

Calibrates the a, b, c, d parameters of the vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: QuantLib::EndCriteria::Type

qlAbcdCalibrationA

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAbcdCalibrationB

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAbcdCalibrationC

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAbcdCalibrationD

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdCalibration

Return value: double

qlAccountingEngineMultiplePathValues

return multiple path values.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AccountingEngine
Paths: long8191N/S
SequenceStats: QuantLib::SequenceStatisticsIncN/SN/S

Return value: void

qlAlphaFormOperator

returns the Alpha Form value at time i.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AlphaForm
Time: QuantLib::Size0N/S

Return value: QuantLib::Real

qlAlphaFormSetAlpha

set the Alpha parameter value to Alpha Form.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AlphaForm
Alpha: QuantLib::Real1N/S

Return value: void

qlAssetSwapBondLegAnalysis

The bond leg cash flow analysis.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AssetSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlAssetSwapFloatingLegAnalysis

The floating leg cash flow analysis.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AssetSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlAssetSwapFairSpread

the fair rate of the asset swap, i.e. the asset swap spread.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: QuantLib::Spread

qlAssetSwapFloatingLegBPS

the BPS of the floating leg.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: double

qlAssetSwapFairCleanPrice

the fair price of the bond in the asset swap.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: QuantLib::Real

qlAssetSwapFairNonParRepayment

the fair non par repayment of the bond in the asset swap.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: QuantLib::Real

qlAssetSwapParSwap

Returns TRUE if par swap

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: bool

qlAssetSwapPayBondCoupon

Returns TRUE if it is a bond coupon payer swap

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AssetSwap

Return value: bool

qlBondSettlementDays

Returns the number of settlement days of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: QuantLib::Natural

qlBondCalendar

Returns the calendar of the bond, e.g. TARGET.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: QuantLib::Calendar

qlBondNotionals

Returns the notionals of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: QuantLib::Real

qlBondNotional

Returns the notional of the bond at a given date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond
SettlementDate: QuantLib::DateN/SFalse

Return value: QuantLib::Real

qlBondMaturityDate

Returns the maturity date of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: QuantLib::Date

qlBondIssueDate

Returns the issue date of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: QuantLib::Date

qlBondIsTradable

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 nameType (in C++)Example valueConst?
Input objectQuantLib::Bond
SettlementDate: QuantLib::DateN/SFalse

Return value: bool

qlBondSettlementDate

Returns the settlement date of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond
EvaluationDate: QuantLib::DateN/SFalse

Return value: QuantLib::Date

qlBondCleanPrice

Returns the clean price for the given bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Bond

Return value: double

qlBondDescription

Returns the bond description string.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond

Return value: string

qlBondCurrency

Returns the bond currency.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond

Return value: string

qlBondRedemptionAmount

Returns the redemption amount of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond

Return value: QuantLib::Real

qlBondRedemptionDate

Returns the redemption payment date of the bond.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond

Return value: QuantLib::Date

qlBondFlowAnalysis

Returns the bond cash flow analysis.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlBondSetCouponPricer

Set the coupon pricer at the given Bond object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond
FloatingRateCouponPricer: QuantLib::FloatingRateCouponPricerN/SN/S

Return value: void

qlBondSetCouponPricers

Set the coupon pricer at the given Bond object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Bond
FloatingRateCouponPricer: QuantLib::FloatingRateCouponPricerN/SN/S

Return value: void

qlRendistatoBasketSize

Returns the number of BTPs in the RendistatoBasket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoBasket

Return value: QuantLib::Size

qlRendistatoBasketOutstanding

Returns the overall outstanding of the BTPs in the RendistatoBasket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoBasket

Return value: QuantLib::Real

qlRendistatoBasketOutstandings

Returns the outstandings of the BTPs in the RendistatoBasket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoBasket

Return value: QuantLib::Real

qlRendistatoBasketWeights

Returns the weights of the BTPs in the RendistatoBasket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoBasket

Return value: QuantLib::Real

qlRendistatoCalculatorYield

Returns RendistatoCalculator's yield.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorDuration

Returns RendistatoCalculator's duration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlRendistatoCalculatorYields

Returns the yields of the BTPs in the RendistatoCalculator's underlying basket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorDurations

Returns the durations of the BTPs in the RendistatoCalculator's underlying basket.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlRendistatoCalculatorSwapLengths

Returns RendistatoCalculator's equivalent swaps' lengths.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlRendistatoCalculatorSwapRates

Returns RendistatoCalculator's equivalent swaps' rates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorSwapYields

Returns RendistatoCalculator's equivalent swaps' yields.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorSwapDurations

Returns RendistatoCalculator's equivalent swaps' durations.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlRendistatoCalculatorEquivalentSwapRate

Returns RendistatoCalculator's equivalent swap rate.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorEquivalentSwapYield

Returns RendistatoCalculator's equivalent swap yield.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Rate

qlRendistatoCalculatorEquivalentSwapDuration

Returns RendistatoCalculator's equivalent swap duration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlRendistatoCalculatorEquivalentSwapSpread

Returns RendistatoCalculator's equivalent swap spread.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Spread

qlRendistatoCalculatorEquivalentSwapLength

Returns RendistatoCalculator's equivalent swap lenght in years.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RendistatoCalculator

Return value: QuantLib::Time

qlCalibrationHelperSetPricingEngine

Set the priging engine for the given SwaptionHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CalibrationHelper
PricingEngine: QuantLib::PricingEnginePricingEngineIDN/S

Return value: void

qlCalibrationHelperImpliedVolatility

Set the priging engine for the given SwaptionHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CalibrationHelper
TargetValue: QuantLib::RealN/SN/S
Accuracy: QuantLib::RealN/SN/S
MaxEvaluations: QuantLib::SizeN/SN/S
MinVol: QuantLib::VolatilityN/SN/S
MaxVol: QuantLib::VolatilityN/SN/S

Return value: QuantLib::Volatility

qlSwaptionHelperModelValue

Set the priging engine for the given SwaptionHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionHelper

Return value: double

qlOneFactorAffineModelCalibrate

calibrate a model.

could not parseQuantLib::OptimizationMethodscalarunderlyingClassOptimizationMethod object ID.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneFactorAffineModel
CalibrationHelpers: QuantLib::CalibrationHelperN/SN/S
Weights: QuantLib::RealN/SN/S
FixedCoeff: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Constraint: QuantLib::ConstraintN/SN/S

Return value: void

qlModelG2Calibrate

calibrate a model.

could not parseQuantLib::OptimizationMethodscalarunderlyingClassOptimizationMethod object ID.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2
CalibrationHelpers: QuantLib::CalibrationHelperN/SN/S
Weights: QuantLib::RealN/SN/S
FixedCoeff: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Constraint: QuantLib::ConstraintN/SN/S

Return value: void

qlCapFloorType

Returns the type (e.g. Cap, Floor) for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor

Return value: QuantLib::CapFloor::Type

qlCapFloorCapRates

Returns the cap rates for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor

Return value: QuantLib::Rate

qlCapFloorFloorRates

Returns the floor rates for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor

Return value: QuantLib::Rate

qlCapFloorAtmRate

Returns the at-the-money rate for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor
YieldCurve: QuantLib::YieldTermStructureEURYCN/S

Return value: QuantLib::Rate

qlCapFloorStartDate

Returns the start (i.e. first accrual) date for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor

Return value: QuantLib::Date

qlCapFloorMaturityDate

Returns the maturity (i.e. last payment) date for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor

Return value: QuantLib::Date

qlCapFloorImpliedVolatility

Returns the volatility implied by the given price for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloor
Price: QuantLib::Real0.2N/S
Guess: QuantLib::VolatilityN/SN/S
Accuracy: QuantLib::RealN/SN/S
MaxIter: QuantLib::NaturalN/SN/S
MinVol: QuantLib::VolatilityN/SN/S
MaxVol: QuantLib::VolatilityN/SN/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S

Return value: QuantLib::Volatility

qlCapFloorLegAnalysis

Returns the cash flow analysis for the given CapFloor object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CapFloor
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlOptionletVTSVolatility

Returns volatility from the given OptionletVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletVolatilityStructure
OptionDate: QuantLib::Date5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlOptionletVTSVolatility2

Returns volatility from the given OptionletVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletVolatilityStructure
OptionTenor: QuantLib::Period5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlOptionletVTSBlackVariance

Returns the black variance corresponding to a given strike for a given exercise date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletVolatilityStructure
OptionDate: QuantLib::Date5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Real

qlOptionletVTSBlackVariance2

Returns the black variance corresponding to a given strike for a given exercise date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletVolatilityStructure
OptionTenor: QuantLib::Period5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Real

qlStrippedOptionletBaseStrikes

Returns optionlet strike from the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase
Index: QuantLib::Size0N/S

Return value: QuantLib::Rate

qlStrippedOptionletBaseOptionletVolatilities

Returns optionlet volatilities from the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase
Index: QuantLib::Size0N/S

Return value: QuantLib::Volatility

qlStrippedOptionletBaseOptionletFixingDates

Returns optionlet fixing dates from the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::Date

qlStrippedOptionletBaseOptionletFixingTimes

Returns optionlet fixing times from the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::Time

qlStrippedOptionletBaseAtmOptionletRates

Returns atm optionlet rates from the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::Rate

qlStrippedOptionletBaseDayCounter

Returns the DayCounter used by the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::DayCounter

qlStrippedOptionletBaseCalendar

Returns the calendar used by the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::Calendar

qlStrippedOptionletBaseSettlementDays

Returns the number of settlement days for the given StrippedOptionletBase object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::Natural

qlStrippedOptionletBaseBusinessDayConvention

Returns the business day convention used in tenor to date conversion.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrippedOptionletBase

Return value: QuantLib::BusinessDayConvention

qlOptionletStripperOptionletFixingTenors

Returns optionlet fixing tenors from the given OptionletStripper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper

Return value: QuantLib::Period

qlOptionletStripperOptionletPaymentDates

Returns optionlet payment dates from the given OptionletStripper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper

Return value: QuantLib::Date

qlOptionletStripperOptionletAccrualPeriods

Returns optionlet accrual periods from the given OptionletStripper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper

Return value: QuantLib::Time

qlOptionletStripper1CapFloorPrices

Returns option prices matrix from the given OptionletStripper1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper1

Return value: QuantLib::Matrix

qlOptionletStripper1CapFloorVolatilities

Returns option volatilities matrix from the given OptionletStripper1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper1

Return value: QuantLib::Matrix

qlOptionletStripper1OptionletPrices

Returns optionlet prices matrix from the given OptionletStripper1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper1

Return value: QuantLib::Matrix

qlOptionletStripper1SwitchStrike

Returns option switch strike from the given OptionletStripper1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper1

Return value: QuantLib::Rate

qlOptionletStripper2SpreadsVol

Returns optionlet spread (with respect to ATM) vols from the given OptionletStripper2 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper2

Return value: QuantLib::Spread

qlOptionletStripper2AtmCapFloorPrices

Returns ATM option prices from the given OptionletStripper2 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper2

Return value: QuantLib::Real

qlOptionletStripper2AtmCapFloorStrikes

Returns option ATM strikes from the given OptionletStripper2 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OptionletStripper2

Return value: QuantLib::Rate

qlCapFloorTermVTSVolatility

Returns volatility from the given CapFloorTermVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolatilityStructure
OptionDate: QuantLib::Date5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlCapFloorTermVTSVolatility2

Returns volatility from the given CapFloorTermVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolatilityStructure
OptionTenor: QuantLib::Period5yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlCapFloorTermVolCurveOptionTenors

Returns the option tenors from the given CapFloorTermVolCurve object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolCurve

Return value: QuantLib::Period

qlCapFloorTermVolCurveOptionDates

Returns the option dates from the given CapFloorTermVolCurve object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolCurve

Return value: QuantLib::Date

qlCapFloorTermVolSurfaceOptionTenors

Returns the option tenors from the given CapFloorTermVolSurface object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolSurface

Return value: QuantLib::Period

qlCapFloorTermVolSurfaceOptionDates

Returns the option dates from the given CapFloorTermVolSurface object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolSurface

Return value: QuantLib::Date

qlCapFloorTermVolSurfaceStrikes

Returns the option strikes from the given CapFloorTermVolSurface object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CapFloorTermVolSurface

Return value: QuantLib::Rate

qlBrowseCmsMarket

return the market and implied spreads matrix.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarket

Return value: any

qlCmsMarketCalibrationCompute

Return the best beta and mean reversion.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarketCalibration
EndCriteria: QuantLib::EndCriteriaN/SN/S
OptimizationMethod: QuantLib::OptimizationMethodN/SN/S
Guess: QuantLib::ArrayN/SN/S
IsMeanRevFixed: boolFALSEN/S

Return value: QuantLib::Array

qlCmsMarketCalibrationError

Returns the error of the simultaneous calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CmsMarketCalibration

Return value: double

qlCmsMarketCalibrationEndCriteria

Returns the optimization end criteria of the simultaneous calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CmsMarketCalibration

Return value: QuantLib::EndCriteria::Type

qlCmsMarketCalibrationElapsed

Returns the elapsed time of the simultaneous calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarketCalibration

Return value: double

qlCmsMarketCalibrationSparseSabrParameters

returns results of Sabr calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarketCalibration

Return value: any

qlCmsMarketCalibrationDenseSabrParameters

returns results of Sabr calibration.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarketCalibration

Return value: any

qlSimultaneousCalibrationBrowseCmsMarket

return the market and implied spreads matrix.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CmsMarketCalibration

Return value: any

qlHistoricalForwardRatesAnalysisSkippedDates

Returns vector of historic dates for which some fixing is missing.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalForwardRatesAnalysis

Return value: QuantLib::Date

qlHistoricalForwardRatesAnalysisSkippedDatesErrorMessage

Returns vector of error messages for historic dates with missing fixing.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalForwardRatesAnalysis

Return value: string

qlHistoricalForwardRatesAnalysisFailedDates

Returns vector of dates for which forward rates could not be calculated.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalForwardRatesAnalysis

Return value: QuantLib::Date

qlHistoricalForwardRatesAnalysisFailedDatesErrorMessage

Returns vector of error messages for dates on which forward rates could not be calculated.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalForwardRatesAnalysis

Return value: string

qlHistoricalForwardRatesAnalysisFixingPeriods

Returns the forward rates time grid.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalForwardRatesAnalysis

Return value: QuantLib::Period

qlHistoricalRatesAnalysisSkippedDates

Returns vector of historic dates for which some fixing is missing.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalRatesAnalysis

Return value: QuantLib::Date

qlHistoricalRatesAnalysisSkippedDatesErrorMessage

Returns vector of error messages for historic dates with missing fixing.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::HistoricalRatesAnalysis

Return value: string

qlPiecewiseConstantCorrelationCorrelation

Returns the pseudo-root of the equivalent covariance swap rates matrix.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantCorrelation
TimeIndex: QuantLib::Size0N/S

Return value: QuantLib::Matrix

qlPiecewiseConstantCorrelationTimes

Piecewise Constant Correlation Times.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantCorrelation

Return value: double

qlPiecewiseConstantCorrelationNumberOfRates

Piecewise Constant Correlation Number of Rates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantCorrelation

Return value: QuantLib::Size

qlConundrumPricerByNumericalIntegrationUpperLimit

Returns the upper limit of the integral.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::NumericHaganPricer

Return value: double

qlCdsCouponLegNPV

Returns the CL NPV.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CreditDefaultSwap

Return value: QuantLib::Real

qlCdsDefaultLegNPV

Returns the DL NPV.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CreditDefaultSwap

Return value: QuantLib::Real

qlCdsFairSpread

Returns the running spread that, given the quoted recovery rate, will make the running-only CDS have an NPV of 0.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CreditDefaultSwap

Return value: QuantLib::Rate

qlCdsFairUpfront

Returns the upfront spread that, given the running spread and the quoted recovery rate, will make the instrument have an NPV of 0.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CreditDefaultSwap

Return value: QuantLib::Rate

qlHRDates

Dates on which the hazard rate interpolation is performed.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseHazardRateCurve

Return value: QuantLib::Date

qlHRates

Dates on which the hazard rate interpolation is performed.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseHazardRateCurve

Return value: QuantLib::Real

qlCdsOptionImpliedVol

Implied black CDS option volatility.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CdsOption
Price: QuantLib::RealN/SN/S
RecoveryRate: QuantLib::RealN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
DefaultCurve: QuantLib::DefaultProbabilityTermStructureN/SN/S

Return value: QuantLib::Volatility

qlBaseCorrelationValue

Returns the interpolated base correlation value.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::BaseCorrelationTermStructure
Date: QuantLib::DateN/SN/S
LossLevel: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlCTSMMCapletCalibrationCalibrate

calibrate.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration
NumberOfFactors: QuantLib::Natural3N/S
MaxIter: QuantLib::NaturalN/SN/S
Tol: QuantLib::RealN/SN/S
InnerMaxIter: QuantLib::NaturalN/SN/S
InnerTol: QuantLib::RealN/SN/S

Return value: bool

qlCTSMMCapletCalibrationFailures

failures.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Natural

qlCTSMMCapletCalibrationDeformationSize

deformationSize.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationMarketCapletVols

market caplet volalitilies.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationModelCapletVols

model caplet volalitilies.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationCapletRmsError

capletRmsError.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationCapletMaxError

capletMaxError.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationMarketSwaptionVols

market swaption volalitilies.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationModelSwaptionVols

model swaption volalitilies.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationSwaptionRmsError

swaptionRmsError.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationSwaptionMaxError

swaptionMaxError.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration

Return value: QuantLib::Real

qlCTSMMCapletCalibrationSwapPseudoRoot

swapPseudoRoot.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration
Index: QuantLib::Size0N/S

Return value: QuantLib::Matrix

qlCTSMMCapletCalibrationTimeDependentCalibratedSwaptionVols

timeDependentCalibratedSwaptionVols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration
Index: QuantLib::Size0N/S

Return value: QuantLib::Volatility

qlCTSMMCapletCalibrationTimeDependentUnCalibratedSwaptionVols

timeDependentUnCalibratedSwaptionVols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletCalibration
Index: QuantLib::Size0N/S

Return value: QuantLib::Volatility

qlCTSMMCapletAlphaFormCalibrationAlpha

alpha.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CTSMMCapletAlphaFormCalibration

Return value: QuantLib::Real

qlCurveStateRateTimes

return the rate times of the CurveState object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CurveState

Return value: QuantLib::Time

qlCurveStateRateTaus

return the rate taus of the CurveState object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CurveState

Return value: QuantLib::Time

qlCurveStateForwardRates

Returns the current forward rates of the CurveState object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CurveState

Return value: QuantLib::Rate

qlCurveStateCoterminalSwapRates

Returns the current swap rates of the CurveState object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CurveState

Return value: QuantLib::Rate

qlCurveStateCMSwapRates

Returns the current swap rates of the CurveState object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CurveState
SpanningForwards: QuantLib::Size4N/S

Return value: QuantLib::Rate

qlCMSwapCurveStateSetOnCMSwapRates

set the CurveState object on given vector of coterminal swaps.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CMSwapCurveState
CMSwapRates: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S

Return value: void

qlCoterminalSwapCurveStateSetOnCoterminalSwapRates

set the CurveState object on given vector of coterminal swaps.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CoterminalSwapCurveState
CoterminalSwaps: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S

Return value: void

qlLMMCurveStateSetOnForwardRates

set the CurveState object on given vector of forward rates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::LMMCurveState
Rates: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S

Return value: void

qlLMMCurveStateSetOnDiscountRatios

set the CurveState object on given vector of discount ratios.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::LMMCurveState
DiscountRatios: double1.0,1.0,1.0,1.0,1.0N/S

Return value: void

qlCreditBasketSetLossModel

Assigns a Default Loss Model to a given basket. Subsequent basket computations will use that model.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DefaultLossModel: QuantLib::DefaultLossModelN/SN/S

Return value: void

qlCreditBasketSize

Number of counterparties at inception.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket

Return value: QuantLib::Size

qlCreditBasketLiveNotional

Non defaulted portfolio outstanding notional.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket

Return value: QuantLib::Real

qlCreditBasketLoss

Losses from default events.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket

Return value: QuantLib::Real

qlCreditBasketAttachLive

Remaining attach amount.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket

Return value: QuantLib::Real

qlCreditBasketDetachLive

Remaining detach amount.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket

Return value: QuantLib::Real

qlExpectedTrancheLoss

Basket expected tranche according to the basket loss model.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateForLoss: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlCreditBasketPercentile

Basket loss percentile amount (tranched).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateForLoss: QuantLib::DateN/SN/S
PercentileValue: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlCreditBasketESF

Basket loss expected shortfall amount (tranched).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateForLoss: QuantLib::DateN/SN/S
PercentileValue: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlCreditBasketNthEventP

Probability of each basket name to default in the given order.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
EventOrder: QuantLib::SizeN/SN/S
DateForLoss: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlCreditBasketProbLoss

Probability of basket losses to be over a value at a given date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateForLoss: QuantLib::DateN/SN/S
LossFractionValue: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlCreditBasketSplitLoss

Splits a loss amount by counterparty contribution.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateForLoss: QuantLib::DateN/SN/S
LossValue: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlCreditBasketDefaulCorrel

Default correlation between two basket issuers.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Basket
DateCorrel: QuantLib::DateN/SN/S
IndexIssuer1: QuantLib::SizeN/SN/S
IndexIssuer2: QuantLib::SizeN/SN/S

Return value: QuantLib::Real

qlDefaultTSDefaultProbability

Returns the probability of default between the reference date and the given date from the given DefaultProbabilityTermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::DefaultProbabilityTermStructure
Dates: QuantLib::Date'1Y,2Y,3Y,4Y,5YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Probability

qlLMMDriftCalculatorComputePlain

Full factor drift computation using the LMMDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlLMMDriftCalculatorComputeReduced

Reduced factor (Joshi algorithm) drift computation using the LMMDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlLMMDriftCalculatorCompute

Reduced factor (Joshi algorithm) drift computation using the LMMDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlLMMNormalDriftCalculatorComputePlain

Full factor drift computation using the LMMNormalDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMNormalDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlLMMNormalDriftCalculatorComputeReduced

Reduced factor (Joshi algorithm) drift computation using the LMMNormalDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMNormalDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlLMMNormalDriftCalculatorCompute

Reduced factor (Joshi algorithm) drift computation using the LMMNormalDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::LMMNormalDriftCalculator
CurveState: QuantLib::LMMCurveStateN/SN/S

Return value: double

qlCMSMMDriftCalculatorCompute

Full factor drift computation using the CMSMMDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CMSMMDriftCalculator
CurveState: QuantLib::CMSwapCurveStateN/SN/S

Return value: double

qlSMMDriftCalculatorCompute

Full factor drift computation using the SMMDriftCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SMMDriftCalculator
CurveState: QuantLib::CoterminalSwapCurveStateN/SN/S

Return value: double

qlEvolutionDescriptionRateTimes

rates fixing times for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: QuantLib::Time

qlEvolutionDescriptionRateTaus

rate taus for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: QuantLib::Time

qlEvolutionDescriptionEvolutionTimes

evolution times for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: QuantLib::Time

qlEvolutionDescriptionFirstAliveRate

first alive rate at each evolution time for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: QuantLib::Size

qlEvolutionDescriptionNumberOfRates

number of rates for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: long

qlEvolutionDescriptionNumberOfSteps

number of steps for the EvolutionDescription object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EvolutionDescription

Return value: long

qlExerciseDates

Returns all exercise dates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Exercise

Return value: QuantLib::Date

qlExerciseLastDate

Returns last exercise date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Exercise

Return value: QuantLib::Date

qlFRAforwardRate

Returns the relevant forward rate associated with the FRA term.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::ForwardRateAgreement

Return value: QuantLib::Rate

qlFRAforwardValue

Returns the forward value of the FRA.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::ForwardRateAgreement

Return value: double

qlFRAspotValue

Returns the spot value of the FRA.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::ForwardRateAgreement

Return value: double

ID of object to which this handle is linked - empty string if none.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Handle

Return value: string

qlHandleEmpty

True if handle is empty, False if not.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Handle

Return value: bool

qlRelinkableHandleLinkTo

Relink the RelinkableHandle to the given object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::RelinkableHandle
CurrentLink: stringN/SN/S

Return value: void

qlIndexName

Returns the name for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index

Return value: string

qlIndexFixingCalendar

Returns the calendar (e.g. TARGET) for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index

Return value: QuantLib::Calendar

qlIndexIsValidFixingDate

Returns TRUE if the fixing date is a valid one for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index
FixingDate: QuantLib::Date10-Feb-2007N/S

Return value: bool

qlIndexFixing

Returns the fixing for the given Index object. The fixing is retrieved from the time series if available, otherways it is forecasted.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index
FixingDate: QuantLib::Date02-Jan-2007N/S
ForecastToday: boolN/SFalse

Return value: QuantLib::Real

qlIndexAddFixings

Adds fixings for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Index
FixingDates: QuantLib::DateN/SN/S
FixingValues: QuantLib::RealN/SN/S
ForceOverwrite: boolN/SFalse

Return value: void

qlIndexAddFixings2

Adds fixings for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index
ForceOverwrite: boolN/SFalse
TimeSeriesID: QuantLib::TimeSeriesDefN/SN/S

Return value: void

qlIndexClearFixings

Clear all fixings for the given Index object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Index

Return value: void

qlInterestRateIndexFamilyName

Returns the family name (e.g. EURIBOR) for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex

Return value: string

qlInterestRateIndexTenor

Returns the tenor (i.e. length, e.g. 6M, 10Y) for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex

Return value: QuantLib::Period

qlInterestRateIndexFixingDays

Returns the fixing days (e.g. 2) for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex

Return value: QuantLib::Natural

qlInterestRateIndexCurrency

Returns the currency (e.g. EUR) for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex

Return value: QuantLib::Currency

qlInterestRateIndexDayCounter

Returns the DayCounter (e.g. Actual/360) for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex

Return value: QuantLib::DayCounter

qlInterestRateIndexValueDate

Returns the value date for the given fixing date for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex
FixingDate: QuantLib::Date02-Jan-2007N/S

Return value: QuantLib::Date

qlInterestRateIndexFixingDate

Returns the fixing date for the given value date for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex
ValueDate: QuantLib::Date02-Jan-2007N/S

Return value: QuantLib::Date

qlInterestRateIndexMaturity

Returns the maturity date for the given value date for the given InterestRateIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRateIndex
ValueDate: QuantLib::Date02-Jan-2007N/S

Return value: QuantLib::Date

qlIborIndexBusinessDayConv

Returns the business day convention (e.g. Modified Following) for the given IborIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::IborIndex

Return value: QuantLib::BusinessDayConvention

qlIborIndexEndOfMonth

Returns TRUE if the given IborIndex object follows the 'end of month' convention.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::IborIndex

Return value: bool

qlSwapIndexFixedLegTenor

Returns the fixed leg tenor (e.g. 1Y) for the given SwapIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwapIndex

Return value: QuantLib::Period

qlSwapIndexFixedLegBDC

Returns the business day convention (e.g. Modified Following) for the given SwapIndex object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwapIndex

Return value: QuantLib::BusinessDayConvention

qlInstrumentNPV

Returns the NPV for the given Instrument object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Instrument

Return value: double

qlInstrumentErrorEstimate

Returns the NPV error estimation (for e.g. Monte Carlo simulation) for the given Instrument object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Instrument

Return value: double

qlInstrumentValuationDate

Returns the date to which the net present value refers.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Instrument

Return value: QuantLib::Date

qlInstrumentResults

Returns the required result (if available) for the given Instrument object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Instrument
ResultType: stringvegaN/S

Return value: double

qlInstrumentIsExpired

Returns TRUE if the given Instrument object is expired.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Instrument

Return value: bool

qlInstrumentSetPricingEngine

Sets a new pricing engine to the given Instrument object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Instrument
PricingEngine: QuantLibAddin::PricingEnginePricingEngineIDN/S

Return value: void

qlExtrapolatorEnableExtrapolation

Sets the enable extrapolation flag to the given Extrapolator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Extrapolator
ExtrapolationFlag: boolN/SN/S

Return value: void

qlInterpolationInterpolate

Returns interpolated values using the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Interpolation
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
AllowExtrapolation: boolN/Sfalse

Return value: QuantLib::Real

qlInterpolationDerivative

Returns the first derivative function values using the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Interpolation
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
AllowExtrapolation: boolN/Sfalse

Return value: QuantLib::Real

qlInterpolationSecondDerivative

Returns the second derivative function values using the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Interpolation
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
AllowExtrapolation: boolN/Sfalse

Return value: QuantLib::Real

qlInterpolationPrimitive

Returns the primitive function values using the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Interpolation
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
AllowExtrapolation: boolN/Sfalse

Return value: QuantLib::Real

qlInterpolationIsInRange

Returns TRUE if the input value is in the allowed interpolation range for the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false

Return value: bool

qlInterpolationXmin

Returns the minimum value of the x array for the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation

Return value: QuantLib::Real

qlInterpolationXmax

Returns the maximum value of the x array for the given Interpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation

Return value: QuantLib::Real

qlCubicInterpolationPrimitiveConstants

Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CubicInterpolation

Return value: QuantLib::Real

qlCubicInterpolationACoefficients

Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CubicInterpolation

Return value: QuantLib::Real

qlCubicInterpolationBCoefficients

Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CubicInterpolation

Return value: QuantLib::Real

qlCubicInterpolationCCoefficients

Returns the constant terms in the primitive of the cubic interpolants for the given CubicSplineInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CubicInterpolation

Return value: QuantLib::Real

qlCubicInterpolationMonotonicityAdjustments

Returns a vector of bool (one per cubic) indicating if there has been a monotonicity adjustment.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::CubicInterpolation

Return value: bool

qlAbcdInterpolationA

Returns the a in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationB

Returns the b in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationC

Returns the c in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationD

Returns the d in the { y = (a + b*x) e^(-c*x) + d } fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationRmsError

Returns the error of the fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationMaxError

Returns the max error of the fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::Real

qlAbcdInterpolationEndCriteria

Returns the optimization end criteria of the fit for the given AbcdInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::AbcdInterpolation

Return value: QuantLib::EndCriteria::Type

qlSABRInterpolationExpiry

Returns the expiry time in years for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SABRInterpolation

Return value: QuantLib::Time

qlSABRInterpolationForward

Returns the forward for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationAlpha

Returns the alpha of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationBeta

Returns the alpha of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationNu

Returns the nu of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationRho

Returns the rho of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationRmsError

Returns the error of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationMaxError

Returns the max error of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlSABRInterpolationEndCriteria

Returns the optimization end criteria of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::EndCriteria::Type

qlSABRInterpolationWeights

Returns the weights of the fit for the given SABRInterpolation object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SABRInterpolation

Return value: QuantLib::Real

qlInterpolation2DXmin

Returns the minimum value of the x array for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DXmax

Returns the maximum value of the x array for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DXvalues

Returns the x array grid for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DYmin

Returns the minimum value of the y array for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DYmax

Returns the maximum value of the y array for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DYvalues

Returns the y array grid for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Real

qlInterpolation2DzData

Returns the z data matrix grid for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D

Return value: QuantLib::Matrix

qlInterpolation2DIsInRange

Returns TRUE if the (x,y) input value is in the allowed interpolation range for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D
XValues: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
YValue: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false

Return value: bool

qlInterpolation2DInterpolate

Returns interpolated values for the (x,y) input for the given Interpolation2D object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Interpolation2D
XValue: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
YValue: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0false
AllowExtrapolation: boolN/Sfalse

Return value: QuantLib::Real

qlGaussianLMDefaultCorrel

Default probability correlation.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::GaussianDefProbLM
CorrelationDate: QuantLib::DateN/SN/S
NameindexA: QuantLib::SizeN/SN/S
NameindexB: QuantLib::SizeN/SN/S

Return value: QuantLib::Real

qlGaussianLMAssetCorrel

Default probability correlation.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::GaussianDefProbLM
NameindexA: QuantLib::SizeN/SN/S
NameindexB: QuantLib::SizeN/SN/S

Return value: QuantLib::Real

qlGaussianLMProbNHits

Probability of having a given number of defaults or more.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::GaussianDefProbLM
NumDefaults: QuantLib::SizeN/SN/S
ProbabilityDate: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlTLMDefaultCorrel

Default probability correlation.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TDefProbLM
CorrelationDate: QuantLib::DateN/SN/S
NameindexA: QuantLib::SizeN/SN/S
NameindexB: QuantLib::SizeN/SN/S

Return value: QuantLib::Real

qlTLMAssetCorrel

Default probability correlation.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TDefProbLM
NameindexA: QuantLib::SizeN/SN/S
NameindexB: QuantLib::SizeN/SN/S

Return value: QuantLib::Real

qlTLMProbNHits

Probability of having a given number of defaults or more.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TDefProbLM
NumDefaults: QuantLib::SizeN/SN/S
ProbabilityDate: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlLegFlowAnalysis

Returns the flow analysis for the given Leg object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Leg
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlLegSetCouponPricers

Set the coupon pricer at the given Leg object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Leg
FloatingRateCouponPricer: QuantLibAddin::FloatingRateCouponPricerN/SN/S

Return value: void

qlInterestRateRate

Returns the rate in the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate

Return value: QuantLib::Rate

qlInterestRateDayCounter

Returns the DayCounter in the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate

Return value: QuantLib::DayCounter

qlInterestRateCompounding

Returns the Compounding in the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate

Return value: QuantLib::Compounding

qlInterestRateFrequency

Returns the Frequency in the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate

Return value: QuantLib::Frequency

qlInterestRateDiscountFactor

Returns the discount factor between two dates based on the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate
StartDate: QuantLib::Date40070N/S
EndDate: QuantLib::Date40100N/S
RefPeriodStart: QuantLib::DateN/SN/S
RefPeriodEnd: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlInterestRateCompoundFactor

Returns the compound factor between two dates based on the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate
StartDate: QuantLib::Date40070N/S
EndDate: QuantLib::Date40100N/S
RefPeriodStart: QuantLib::DateN/SN/S
RefPeriodEnd: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlInterestRateEquivalentRate

Returns the equivalent rate for a compounding period between two dates based on the given InterestRate object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::InterestRate
DayCounter: QuantLib::DayCounter"Actual/365 (Fixed)"N/S
Compounding: QuantLib::Compounding"Simple"False
Frequency: QuantLib::FrequencyN/SFalse
StartDate: QuantLib::Date40070N/S
EndDate: QuantLib::Date40100N/S
RefPeriodStart: QuantLib::DateN/SN/S
RefPeriodEnd: QuantLib::DateN/SN/S

Return value: QuantLib::Real

qlMarketModelEvolverStartNewPath

start a new path for the MarketModelEvolver object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelEvolver

Return value: double

qlMarketModelEvolverAdvanceStep

advance a single step in the current path for the MarketModelEvolver object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelEvolver

Return value: double

qlMarketModelEvolverCurrentStep

returns the current step index in the current path for the MarketModelEvolver object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelEvolver

Return value: QuantLib::Size

qlMarketModelEvolverNumeraires

returns the current step index in the current path for the MarketModelEvolver object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelEvolver

Return value: QuantLib::Size

qlMarketModelInitialRates

initial rates for the MarketModel object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel

Return value: QuantLib::Rate

qlMarketModelDisplacements

rates' displacemets for the MarketModel object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel

Return value: QuantLib::Spread

qlMarketModelNumberOfRates

number of rates for the MarketModel object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel

Return value: long

qlMarketModelNumberOfFactors

number of factors for the MarketModel object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel

Return value: long

qlMarketModelNumberOfSteps

number of steps for the MarketModel object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel

Return value: long

qlMarketModelPseudoRoot

Returns the pseudo root for the i-th step.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel
Index: QuantLib::Size0N/S

Return value: QuantLib::Matrix

qlMarketModelCovariance

Returns the covariance matrix for the i-th step.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel
Index: QuantLib::Size0N/S

Return value: QuantLib::Matrix

qlMarketModelTotalCovariance

Returns the covariance matrix from start up to the i-th step.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel
Index: QuantLib::Size0N/S

Return value: QuantLib::Matrix

qlMarketModelTimeDependentVolatility

Returns the time dependent vol for rate i.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModel
Index: QuantLib::Size0N/S

Return value: QuantLib::Volatility

qlSymmetricSchurDecompositionEigenvalues

Returns the eigenvalues for the given SymmetricSchurDecomposition object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SymmetricSchurDecomposition

Return value: QuantLib::Array

qlSymmetricSchurDecompositionEigenvectors

Returns the eigenvectors for the given SymmetricSchurDecomposition object. Eigenvectors are returned columnwise.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SymmetricSchurDecomposition

Return value: QuantLib::Matrix

qlCovarianceDecompositionVariances

Returns the variance vector for the given CovarianceDecomposition object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CovarianceDecomposition

Return value: QuantLib::Array

qlCovarianceDecompositionStandardDeviations

Returns the standard deviation (i.e. volatility times square root of time) vector for the given CovarianceDecomposition object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CovarianceDecomposition

Return value: QuantLib::Array

qlCovarianceDecompositionCorrelationMatrix

Returns the correlation matrix for the given CovarianceDecomposition object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::CovarianceDecomposition

Return value: QuantLib::Matrix

qlEndCriteriaMaxIterations

Returns the number of max interation for the given EndCriteria object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EndCriteria

Return value: QuantLib::Size

qlEndCriteriaMaxStationaryStateIterations

Returns the number of max interation in a stationary state for the given EndCriteria object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EndCriteria

Return value: QuantLib::Size

qlEndCriteriaFunctionEpsilon

Returns the function epsilon for the given EndCriteria object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EndCriteria

Return value: QuantLib::Real

qlEndCriteriaGradientNormEpsilon

Returns the gradient norm epsilon for the given EndCriteria object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::EndCriteria

Return value: QuantLib::Real

qlDelta

delta of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlDeltaForward

delta forward of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlElasticity

elasticity of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlGamma

gamma of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlTheta

theta of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlThetaPerDay

theta per day of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlVega

vega of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlRho

rho of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlDividendRho

dividend rho of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlItmCashProbability

itm cash probability of an option.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OneAssetOption

Return value: QuantLib::Real

qlOvernightIndexedSwapFixedLegBPS

returns the BPS of the fixed rate leg for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: double

qlOvernightIndexedSwapFixedLegNPV

returns the NPV of the fixed rate leg for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: double

qlOvernightIndexedSwapFairRate

returns the fair fixed leg rate which would zero the swap NPV for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::Rate

qlOvernightIndexedSwapOvernightLegBPS

returns the BPS of the overnight rate leg for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: double

qlOvernightIndexedSwapOvernightLegNPV

returns the NPV of the overnight rate leg for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: double

qlOvernightIndexedSwapFairSpread

returns the fair spread over the overnight rate which would zero the swap NPV for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::Spread

qlOvernightIndexedSwapType

returns the swap type (Payer or Receiver) of the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::OvernightIndexedSwap::Type

qlOvernightIndexedSwapNominal

returns the swap nominal for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: double

qlOvernightIndexedSwapFixedRate

returns the fixed rate for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::Rate

qlOvernightIndexedSwapFixedDayCount

returns the fixed rate day count convention for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::DayCounter

qlOvernightIndexedSwapSpread

returns the spread over overnight rate for the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::OvernightIndexedSwap

Return value: QuantLib::Spread

qlOvernightIndexedSwapFixedLegAnalysis

returns the fixed rate leg cash flow analysis of the given OvernightIndexedSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::OvernightIndexedSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlOvernightIndexedSwapOvernightLegAnalysis

returns the overnight rate leg cash flow analysis.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::OvernightIndexedSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlPayoffName

returns the type (e.g. Vanilla, CashOrNothing, etc.) for the given Payoff object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Payoff

Return value: string

qlPayoffDescription

returns the description (e.g. CashOrNothing, strike 32.2, cash payoff 2.5) for the given Payoff object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Payoff

Return value: string

qlPayoffValue

returns the payoff value given an underlying reference level for the given Payoff object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Payoff
Underlying: QuantLib::Real0.01N/S

Return value: double

qlPayoffOptionType

returns the option-type (e.g. Call, Put) for the given Payoff object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TypePayoff

Return value: QuantLib::Option::Type

qlPayoffStrike

returns the strike for the given Payoff object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::StrikedTypePayoff

Return value: QuantLib::Real

qlPayoffThirdParameter

returns the third parameter of a StrikedType payoff.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::StrikedTypePayoff

Return value: QuantLib::Real

qlPiecewiseYieldCurveTimes

Retrieve list of Times for the given PiecewiseYieldCurve<Traits, Interpolator>.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseYieldCurve

Return value: QuantLib::Time

qlPiecewiseYieldCurveDates

Retrieve list of Dates for the given PiecewiseYieldCurve<Traits, Interpolator>.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseYieldCurve

Return value: QuantLib::Date

qlPiecewiseYieldCurveData

Retrieve Data for the given PiecewiseYieldCurve<Traits, Interpolator>.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseYieldCurve

Return value: QuantLib::Real

qlPiecewiseYieldCurveJumpTimes

Retrieve list of jump times for the given PiecewiseYieldCurve<Traits, Interpolator>.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseYieldCurve

Return value: QuantLib::Time

qlPiecewiseYieldCurveJumpDates

Retrieve list of jump dates for the given PiecewiseYieldCurve<Traits, Interpolator>.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::PiecewiseYieldCurve

Return value: QuantLib::Date

qlBlackCalculatorValue

returns the option value for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorDeltaForward

returns the sensitivity to change in the underlying forward price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorDelta

returns the sensitivity to change in the underlying spot price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
Spot: QuantLib::RealN/SN/S

Return value: double

qlBlackCalculatorElasticityForward

returns the sensitivity in percent to a percent change in the underlying forward price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorElasticity

returns the sensitivity in percent to a percent change in the underlying spot price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
Spot: QuantLib::RealN/SN/S

Return value: double

qlBlackCalculatorGammaForward

returns the second order derivative with respect to change in the underlying forward price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorGamma

returns the second order derivative with respect to change in the underlying spot price for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
Spot: QuantLib::RealN/SN/S

Return value: double

qlBlackCalculatorTheta

returns the sensitivity to time to maturity for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
Spot: QuantLib::RealN/SN/S
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackCalculatorThetaPerDay

returns the sensitivity to time to maturity per day, assuming 365 days per year, for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
Spot: QuantLib::RealN/SN/S
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackCalculatorVega

returns the sensitivity to volatility for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackCalculatorRho

returns the sensitivity to discounting rate for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackCalculatorDividendRho

returns the sensitivity to dividend/growth rate for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackCalculatorItmCashProbability

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 nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorItmAssetProbability

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 nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorStrikeSensitivity

returns the sensitivity to strike for the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorAlpha

returns the alpha of the internal formulation of the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackCalculatorBeta

returns the beta of the internal formulation of the given BlackCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackCalculator

Return value: double

qlBlackScholesCalculatorDelta

returns the sensitivity to change in the underlying spot price for the given BlackScholesCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackScholesCalculator

Return value: double

qlBlackScholesCalculatorElasticity

returns the sensitivity in percent to a percent change in the underlying spot price for the given BlackScholesCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackScholesCalculator

Return value: double

qlBlackScholesCalculatorGamma

returns the second order derivative with respect to change in the underlying spot price for the given BlackScholesCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackScholesCalculator

Return value: double

qlBlackScholesCalculatorTheta

returns the sensitivity to time to maturity for the given BlackScholesCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackScholesCalculator
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlBlackScholesCalculatorThetaPerDay

returns the sensitivity to time to maturity per day, assuming 365 days per year, for the given BlackScholesCalculator object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackScholesCalculator
TimeToMaturity: QuantLib::TimeN/SN/S

Return value: double

qlMarketModelMultiProductCompositeAdd

Add new product to MarketModelComposite object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MultiProductComposite
Product: QuantLib::MarketModelMultiProductN/SN/S

Return value: void

qlMarketModelMultiProductCompositeFinalize

finalize the MarketModelComposite object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MultiProductComposite

Return value: void

qlMarketModelMultiProductSuggestedNumeraires

suggested Numeraires for the MarketModelMultiProduct object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelMultiProduct

Return value: QuantLib::Size

qlMarketModelMultiProductPossibleCashFlowTimes

possible cash flow times for the MarketModelMultiProduct object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelMultiProduct

Return value: QuantLib::Time

qlMarketModelMultiProductNumberOfProducts

number of products in the MarketModelMultiProduct object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelMultiProduct

Return value: long

qlMarketModelMultiProductMaxNumberOfCashFlowsPerProductPerStep

Max number of cashflows per product per step for the MarketModelMultiProduct object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::MarketModelMultiProduct

Return value: long

qlQuoteValue

Returns the current value of the given Quote object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Quote

Return value: QuantLib::Real

qlQuoteIsValid

Returns TRUE if the given Quote object has a valid value.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Quote

Return value: bool

qlSimpleQuoteReset

resets the given SimpleQuote object to the uninitialized state.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SimpleQuote

Return value: void

qlSimpleQuoteSetValue

sets a new value to the given SimpleQuote object and returns the difference with the previous value.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SimpleQuote
Value: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlSimpleQuoteSetTickValue

sets the tick value of the given SimpleQuote object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SimpleQuote
Value: QuantLib::Real0.0001N/S

Return value: void

qlSimpleQuoteTickValue

returns the tick value of the given SimpleQuote object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SimpleQuote

Return value: QuantLib::Real

qlFuturesConvAdjustmentQuoteVolatility

Return the value of HW volatility.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FuturesConvAdjustmentQuote

Return value: QuantLib::Real

qlFuturesConvAdjustmentQuoteMeanReversion

Return the value of HW mean reversion.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FuturesConvAdjustmentQuote

Return value: QuantLib::Real

qlFuturesConvAdjustmentQuoteImmDate

Return the IMM date of futures.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FuturesConvAdjustmentQuote

Return value: QuantLib::Date

qlFuturesConvAdjustmentQuoteFuturesValue

Return the value of futures underlying.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FuturesConvAdjustmentQuote

Return value: QuantLib::Real

qlLastFixingQuoteReferenceDate

Return the date of the last fixing

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::LastFixingQuote

Return value: QuantLib::Date

qlVariates

generate variates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::RandomSequenceGenerator
Samples: long5N/S

Return value: double

qlRangeAccrualFloatersCouponSetPricer

Set the coupon pricer at the given coupon object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon
RangeAccrualPricer: QuantLib::RangeAccrualPricerN/SN/S

Return value: void

qlRangeAccrualFloatersCouponObservationDates

Return the observation Dates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon

Return value: QuantLib::Date

qlRangeAccrualFloatersCouponStarDate

Return the accrual start Date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon

Return value: QuantLib::Date

qlRangeAccrualFloatersCouponEndDate

Return the accrual end Date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon

Return value: QuantLib::Date

qlRangeAccrualFloatersCouponObservationsNo

Return the observations number.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon

Return value: QuantLib::Size

qlRangeAccrualFloatersPrice

return the price of Range Accrual Floater Coupon.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon
YieldCurve: QuantLib::YieldTermStructureN/SN/S

Return value: double

qlSimpleFloaterPrice

return the price of Simple Floater Coupon.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RangeAccrualFloatersCoupon
YieldCurve: QuantLib::YieldTermStructureN/SN/S

Return value: double

qlRateHelperEarliestDate

returns the earliest date for the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: QuantLib::Date

qlRateHelperLatestRelevantDate

returns the latest relevant date for the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: QuantLib::Date

qlRateHelperPillarDate

returns the pillar date for the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: QuantLib::Date

qlRateHelperMaturityDate

returns the maturity date for the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: QuantLib::Date

qlRateHelperQuoteName

returns the objectID of the Quote wrapped in the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::RateHelper

Return value: string

qlRateHelperQuoteValue

returns the value of the Quote wrapped in the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: double

qlRateHelperQuoteIsValid

returns the isValid boolean of the Quote wrapped in the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: double

qlRateHelperImpliedQuote

returns the curve implied quote of the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: double

qlRateHelperQuoteError

returns the error between the curve implied quote and the value of the Quote wrapped in the given RateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::RateHelper

Return value: double

qlSwapRateHelperSpread

returns the spread for the given SwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwapRateHelper

Return value: QuantLib::Spread

qlSwapRateHelperForwardStart

returns the forward start period for the given SwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwapRateHelper

Return value: QuantLib::Period

qlFuturesRateHelperConvexityAdjustment

returns the convexity adjustment for the given FuturesRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FuturesRateHelper

Return value: QuantLib::Spread

qlFxSwapRateHelperSpotValue

returns the fx spot quote value for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: QuantLib::Real

qlFxSwapRateHelperTenor

returns the tenor for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: QuantLib::Period

qlFxSwapRateHelperFixingDays

returns the number of fixing days for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: QuantLib::Natural

qlFxSwapRateHelperCalendar

returns the calendar for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: QuantLib::Calendar

qlFxSwapRateHelperBDC

returns the business day convention for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: QuantLib::BusinessDayConvention

qlFxSwapRateHelperEOM

returns the end of month flag for the given FxSwapRateHelper object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: bool

qlFxSwapRateHelperIsBaseCurrencyCollateralCurrency

returns TRUE if the base currency of the fx currency pair is the one used as collateral, FALSE otherwise.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::FxSwapRateHelper

Return value: bool

qlScheduleSize

returns the number of dates in the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Size

qlSchedulePreviousDate

returns the highest date in the given Schedule object preceding the input reference date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule
RefDate: QuantLib::DateN/SN/S

Return value: QuantLib::Date

qlScheduleNextDate

returns the lowest date in the given Schedule object following the input reference date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule
RefDate: QuantLib::DateN/SN/S

Return value: QuantLib::Date

qlScheduleDates

returns the dates for the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Date

qlScheduleIsRegular

returns TRUE if the selected period in the given Schedule object is regular.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule
Index: QuantLib::Size1N/S

Return value: bool

qlScheduleEmpty

returns TRUE if the given Schedule object is empty.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: bool

qlScheduleCalendar

returns the Calendar used to calculate the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Calendar

qlScheduleStartDate

returns the start date of the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Date

qlScheduleEndDate

returns the end date of the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Date

qlScheduleTenor

returns the tenor used to calculate the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::Period

qlScheduleBDC

returns the business day convention used to calculate the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::BusinessDayConvention

qlScheduleTerminationDateBDC

returns the business day convention used to calculate the termination date of the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::BusinessDayConvention

qlScheduleRule

returns the DateGeneration::Rule of the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: QuantLib::DateGeneration::Rule

qlScheduleEndOfMonth

returns TRUE if end-of-month convention has been used to calculate the given Schedule object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Schedule

Return value: bool

qlSequenceStatisticsSamples

Returns the number of samples collected for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Size

qlSequenceStatisticsWeightSum

Returns the sum of data weights for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsMean

Returns the mean for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsVariance

Returns the variance for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsStandardDeviation

Returns the the standard deviation for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsDownsideVariance

Returns the variance of observations below zero for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsDownsideDeviation

Returns the square root of the downside variance for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsSemiVariance

Returns the variance of observations below the mean for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsSemiDeviation

Returns the square root of the semivariance for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsErrorEstimate

Returns the error estimate on the mean value for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsSkewness

Returns the skewness for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsKurtosis

Returns the excess kurtosis for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsMin

Returns the minimum sample value for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsMax

Returns the maximum sample value for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Real

qlSequenceStatisticsGaussianPercentile

Returns the x-th percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsPercentile

Returns the x-th percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsGaussianPotentialUpside

Returns the reciprocal of VAR at a given percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsPotentialUpside

Returns the reciprocal of VAR at a given percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Centile: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsGaussianValueAtRisk

Returns the value-at-risk at a given percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsValueAtRisk

Returns the value-at-risk at a given percentile for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsRegret

Returns the variance of observations below target for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsGaussianShortfall

Returns the probability of missing the given target for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsShortfall

Returns the probability of missing the given target for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsGaussianAverageShortfall

Returns the averaged shortfallness for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsAverageShortfall

Returns the averaged shortfallness for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSequenceStatisticsSize

Returns the size (sample dimensionality) for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Size

qlSequenceStatisticsCovariance

Returns the covariance Matrix for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Matrix

qlSequenceStatisticsCorrelation

Returns the correlation Matrix for the given SequenceStatistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SequenceStatistics

Return value: QuantLib::Matrix

qlVasicekA

returns mean reverting speed a, with dr(t) = a(b-r(t))dt + sigma dW(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Vasicek

Return value: QuantLib::Real

qlVasicekB

returns short-rate limit value b, with dr(t) = a(b-r(t))dt + sigma dW(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Vasicek

Return value: QuantLib::Real

qlVasicekLambda

returns the risk premium.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Vasicek

Return value: QuantLib::Real

qlVasicekSigma

returns the volatility sigma, with dr(t) = a(b-r(t))dt + sigma dW(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Vasicek

Return value: QuantLib::Real

qlModelG2A

returns the drift of x(t) dynamics with r(t) = x(t) + y(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2

Return value: QuantLib::Real

qlModelG2sigma

returns the volatility of x(t) dynamics with r(t) = x(t) + y(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2

Return value: QuantLib::Real

qlModelG2B

returns the drift of y(t) dynamics with r(t) = x(t) + y(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2

Return value: QuantLib::Real

qlModelG2eta

returns the volatility of y(t) dynamics with r(t) = x(t) + y(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2

Return value: QuantLib::Real

qlModelG2rho

returns the correlation between x(t) and y(t) with r(t) = x(t) + y(t).

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::G2

Return value: QuantLib::Real

qlSmileSectionVolatility

Returns the volatility at a given strike from the SmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SmileSection
Strike: QuantLib::RateN/SN/S

Return value: QuantLib::Volatility

qlSmileSectionVariance

Returns the variance at a given strike from the SmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SmileSection
Strike: QuantLib::RateN/SN/S

Return value: double

qlSmileSectionAtmLevel

Returns the current value of the SmileSection underlying.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SmileSection

Return value: double

qlSmileSectionExerciseDate

Returns the exercise date of the SmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SmileSection

Return value: QuantLib::Date

qlSmileSectionDayCounter

Returns the DayCounter of the SmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SmileSection

Return value: QuantLib::DayCounter

qlSabrInterpolatedSmileSectionAlpha

Returns the alpha of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionBeta

Returns the beta of the SABR fit.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionNu

Returns the nu of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionRho

Returns the rho of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionError

Returns the error of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionMaxError

Returns the max error of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: double

qlSabrInterpolatedSmileSectionEndCriteria

Returns the optimization end criteria of the SABR fit for the given SabrInterpolatedSmileSection object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrInterpolatedSmileSection

Return value: QuantLib::EndCriteria::Type

qlStatisticsSamples

Returns the number of samples collected for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Size

qlStatisticsWeightSum

Returns the sum of data weights for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsMean

Returns the mean for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsVariance

Returns the variance for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsStandardDeviation

Returns the the standard deviation for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsErrorEstimate

Returns the error estimate on the mean value for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsSkewness

Returns the skewness for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsKurtosis

Returns the excess kurtosis for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsMin

Returns the minimum sample value for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsMax

Returns the maximum sample value for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsPercentile

Returns the x-th percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsTopPercentile

Returns the x-th top percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianDownsideVariance

Returns the variance of observations below zero for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsGaussianDownsideDeviation

Returns the square root of the downside variance for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsGaussianRegret

Returns the variance of observations below the target for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianPercentile

Returns the x-th percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianTopPercentile

Returns the x-th top percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
X: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianPotentialUpside

Returns the reciprocal of VAR at a given percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianValueAtRisk

Returns the value-at-risk at a given percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianExpectedShortfall

Returns the expected loss in case that the loss exceeded a VaR threshold for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::RealN/SN/S

Return value: QuantLib::Real

qlStatisticsGaussianShortfall

Returns the probability of missing the given target for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsGaussianAverageShortfall

Returns the averaged shortfallness for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsSemiVariance

Returns the variance of observations below the mean for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsSemiDeviation

Returns the square root of the semivariance for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsDownsideVariance

Returns the variance of observations below zero for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsDownsideDeviation

Returns the square root of the downside variance for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics

Return value: QuantLib::Real

qlStatisticsRegret

Returns the variance of observations below target for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsPotentialUpside

Returns the reciprocal of VAR at a given percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Centile: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsValueAtRisk

Returns the value-at-risk at a given percentile for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsExpectedShortfall

Returns the expected loss in case that the loss exceeded a VaR threshold for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Centile: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsShortfall

Returns the probability of missing the given target for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlStatisticsAverageShortfall

Returns the averaged shortfallness for the given Statistics object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Statistics
Target: QuantLib::Real0.5N/S

Return value: QuantLib::Real

qlSwapLegBPS

returns the BPS of the i-th leg for the given Swap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swap
LegNumber: long1N/S

Return value: double

qlSwapLegNPV

returns the NPV of the i-th leg for the given Swap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swap
LegNumber: long1N/S

Return value: double

qlSwapStartDate

Returns the start (i.e. first accrual) date for the given Swap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swap

Return value: QuantLib::Date

qlSwapMaturityDate

Returns the maturity (i.e. last payment) date for the given Swap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swap

Return value: QuantLib::Date

qlSwapLegAnalysis

Returns the cash flow analysis of the i-th leg for the given Swap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::Swap
LegNumber: long1N/S
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlSwaptionType

returns the type (Payer or Receiver) for the given Swaption object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swaption

Return value: QuantLib::VanillaSwap::Type

qlSwaptionSettlementType

returns the settlement type (Cash or Delivery) for the given Swaption object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swaption

Return value: QuantLib::Settlement::Type

qlSwaptionImpliedVolatility

Returns the volatility implied by the given price for the given Swaption object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::Swaption
Price: QuantLib::Real0.2N/S
Guess: QuantLib::VolatilityN/SN/S
Accuracy: QuantLib::RealN/SN/S
MaxIter: QuantLib::NaturalN/SN/S
MinVol: QuantLib::VolatilityN/SN/S
MaxVol: QuantLib::VolatilityN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S

Return value: QuantLib::Volatility

qlSwaptionVTSVolatility

Returns volatility from the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
OptionDate: QuantLib::Date5yN/S
SwapTenor: QuantLib::Period2yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlSwaptionVTSVolatility2

Returns volatility from the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
OptionTenor: QuantLib::Period5yN/S
SwapTenor: QuantLib::Period2yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlSwaptionVTSBlackVariance

Returns variance from the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
OptionDate: QuantLib::Date5yN/S
SwapTenor: QuantLib::Period2yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: double

qlSwaptionVTSBlackVariance2

Returns variance from the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
OptionTenor: QuantLib::Period5yN/S
SwapTenor: QuantLib::Period2yN/S
Strike: QuantLib::Rate0.04False
AllowExtrapolation: boolN/SFalse

Return value: double

qlSwaptionVTSMaxSwapTenor

Returns the max swap tenor (i.e. length) for which the given SwaptionVolatilityStructure object can return vols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure

Return value: QuantLib::Period

qlSwaptionVTSBusinessDayConvention

Returns the business day convention used for option date calculation by the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure

Return value: QuantLib::BusinessDayConvention

qlSwaptionVTSOptionDateFromTenor

Returns the option date corresponding to a given option tenor, taking calendar and business day convention into account, for the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
OptionTenor: QuantLib::Period2yN/S

Return value: QuantLib::Date

qlSwaptionVTSSwapLength

Returns the swap length corresponding to a given swap tenor for the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
SwapTenor: QuantLib::Period2yN/S

Return value: QuantLib::Time

qlSwaptionVTSSwapLength2

Returns the swap length corresponding to a given swap start/end dates for the given SwaptionVolatilityStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityStructure
SwapStart: QuantLib::Date2yN/S
SwapEnd: QuantLib::Date2yN/S

Return value: QuantLib::Time

qlSwaptionVTSMatrixOptionDates

Returns the vector of swaption exercise dates for the given SwaptionVolatilityDiscrete object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityDiscrete

Return value: QuantLib::Date

qlSwaptionVTSMatrixOptionTenors

Returns the vector of swaption exercise tenors for the given SwaptionVolatilityDiscrete object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityDiscrete

Return value: QuantLib::Period

qlSwaptionVTSMatrixSwapTenors

Returns the vector of underlying swap tenors for the given SwaptionVolatilityDiscrete object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityDiscrete

Return value: QuantLib::Period

qlSwaptionVTSMatrixLocate

Returns the lower indexes of surrounding volatility matrix corners for the given SwaptionVolatilityMatrix object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SwaptionVolatilityMatrix
OptionDate: QuantLib::Date5yN/S
SwapTenor: QuantLib::Period2yN/S

Return value: long

qlSwaptionVTSatmStrike

Returns the at-the-money swaption strike, for a given exercise date and underlying swap length, for the given SwaptionVolatilityCube object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityCube
OptionDate: QuantLib::Date5yN/S
SwapTenor: QuantLib::Period2yN/S

Return value: QuantLib::Rate

qlSwaptionVTSatmStrike2

Returns the at-the-money swaption strike, for a given option tenor and underlying swap length, for the given SwaptionVolatilityCube object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SwaptionVolatilityCube
OptionTenor: QuantLib::Period5yN/S
SwapTenor: QuantLib::Period2yN/S

Return value: QuantLib::Rate

qlSparseSabrParameters

returns results of Sabr calibration for the given SwaptionVolCube1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SwaptionVolCube1

Return value: any

qlDenseSabrParameters

returns results of Sabr calibration for the given SwaptionVolCube1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SwaptionVolCube1

Return value: any

qlMarketVolCube

returns the market volatility cube for the given SwaptionVolCube1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SwaptionVolCube1

Return value: any

qlVolCubeAtmCalibrated

returns the volatility cube calibrated to ATM matrix for the given SwaptionVolCube1 object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SwaptionVolCube1

Return value: any

qlTermStructureDayCounter

Returns the DayCounter used by the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure

Return value: QuantLib::DayCounter

qlTermStructureMaxDate

Returns the max date for the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure

Return value: QuantLib::Date

qlTermStructureReferenceDate

Returns the reference date for the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure

Return value: QuantLib::Date

qlTermStructureTimeFromReference

Returns the time from the reference date for the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure
Date: QuantLib::Date1YN/S

Return value: QuantLib::Time

qlTermStructureCalendar

Returns the calendar used by the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure

Return value: QuantLib::Calendar

qlTermStructureSettlementDays

Returns the number of settlement days for the given TermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TermStructure

Return value: QuantLib::Natural

qlYieldTSDiscount

Returns a discount factor from the given YieldTermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::YieldTermStructure
DfDates: QuantLib::Date'1Y,2Y,3Y,4Y,5YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::DiscountFactor

qlYieldTSForwardRate

Returns the forward interest rate from the given YieldTermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::YieldTermStructure
D1: QuantLib::Date1MN/S
D2: QuantLib::Date'2M,3M,4M,5M,6MN/S
ResultDayCounter: QuantLib::DayCounterN/SN/S
Compounding: QuantLib::CompoundingN/SFalse
Frequency: QuantLib::FrequencyN/SFalse
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::InterestRate

qlYieldTSForwardRate2

Returns the forward interest rate from the given YieldTermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::YieldTermStructure
Date: QuantLib::Date'2M,3M,4M,5M,6MN/S
Period: QuantLib::Period1YN/S
ResultDayCounter: QuantLib::DayCounterN/SN/S
Compounding: QuantLib::CompoundingN/SFalse
Frequency: QuantLib::FrequencyN/SFalse
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::InterestRate

qlYieldTSZeroRate

Returns the zero interest rate from the given YieldTermStructure object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::YieldTermStructure
Dates: QuantLib::Date'2M,3M,4M,5M,6MN/S
ResultDayCounter: QuantLib::DayCounterN/SN/S
Compounding: QuantLib::CompoundingN/SFalse
Frequency: QuantLib::FrequencyN/SFalse
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::InterestRate

qlInterpolatedYieldCurveTimes

Retrieve list of Times for the given InterpolatedYieldCurve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::InterpolatedYieldCurve

Return value: QuantLib::Time

qlInterpolatedYieldCurveDates

Retrieve list of Dates for the given InterpolatedYieldCurve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::InterpolatedYieldCurve

Return value: QuantLib::Date

qlInterpolatedYieldCurveData

Retrieve Data for the given InterpolatedYieldCurve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::InterpolatedYieldCurve

Return value: QuantLib::Real

qlInterpolatedYieldCurveJumpTimes

Retrieve list of jump times for the given InterpolatedYieldCurve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::InterpolatedYieldCurve

Return value: QuantLib::Time

qlInterpolatedYieldCurveJumpDates

Retrieve list of jump dates for the given InterpolatedYieldCurve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::InterpolatedYieldCurve

Return value: QuantLib::Date

qlTimeSeriesFirstDate

Returns the first date for which a historical datum exists.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: QuantLib::Date

qlTimeSeriesLastDate

Returns the last date for which a historical datum exists.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: QuantLib::Date

qlTimeSeriesSize

Returns the size of the time series.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: QuantLib::Size

qlTimeSeriesEmpty

Returns whether the series contains any data.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: bool

qlTimeSeriesDates

Returns the dates for which historical data exist.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: QuantLib::Date

qlTimeSeriesValues

Returns the historical data.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::TimeSeriesDef

Return value: QuantLib::Real

qlTimeSeriesValue

Returns returns the data corresponding to the given dates.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::TimeSeriesDef
Dates: QuantLib::Date02-Jan-2007N/S

Return value: QuantLib::Real

qlVanillaSwapFixedLegBPS

returns the BPS of the fixed rate leg for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: double

qlVanillaSwapFixedLegNPV

returns the NPV of the fixed rate leg for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: double

qlVanillaSwapFairRate

returns the fair fixed leg rate which would zero the swap NPV for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::Rate

qlVanillaSwapFloatingLegBPS

returns the BPS of the floating rate leg for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: double

qlVanillaSwapFloatingLegNPV

returns the NPV of the floating rate leg for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: double

qlVanillaSwapFairSpread

returns the fair spread over the floating rate which would zero the swap NPV for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::Spread

qlVanillaSwapType

returns the swap type (Payer or Receiver) of the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::VanillaSwap::Type

qlVanillaSwapNominal

returns the swap nominal for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: double

qlVanillaSwapFixedRate

returns the fixed leg rate for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::Rate

qlVanillaSwapFixedDayCount

returns the fixed rate day count convention for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::DayCounter

qlVanillaSwapSpread

returns the spread over floating rate for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::Spread

qlVanillaSwapFloatingDayCount

returns the floating leg day count convention for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::DayCounter

qlVanillaSwapPaymentConvention

returns the payment business day convention for the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VanillaSwap

Return value: QuantLib::BusinessDayConvention

qlVanillaSwapFixedLegAnalysis

returns the fixed rate leg cash flow analysis of the given VanillaSwap object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::VanillaSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlVanillaSwapFloatingLegAnalysis

returns the floating rate leg cash flow analysis.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::VanillaSwap
AfterDate: QuantLib::DateN/SFalse

Return value: any

qlVolatilityTermStructureBusinessDayConvention

Returns the business day convention used in tenor to date conversion.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VolatilityTermStructure

Return value: QuantLib::BusinessDayConvention

qlVolatilityTermStructureOptionDateFromTenor

Returns the option date corrisponding to a given option tenor.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VolatilityTermStructure
Tenor: QuantLib::Period1YN/S

Return value: QuantLib::Date

qlVolatilityTermStructureMinStrike

Returns the minimum strike for which the given VolatilityTermStructure can return vols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VolatilityTermStructure

Return value: QuantLib::Rate

qlVolatilityTermStructureMaxStrike

Returns the maximum strike for which the given VolatilityTermStructure can return vols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::VolatilityTermStructure

Return value: QuantLib::Rate

qlBlackAtmVolCurveAtmVol

Returns the spot at-the-money (no-smile) volatility at a given option date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionDate: QuantLib::Date1YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackAtmVolCurveAtmVol2

Returns the spot at-the-money (no-smile) volatility at a given option tenor.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionTenor: QuantLib::Period1YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackAtmVolCurveAtmVol3

Returns the spot at-the-money (no-smile) volatility at a given option time.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionTime: QuantLib::Time1.0N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackAtmVolCurveAtmVariance

Returns the spot at-the-money (no-smile) variance at a given option date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionDate: QuantLib::Date1YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackAtmVolCurveAtmVariance2

Returns the spot at-the-money (no-smile) variance at a given option tenor.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionTenor: QuantLib::Period1YN/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackAtmVolCurveAtmVariance3

Returns the spot at-the-money (no-smile) variance at a given option time.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackAtmVolCurve
OptionTime: QuantLib::Time1.0N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackVolTermStructureBlackVol

Returns the black spot volatility at a given option date and strike.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackVolTermStructure
OptionDate: QuantLib::Date1YN/S
Strike: QuantLib::Real5%N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackVolTermStructureBlackVariance

Returns the black spot variance at a given option date and strike.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackVolTermStructure
OptionDate: QuantLib::Date1YN/S
Strike: QuantLib::Real5%N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Real

qlBlackVolTermStructureBlackForwardVol

Returns the black forward (at-the-money) volatility at a given option date and strike.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackVolTermStructure
ForwardDate: QuantLib::Date6MN/S
OptionDate: QuantLib::Date1YN/S
Strike: QuantLib::Real5%N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Volatility

qlBlackVolTermStructureBlackForwardVariance

Returns the black forward (at-the-money) variance at a given option date and strike.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::BlackVolTermStructure
ForwardDate: QuantLib::Date6MN/S
OptionDate: QuantLib::Date1YN/S
Strike: QuantLib::Real5%N/S
AllowExtrapolation: boolN/SFalse

Return value: QuantLib::Real

qlAbcdAtmVolCurveOptionTenors

Returns the options tenors of the atm volatility curve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Period

qlAbcdAtmVolCurveOptionTenorsInInterpolation

Returns the options tenors used in the fitting of the atm volatility curve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Period

qlAbcdAtmVolCurveOptionDates

Returns the options dates of the atm volatility curve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Date

qlAbcdAtmVolCurveOptionTimes

Returns the options times to maturity of the atm volatility curve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Time

qlAbcdAtmVolCurveRmsError

Returns the root mean squared error between the abcd implied Black vols and the given Black vols vector.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveMaxError

Returns the max error between the abcd implied Black vols and the given Black vols vector.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveA

Returns the a coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveB

Returns the b coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveC

Returns the c coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveD

Returns the d coefficient in the abcd vol parametrization.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveKatOptionTenors

Returns the k adjustments factors needed to match the input Black vols.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve

Return value: QuantLib::Real

qlAbcdAtmVolCurveK

Returns the k adjustments factors needed to match the input Black vols at a given time.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::AbcdAtmVolCurve
Time: QuantLib::Time1MN/S

Return value: QuantLib::Real

qlVolatilitySpreads

Returns the volatilities spread at a given date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrVolSurface
OptionDate: QuantLib::Date1YN/S

Return value: QuantLib::Volatility

qlVolatilitySpreads2

Returns the volatilities spread at a given date.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::SabrVolSurface
OptionTenor: QuantLib::Period1YN/S

Return value: QuantLib::Volatility

qlAtmCurve

Returns the Atm volatility curve.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLibAddin::SabrVolSurface

Return value: string

qlPiecewiseConstantVarianceVariances

Returns the piecewise constant variances.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance

Return value: double

qlPiecewiseConstantVarianceVolatilities

Returns the piecewise constant volatilities.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance

Return value: double

qlPiecewiseConstantVarianceRateTimes

Returns the rate time of the PiecewiseConstantVariance object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance

Return value: double

qlPiecewiseConstantVarianceVariance

Returns the piecewise constant variance at a given time index.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance
TimeIndex: QuantLib::Size0N/S

Return value: double

qlPiecewiseConstantVarianceVolatility

Returns the piecewise constant volatility at a given time index.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance
TimeIndex: QuantLib::Size0N/S

Return value: double

qlPiecewiseConstantVarianceTotalVariance

Returns the total variance at a given time index of the PiecewiseConstantVariance object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance
TimeIndex: QuantLib::Size0N/S

Return value: double

qlPiecewiseConstantVarianceTotalVolatility

Returns the total variance at a given time index of the PiecewiseConstantVariance object.

Parameter nameType (in C++)Example valueConst?
Input objectQuantLib::PiecewiseConstantVariance
TimeIndex: QuantLib::Size0N/S

Return value: double

qlAbcdFunction

Parameter nameType (in C++)Example valueConst?
A: doubleN/SN/S
B: doubleN/SN/S
C: doubleN/SN/S
D: doubleN/SN/S
Output objectAbcdFunction

qlAbcdCalibration

Parameter nameType (in C++)Example valueConst?
Times: QuantLib::Time0.01, 0.02, 0.03, 0.04 N/S
BlackVols: QuantLib::VolatilityN/SN/S
A: doubleN/SN/S
B: doubleN/SN/S
C: doubleN/SN/S
D: doubleN/SN/S
AIsFixed: boolN/SN/S
BIsFixed: boolN/SN/S
CIsFixed: boolN/SN/S
DIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Method: QuantLib::OptimizationMethodN/SN/S
Output objectAbcdCalibration

qlAccountingEngine

Parameter nameType (in C++)Example valueConst?
MarketModelEvolver: QuantLib::MarketModelEvolverN/SN/S
InitialNumeraireValue: doubleN/SN/S
Product: QuantLib::MarketModelMultiProductN/SN/S
Output objectAccountingEngine

qlAlphaFormInverseLinear

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Alpha: QuantLib::Real5N/S
Output objectAlphaFormInverseLinear

qlAlphaFormLinearHyperbolic

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Alpha: QuantLib::Real5N/S
Output objectAlphaFormLinearHyperbolic

qlAssetSwap

Parameter nameType (in C++)Example valueConst?
PayBondCoupon: boolN/SN/S
Bond: QuantLib::BondDE0003088704N/S
CleanPrice: double99.16N/S
IborIndex: QuantLib::IborIndexN/SN/S
Spread: QuantLib::SpreadN/SN/S
FloatingLegDayCounter: QuantLib::DayCounterActual/360N/S
ParAssetSwap: boolN/SN/S
FloatingLegSchedule: QuantLib::ScheduleN/SN/S
Output objectAssetSwap

qlAssetSwap2

Parameter nameType (in C++)Example valueConst?
ParAssetSwap: boolN/SN/S
Bond: QuantLib::BondDE0003088704N/S
CleanPrice: double99.16N/S
NonParRepayment: double101.0N/S
Gearing: doubleN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Spread: QuantLib::SpreadN/SN/S
FloatingLegDayCounter: QuantLib::DayCounterN/SN/S
DealMaturity: QuantLib::DateN/SN/S
PayBondCoupon: boolN/SN/S
Output objectAssetSwap

qlGaussianLHPLossmodel

Parameter nameType (in C++)Example valueConst?
Correlation: QuantLib::RealN/SN/S
RecoveryRates: doubleN/SN/S
Output objectGaussianLHPLossModel

qlIHGaussPoolLossModel

Parameter nameType (in C++)Example valueConst?
Correlation: QuantLib::RealN/SN/S
RecoveryRates: doubleN/SN/S
NumBuckets: QuantLib::SizeN/SN/S
Output objectIHGaussPoolLossModel

qlIHStudentPoolLossModel

Parameter nameType (in C++)Example valueConst?
Correlation: QuantLib::RealN/SN/S
RecoveryRates: doubleN/SN/S
Ttraits: doubleN/SN/S
NumBuckets: QuantLib::SizeN/SN/S
Output objectIHStudentPoolLossModel

qlGBinomialLossmodel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Output objectGaussianBinomialLossModel

qlTBinomialLossmodel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Ttraits: doubleN/SN/S
Output objectTBinomialLossModel

qlBaseCorrelationLossModel

could not parseQuantLib::CorrelationTermStructurelibraryClasslibraryTermStructurescalarBase correlation surface.

Parameter nameType (in C++)Example valueConst?
BaseModel: stringGLHP, GBINOMKR, TBINOMKR, INHOMN/S
Recoveries: QuantLib::RealN/SN/S
InitiTraits: QuantLib::RealN/SN/S
Output objectBaseCorrelationLossModel

qlGMCLossModel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
NumSimulations: QuantLib::SizeN/SN/S
Output objectGaussianRandomDefaultLM

qlGRandomRRMCLossModel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
ModelA: QuantLib::RealN/SN/S
NumSimulations: QuantLib::SizeN/SN/S
Output objectGaussianRandomLossLM

qlTMCLossModel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Ttraits: doubleN/SN/S
NumSimulations: QuantLib::SizeN/SN/S
Output objectTRandomDefaultLM

qlTRandomRRMCLossModel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Ttraits: doubleN/SN/S
ModelA: QuantLib::RealN/SN/S
NumSimulations: QuantLib::SizeN/SN/S
Output objectTRandomLossLM

qlGSaddlePointLossmodel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Output objectSaddlePointLossModel

qlTSaddlePointLossmodel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Ttraits: doubleN/SN/S
Output objectTSaddlePointLossModel

qlGRecursiveLossmodel

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
RecoveryRates: doubleN/SN/S
Output objectRecursiveGaussLossModel

qlFixedRateBond

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::Size3N/S
FaceAmount: QuantLib::RealN/SN/S
Coupons: QuantLib::Rate0.04N/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Redemption: QuantLib::RealN/SN/S
IssueDate: QuantLib::DateN/SN/S
PaymentCalendar: QuantLib::CalendarTARGETN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFixedRateBond

qlFixedRateBond2

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::Size3N/S
FaceAmount: QuantLib::RealN/SN/S
Coupons: QuantLib::InterestRateN/SN/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Redemption: QuantLib::RealN/SN/S
IssueDate: QuantLib::DateN/SN/S
PaymentCalendar: QuantLib::CalendarTARGETN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFixedRateBond

qlFloatingRateBond

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::Size3N/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
FaceAmount: QuantLib::RealN/SN/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Floors: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
Caps: QuantLib::RateN/SN/S
Redemption: QuantLib::RealN/SN/S
IssueDate: QuantLib::DateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFloatingRateBond

qlCmsRateBond

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::Size3N/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
FaceAmount: QuantLib::RealN/SN/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Floors: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
SwapIndex: QuantLib::SwapIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
Caps: QuantLib::RateN/SN/S
Redemption: QuantLib::RealN/SN/S
IssueDate: QuantLib::DateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectCmsRateBond

qlZeroCouponBond

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::Size3N/S
Calendar: QuantLib::CalendarTARGETN/S
FaceAmount: QuantLib::RealN/SN/S
Maturity: QuantLib::Date45348N/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Redemption: QuantLib::RealN/SN/S
IssueDate: QuantLib::DateN/SN/S
Output objectZeroCouponBond

qlBond

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
SettlementDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarN/SN/S
FaceAmount: QuantLib::RealN/SN/S
MaturityDate: QuantLib::DateN/SN/S
IssueDate: QuantLib::DateN/SN/S
LegID: QuantLib::LegN/SN/S
Output objectBond

qlMTBrownianGeneratorFactory

Parameter nameType (in C++)Example valueConst?
Seed: longN/SN/S
Output objectMTBrownianGeneratorFactory

qlCCTEU

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
MaturityDate: QuantLib::Date45678N/S
Spread: QuantLib::Spread0.80%N/S
StartDate: QuantLib::DateN/SN/S
IssueDate: QuantLib::DateN/SN/S
FwdCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectCCTEU

qlBTP

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
MaturityDate: QuantLib::Date45678N/S
Coupon: QuantLib::Rate0.04N/S
StartDate: QuantLib::DateN/SN/S
IssueDate: QuantLib::DateN/SN/S
Output objectBTP

qlBTP2

Construct an object of class BTP and return its id, allowing for non-100 redemption.

Parameter nameType (in C++)Example valueConst?
Description: stringN/SN/S
MaturityDate: QuantLib::Date45678N/S
Coupon: QuantLib::Rate0.04N/S
Redemption: QuantLib::RealN/SN/S
StartDate: QuantLib::DateN/SN/S
IssueDate: QuantLib::DateN/SN/S
Output objectBTP

qlRendistatoBasket

Parameter nameType (in C++)Example valueConst?
BTPs: QuantLib::BTPN/SN/S
Outstandings: QuantLib::RealN/SN/S
Prices: QuantLib::QuoteN/SN/S
Output objectRendistatoBasket

qlRendistatoCalculator

Parameter nameType (in C++)Example valueConst?
RendistatoBasket: QuantLib::RendistatoBasketN/SN/S
Euribor: QuantLib::EuriborN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectRendistatoCalculator

qlRendistatoEquivalentSwapLengthQuote

Parameter nameType (in C++)Example valueConst?
RendistatoCalculator: QuantLib::RendistatoCalculatorN/SN/S
Output objectRendistatoEquivalentSwapLengthQuote

qlRendistatoEquivalentSwapSpreadQuote

Parameter nameType (in C++)Example valueConst?
RendistatoCalculator: QuantLib::RendistatoCalculatorN/SN/S
Output objectRendistatoEquivalentSwapSpreadQuote

qlSwaptionHelper

Parameter nameType (in C++)Example valueConst?
OptionTenor: QuantLib::Period5YN/S
Length: QuantLib::Period5YN/S
IborIndex: QuantLib::IborIndexN/SN/S
FixedLegTenor: QuantLib::PeriodN/SN/S
FixedLegDayCounter: QuantLib::DayCounterN/SN/S
FloatingLegDayCounter: QuantLib::DayCounterN/SN/S
Volatility: QuantLib::QuoteN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectSwaptionHelper

qlCapFloor

Parameter nameType (in C++)Example valueConst?
OptionType: QuantLib::CapFloor::TypeN/SN/S
Strikes: QuantLib::Rate.04N/S
LegID: QuantLib::LegN/SN/S
Output objectCapFloor

qlMakeCapFloor

Parameter nameType (in C++)Example valueConst?
OptionType: QuantLib::CapFloor::TypeCapN/S
Length: QuantLib::Period10YN/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
Strike: QuantLib::RateN/SN/S
ForwardStart: QuantLib::PeriodN/SN/S
PricingEngineID: QuantLib::PricingEngineCapFloorEngineIDN/S
Output objectCapFloor

qlRelinkableHandleOptionletVolatilityStructure

Parameter nameType (in C++)Example valueConst?
CurrentLink: stringN/SN/S
Output objectRelinkableHandleImpl<QuantLibAddin::OptionletVolatilityStructure, QuantLib::OptionletVolatilityStructure>

qlConstantOptionletVolatility

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
BusinessDayConvention: QuantLib::BusinessDayConvention"Following"N/S
DayCounter: QuantLib::DayCounterN/SN/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
Volatility: QuantLib::QuoteN/SN/S
Output objectConstantOptionletVolatility

qlSpreadedOptionletVolatility

Parameter nameType (in C++)Example valueConst?
BaseVolStructure: QuantLib::OptionletVolatilityStructureN/SN/S
Spread: QuantLib::Quote0.01N/S
Output objectSpreadedOptionletVolatility

qlStrippedOptionletAdapter

Parameter nameType (in C++)Example valueConst?
StrippedOptionletBase: QuantLib::StrippedOptionletBaseN/SN/S
Output objectStrippedOptionletAdapter

qlStrippedOptionlet

Parameter nameType (in C++)Example valueConst?
SettlementDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
BusinessDayConvention: QuantLib::BusinessDayConvention"Following"N/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
OptionletDates: QuantLib::Date5Y, 10YN/S
Strikes: QuantLib::Rate0.03, 0.04, 0.05N/S
DayCounter: QuantLib::DayCounterN/SN/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
Volatilities: QuantLib::QuoteN/SN/S
Output objectStrippedOptionlet

qlOptionletStripper1

Parameter nameType (in C++)Example valueConst?
IborIndex: QuantLib::IborIndexN/SN/S
SwitchStrike: QuantLib::RateN/SN/S
Accuracy: QuantLib::RealN/SN/S
MaxIter: QuantLib::NaturalN/SN/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
TermVolSurface: QuantLib::CapFloorTermVolSurfaceN/SN/S
Output objectOptionletStripper1

qlOptionletStripper2

Parameter nameType (in C++)Example valueConst?
OptionletStripper1: QuantLib::OptionletStripper1N/SN/S
TermVolCurve: QuantLib::CapFloorTermVolCurveN/SN/S
Output objectOptionletStripper2

qlCapFloorTermVolCurve

Parameter nameType (in C++)Example valueConst?
SettlementDays: QuantLib::Size0N/S
Calendar: QuantLib::CalendarTARGETN/S
BusinessDayConvention: QuantLib::BusinessDayConvention"Following"N/S
OptionTenors: QuantLib::Period3Y, 5Y, 7Y, 10YN/S
DayCounter: QuantLib::DayCounterN/SN/S
Volatilities: QuantLib::Quote0.30, 0.27, 0.25, 0.21N/S
Output objectCapFloorTermVolCurve

qlCapFloorTermVolSurface

Parameter nameType (in C++)Example valueConst?
SettlementDays: QuantLib::Size0N/S
Calendar: QuantLib::CalendarTARGETN/S
BusinessDayConvention: QuantLib::BusinessDayConvention"Following"N/S
OptionTenors: QuantLib::Period5Y, 10YN/S
Strikes: QuantLib::RateN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Volatilities: QuantLib::QuoteN/SN/S
Output objectCapFloorTermVolSurface

qlCmsMarket

Parameter nameType (in C++)Example valueConst?
SwapLengths: QuantLib::Period2Y,5Y,10Y,20Y,30YN/S
SwapIndexes: QuantLib::SwapIndexEuriborSwapIsdaFixA2Y,EuriborSwapIsdaFixA5Y,EuriborSwapIsdaFixA10Y,EuriborSwapIsdaFixA20Y,EuriborSwapIsdaFixA30YN/S
IborIndex: QuantLib::IborIndexEuribor3MN/S
CmsCouponPricers: QuantLib::CmsCouponPricerN/SN/S
BidAskSpreads: QuantLib::QuoteN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectCmsMarket

qlCmsMarketCalibration

Parameter nameType (in C++)Example valueConst?
CmsMarket: QuantLib::CmsMarketN/SN/S
Weights: QuantLib::MatrixN/SN/S
CalibrationType: QuantLib::CmsMarketCalibration::CalibrationTypeN/SN/S
VolCube: QuantLib::SwaptionVolatilityStructureN/SN/S
Output objectCmsMarketCalibration

qlMarketModelLmLinearExponentialCorrelationModel

Parameter nameType (in C++)Example valueConst?
Size: long4N/S
Rho: double0.5N/S
Beta: double.6N/S
Factors: longN/SN/S
Output objectLmLinearExponentialCorrelationModel

qlHistoricalForwardRatesAnalysis

Parameter nameType (in C++)Example valueConst?
StartDate: QuantLib::Date37413N/S
EndDate: QuantLib::Date39248N/S
Step: QuantLib::Period1DN/S
IborIndex: QuantLib::IborIndexN/SN/S
InitialGap: QuantLib::Period3MN/S
Horizon: QuantLib::Period30YN/S
IborIndexes: QuantLib::IborIndexN/SN/S
SwapIndexes: QuantLib::SwapIndexN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
TraitsID: stringN/SN/S
InterpolatorID: stringN/SN/S
BootstrapAccuracy: QuantLib::RealN/SN/S
SequenceStats: QuantLib::SequenceStatisticsN/SN/S
Output objectHistoricalForwardRatesAnalysis

qlHistoricalRatesAnalysis

Parameter nameType (in C++)Example valueConst?
StartDate: QuantLib::Date37413N/S
EndDate: QuantLib::Date39248N/S
Step: QuantLib::Period1DN/S
InterestRateIndexes: QuantLib::InterestRateIndexN/SN/S
SequenceStats: QuantLib::SequenceStatisticsN/SN/S
Output objectHistoricalRatesAnalysis

qlTimeHomogeneousForwardCorrelation

Parameter nameType (in C++)Example valueConst?
FwdCorrMatrix: QuantLib::MatrixN/SN/S
RateTimes: QuantLib::TimeN/SN/S
Output objectTimeHomogeneousForwardCorrelation

qlExponentialForwardCorrelation

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::TimeN/SN/S
LongTermCorr: QuantLib::Real0.5N/S
Beta: QuantLib::Real0.2N/S
Gamma: QuantLib::Real0.9N/S
Times: QuantLib::TimeN/SN/S
Output objectExponentialForwardCorrelation

qlCotSwapFromFwdCorrelation

Parameter nameType (in C++)Example valueConst?
Displacement: QuantLib::SpreadN/SN/S
FwdCorr: QuantLib::PiecewiseConstantCorrelationPiecewiseConstantCorrelationIDN/S
CurveState: QuantLib::CurveStateCurveStateIDN/S
Output objectCotSwapFromFwdCorrelation

qlFixedRateLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
Coupons: QuantLib::Rate0.04N/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFixedRateLeg

qlFixedRateLeg2

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
Coupons: QuantLib::InterestRateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFixedRateLeg

qlIborLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Floors: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
Caps: QuantLib::RateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectIborLeg

qlDigitalIborLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Gearings: doubleN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
CallStrikes: QuantLib::RateN/SN/S
CallSpecs: stringN/SN/S
CallPayoff: QuantLib::RateN/SN/S
PutStrikes: QuantLib::RateN/SN/S
PutSpecs: stringN/SN/S
PutPayoff: QuantLib::RateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Replication: QuantLib::DigitalReplicationN/SN/S
Output objectDigitalIborLeg

qlCmsLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Floors: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
SwapIndex: QuantLib::SwapIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
Caps: QuantLib::RateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectCmsLeg

qlDigitalCmsLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Gearings: doubleN/SN/S
SwapIndex: QuantLib::SwapIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
CallStrikes: QuantLib::RateN/SN/S
CallSpecs: stringN/SN/S
CallPayoff: QuantLib::RateN/SN/S
PutStrikes: QuantLib::RateN/SN/S
PutSpecs: stringN/SN/S
PutPayoff: QuantLib::RateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Replication: QuantLib::DigitalReplicationN/SN/S
Output objectDigitalCmsLeg

qlRangeAccrualLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
LowerStrikes: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
UpperStrikes: QuantLib::RateN/SN/S
ObservationsTenor: QuantLib::Period1dN/S
ObservationsBDC: QuantLib::BusinessDayConventionN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectRangeAccrualLeg

qlCmsZeroLeg

Parameter nameType (in C++)Example valueConst?
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Nominals: double1000000N/S
FixingDays: QuantLib::NaturalN/SN/S
IsInArrears: boolN/SN/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
Floors: QuantLib::RateN/SN/S
Gearings: doubleN/SN/S
SwapIndex: QuantLib::SwapIndexN/SN/S
Spreads: QuantLib::SpreadN/SN/S
Caps: QuantLib::RateN/SN/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectCmsZeroLeg

qlIborCouponPricer

Parameter nameType (in C++)Example valueConst?
IborCouponPricerType: stringIborByBlackN/S
Volatility: QuantLib::OptionletVolatilityStructureEURCapletVolN/S
Output objectIborCouponPricer

qlCmsCouponPricer

Parameter nameType (in C++)Example valueConst?
CmsCouponPricerType: stringConundrumByNumericalIntegrationN/S
YieldCurveModel: QuantLib::GFunctionFactory::YieldCurveModelN/SN/S
Volatility: QuantLib::SwaptionVolatilityStructureEURSwaptionVolN/S
MeanReversion: QuantLib::Quote0.1N/S
Output objectCmsCouponPricer

qlConundrumPricerByNumericalIntegration

Parameter nameType (in C++)Example valueConst?
YieldCurveModel: QuantLib::GFunctionFactory::YieldCurveModelN/SN/S
LowerLimit: QuantLib::RealN/SN/S
UpperLimit: QuantLib::RealN/SN/S
Precision: QuantLib::RealN/SN/S
SwaptionVol: QuantLib::SwaptionVolatilityStructureN/SN/S
MeanReversion: QuantLib::QuoteN/SN/S
Output objectNumericHaganPricer

qlDigitalReplication

Parameter nameType (in C++)Example valueConst?
Replication: QuantLib::Replication::TypeN/SN/S
Gap: QuantLib::RealN/SN/S
Output objectDigitalReplication

qlCreditDefaultSwap

Parameter nameType (in C++)Example valueConst?
BuyerSeller: QuantLib::Protection::SideN/SN/S
Notional: QuantLib::RealN/SN/S
Upfront: QuantLib::RateN/SN/S
Spread: QuantLib::RateN/SN/S
PaymentConvention: QuantLib::BusinessDayConventionN/SN/S
DayCounter: QuantLib::DayCounterActual/360N/S
SettlesAccrual: boolN/SFalse
PayAtDefault: boolN/SFalse
ProtectionStart: QuantLib::DateN/SN/S
UpfrontDate: QuantLib::DateN/SN/S
PremiumSchedule: QuantLib::ScheduleN/SN/S
Output objectCreditDefaultSwap

qlMidPointCdsEngine

Parameter nameType (in C++)Example valueConst?
RecoveryRate: QuantLib::RealN/SN/S
DefaultCurve: QuantLib::DefaultProbabilityTermStructureN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectMidPointCdsEngine

qlHazardRateCurve

Creates a backward flat interpolated hazard rate curve.

Parameter nameType (in C++)Example valueConst?
CurveDates: QuantLib::Date'2M,3M,4M,5M,6MN/S
CurveRates: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectHazardRateCurve

qlSpreadCdsHelper

Parameter nameType (in C++)Example valueConst?
Tenor: QuantLib::Period10YN/S
SettlementDays: QuantLib::NaturalN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
Frequency: QuantLib::FrequencyAnnualN/S
PaymentConvention: QuantLib::BusinessDayConventionModifiedFollowingN/S
GenRule: QuantLib::DateGeneration::RuleBackwardN/S
DayCounter: QuantLib::DayCounter30/360 (Bond Basis)N/S
RecoveryRate: QuantLib::RealN/SN/S
SettleAccrual: boolN/SFalse
PayAtDefault: boolN/SFalse
RunningSpread: QuantLib::Quote0.042322N/S
DiscountingCurve: QuantLib::YieldTermStructureN/SN/S
Output objectSpreadCdsHelper

qlUpfrontCdsHelper

Parameter nameType (in C++)Example valueConst?
RunningSpread: QuantLib::Rate0.042322N/S
Tenor: QuantLib::Period10YN/S
SettlementDays: QuantLib::NaturalN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
Frequency: QuantLib::FrequencyAnnualN/S
PaymentConvention: QuantLib::BusinessDayConventionModifiedFollowingN/S
GenRule: QuantLib::DateGeneration::RuleBackwardN/S
DayCounter: QuantLib::DayCounter30/360 (Bond Basis)N/S
RecRate: QuantLib::RealN/SN/S
UpfSettlDays: QuantLib::NaturalN/SN/S
SettlAccr: boolN/SFalse
PayAtDefault: boolN/SFalse
UpfrontSpread: QuantLib::Quote0.042322N/S
DiscCurve: QuantLib::YieldTermStructureN/SN/S
Output objectUpfrontCdsHelper

qlPiecewiseHazardRateCurve

Parameter nameType (in C++)Example valueConst?
Helpers: QuantLib::DefaultProbabilityHelperCDS1Y, CDS5Y, CDS10YN/S
DayCounter: QuantLib::DayCounterN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
Interpolation: stringLINEAR, BACKWARDFLATN/S
Accuracy: QuantLib::RealN/SN/S
Output objectPiecewiseHazardRateCurve

qlPiecewiseFlatForwardCurve

Parameter nameType (in C++)Example valueConst?
ReferenceDate: QuantLib::DateN/SN/S
RateHelpers: QuantLib::RateHelperEUROND,EURTND,EURSND,EURSWD,EUR2WDN/S
DayCounter: QuantLib::DayCounterN/SN/S
Accuracy: QuantLib::RealN/SN/S
Output objectPiecewiseFlatForwardCurve

qlRiskyFixedBond

Parameter nameType (in C++)Example valueConst?
Bondname: stringN/SN/S
Currency: QuantLib::CurrencyN/SN/S
Recovery: doubleN/SN/S
Rate: QuantLib::RateN/SN/S
DayCounter: QuantLib::DayCounterActual/360N/S
PaymentConvention: QuantLib::BusinessDayConventionN/SN/S
Notional: doubleN/SN/S
PricingDate: QuantLib::DateN/SN/S
DefaultCurve: QuantLib::DefaultProbabilityTermStructureN/SN/S
Schedule: QuantLib::ScheduleN/SN/S
DiscountingCurve: QuantLib::YieldTermStructureN/SN/S
Output objectRiskyFixedBond

qlIssuer

could not parseQuantLib::DefaultProbabilityTermStructurelibraryClasslibraryTermStructurescalarDefault probability curve. By now it is associated to SeniorSec, EUR and NorthAmericaCorpDefaultKey

Parameter nameType (in C++)Example valueConst?
DefaultEvents: QuantLib::DefaultEventSetN/SN/S
Output objectIssuer

qlDefaultEvent

Parameter nameType (in C++)Example valueConst?
EventType: stringFailureToPayEvent, BankruptcyEventN/S
EventDate: QuantLib::DateN/SN/S
Currency: QuantLib::CurrencyN/SN/S
Seniority: QuantLib::SenioritySeniorSecN/S
SettlementDate: QuantLib::DateN/SN/S
SettledRecovery: doubleN/SN/S
Output objectDefaultEventSet

qlSyntheticCDO

Parameter nameType (in C++)Example valueConst?
Basket: QuantLib::BasketN/SN/S
BuyerSeller: QuantLib::Protection::SideN/SN/S
Upfront: QuantLib::RateN/SN/S
Spread: QuantLib::RateN/SN/S
DayCounter: QuantLib::DayCounterActual/360N/S
PaymentConvention: QuantLib::BusinessDayConventionN/SN/S
PremiumSchedule: QuantLib::ScheduleN/SN/S
Output objectSyntheticCDO

qlMidPointCDOEngine

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectMidPointCDOEngine

qlNthToDefault

Parameter nameType (in C++)Example valueConst?
Basket: QuantLib::BasketN/SN/S
Order: QuantLib::SizeN/SN/S
BuyerSeller: QuantLib::Protection::SideN/SN/S
Upfront: QuantLib::RateN/SN/S
Spread: QuantLib::RateN/SN/S
DayCounter: QuantLib::DayCounterActual/360N/S
Notional: QuantLib::RealN/SN/S
SettlesAccrual: boolN/SN/S
PremiumSchedule: QuantLib::ScheduleN/SN/S
Output objectNthToDefault

qlIntegralNtdEngine

Parameter nameType (in C++)Example valueConst?
IntegrationStep: QuantLib::Period3MN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectIntegralNtdEngine

qlBlackCdsOptionEngine

Parameter nameType (in C++)Example valueConst?
RecoveryRate: QuantLib::RealN/SN/S
DefaultCurve: QuantLib::DefaultProbabilityTermStructureN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
BlackVol: QuantLib::QuoteN/SN/S
Output objectBlackCdsOptionEngine

qlCDSOption

Parameter nameType (in C++)Example valueConst?
UnderlyingCDS: QuantLib::CreditDefaultSwapN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectCdsOption

qlBaseCorrelationTermStructure

Parameter nameType (in C++)Example valueConst?
InterpolatorType: stringBILIN, BICUBICN/S
SettlementDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarN/SN/S
Convention: QuantLib::BusinessDayConventionModifiedFollowingN/S
Tenors: QuantLib::PeriodN/SN/S
LossLevel: QuantLib::RealN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Correlations: QuantLib::QuoteN/SN/S
Output objectBaseCorrelationTermStructure

qlCTSMMCapletOriginalCalibration

Parameter nameType (in C++)Example valueConst?
SwapPiecewiseConstantVariances: QuantLib::PiecewiseConstantVarianceN/SN/S
CapletVols: QuantLib::Volatility0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1N/S
Displacement: QuantLib::VolatilityN/SN/S
Alphas: QuantLib::Real0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01N/S
LowestRoot: boolN/SN/S
UseFullApprox: boolTRUEN/S
Evolution: QuantLib::EvolutionDescriptionEvolutionDescriptionIDN/S
Correlations: QuantLib::PiecewiseConstantCorrelationN/SN/S
CurveState: QuantLib::CurveStateCurveStateIDN/S
Output objectCTSMMCapletOriginalCalibration

qlCTSMMCapletAlphaFormCalibration

Parameter nameType (in C++)Example valueConst?
SwapPiecewiseConstantVariances: QuantLib::PiecewiseConstantVarianceN/SN/S
CapletVols: QuantLib::Volatility0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1N/S
Displacement: QuantLib::VolatilityN/SN/S
AlphaInitial: QuantLib::Real0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01,0.01N/S
AlphaMax: QuantLib::RealN/SN/S
AlphaMin: QuantLib::RealN/SN/S
MaximizeHomogeneity: boolN/SN/S
AlphaForm: QuantLib::AlphaFormAlphaFormIDN/S
Evolution: QuantLib::EvolutionDescriptionEvolutionDescriptionIDN/S
Correlations: QuantLib::PiecewiseConstantCorrelationN/SN/S
CurveState: QuantLib::CurveStateCurveStateIDN/S
Output objectCTSMMCapletAlphaFormCalibration

qlCTSMMCapletMaxHomogeneityCalibration

Parameter nameType (in C++)Example valueConst?
SwapPiecewiseConstantVariances: QuantLib::PiecewiseConstantVarianceN/SN/S
CapletVols: QuantLib::Volatility0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1,0.1N/S
Displacement: QuantLib::VolatilityN/SN/S
Caplet0Swaption1Priority: QuantLib::RealN/SN/S
Evolution: QuantLib::EvolutionDescriptionEvolutionDescriptionIDN/S
Correlations: QuantLib::PiecewiseConstantCorrelationN/SN/S
CurveState: QuantLib::CurveStateCurveStateIDN/S
Output objectCTSMMCapletMaxHomogeneityCalibration

qlCMSwapCurveState

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
SpanningForwards: QuantLib::Size5N/S
Output objectCMSwapCurveState

qlCoterminalSwapCurveState

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Output objectCoterminalSwapCurveState

qlLMMCurveState

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Output objectLMMCurveState

qlCreditBasket

Parameter nameType (in C++)Example valueConst?
IssuerNames: stringN/SN/S
Issuers: QuantLib::IssuerN/SN/S
Notionals: doubleN/SN/S
ReferenceDate: QuantLib::DateN/SN/S
AttachmentRatio: doubleN/SN/S
DettachmentRatio: doubleN/SN/S
Amortizing: boolN/SN/S
Output objectBasket

qlRelinkableHandleDefaultProbabilityTermStructure

Parameter nameType (in C++)Example valueConst?
CurrentLink: stringN/SN/S
Output objectRelinkableHandleImpl<QuantLibAddin::DefaultProbabilityTermStructure, QuantLib::DefaultProbabilityTermStructure>

qlFlatHazardRate

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Rate: QuantLib::Quote0.044N/S
Output objectFlatHazardRate

qlLMMDriftCalculator

Parameter nameType (in C++)Example valueConst?
Pseudo_square_root: QuantLib::MatrixN/SN/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
Taus: QuantLib::Time0.5,0.5,0.5,0.5,0.5N/S
Numeraire: QuantLib::Size5N/S
Alive: QuantLib::Size1N/S
Output objectLMMDriftCalculator

qlLMMNormalDriftCalculator

Parameter nameType (in C++)Example valueConst?
Pseudo_square_root: QuantLib::MatrixN/SN/S
Taus: QuantLib::Time0.5,0.5,0.5,0.5,0.5N/S
Numeraire: QuantLib::Size5N/S
Alive: QuantLib::Size1N/S
Output objectLMMNormalDriftCalculator

qlCMSMMDriftCalculator

Parameter nameType (in C++)Example valueConst?
Pseudo_square_root: QuantLib::MatrixN/SN/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
Taus: QuantLib::Time0.5,0.5,0.5,0.5,0.5N/S
Numeraire: QuantLib::Size5N/S
Alive: QuantLib::Size1N/S
SpanningFwds: QuantLib::Size5N/S
Output objectCMSMMDriftCalculator

qlSMMDriftCalculator

Parameter nameType (in C++)Example valueConst?
Pseudo_square_root: QuantLib::MatrixN/SN/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
Taus: QuantLib::Time0.5,0.5,0.5,0.5,0.5N/S
Numeraire: QuantLib::Size5N/S
Alive: QuantLib::Size1N/S
Output objectSMMDriftCalculator

qlEvolutionDescription

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
EvolutionTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Output objectEvolutionDescription

qlEvolutionDescriptionFromProduct

Parameter nameType (in C++)Example valueConst?
Product: QuantLib::MarketModelMultiProductN/SN/S
Output objectEvolutionDescription

qlAmericanExercise

Parameter nameType (in C++)Example valueConst?
EarliestDate: QuantLib::Date1YN/S
LatestDate: QuantLib::Date2YN/S
PayoffAtExpiry: boolN/SN/S
Output objectAmericanExercise

qlEuropeanExercise

Parameter nameType (in C++)Example valueConst?
ExpiryDate: QuantLib::Date1YN/S
Output objectEuropeanExercise

qlBermudanExercise

Parameter nameType (in C++)Example valueConst?
Dates: QuantLib::Date'1Y,2YN/S
PayoffAtExpiry: boolN/SN/S
Output objectBermudanExercise

qlFRA

Parameter nameType (in C++)Example valueConst?
ValueDate: QuantLib::Date3MN/S
MaturityDate: QuantLib::Date6MN/S
Position: QuantLib::Position::TypeLongN/S
Strike: QuantLib::Rate0.02N/S
Notional: double1000000N/S
IborIndex: QuantLib::IborIndexN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectForwardRateAgreement

qlIborIndex

Parameter nameType (in C++)Example valueConst?
FamilyName: stringEuriborN/S
Tenor: QuantLib::Period6MN/S
FixingDays: QuantLib::Natural2N/S
Currency: QuantLib::CurrencyEURN/S
Calendar: QuantLib::CalendarTARGETN/S
BDayConvention: QuantLib::BusinessDayConventionModified FollowingN/S
EndOfMonth: boolTRUEN/S
DayCounter: QuantLib::DayCounterActual/360N/S
FwdCurve: QuantLib::YieldTermStructureEURYC6MN/S
Output objectIborIndex

qlOvernightIndex

Parameter nameType (in C++)Example valueConst?
FamilyName: stringEoniaN/S
FixingDays: QuantLib::Natural0N/S
Currency: QuantLib::CurrencyEURN/S
Calendar: QuantLib::CalendarTARGETN/S
DayCounter: QuantLib::DayCounterActual/360N/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectOvernightIndex

qlEuribor

Parameter nameType (in C++)Example valueConst?
Tenor: string6MN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectEuribor

qlEuribor365

Parameter nameType (in C++)Example valueConst?
Tenor: string6MN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectEuribor365

qlEonia

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectEonia

qlLibor

Parameter nameType (in C++)Example valueConst?
Currency: QuantLib::CurrencyN/SN/S
Tenor: string6MN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectLibor

qlSonia

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectSonia

qlSwapIndex

Parameter nameType (in C++)Example valueConst?
FamilyName: stringEuriborSwapIsdaFixA10YN/S
Tenor: QuantLib::Period10YN/S
FixingDays: QuantLib::Natural2N/S
Currency: QuantLib::CurrencyEURN/S
Calendar: QuantLib::CalendarTARGETN/S
FixedLegTenor: QuantLib::Period1YN/S
FixedLegBDC: QuantLib::BusinessDayConventionUnadjustedN/S
FixedLegDayCounter: QuantLib::DayCounter30/360 (Bond Basis)N/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
DiscCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectSwapIndex

qlEuriborSwap

Parameter nameType (in C++)Example valueConst?
FixingType: QuantLibAddin::SwapIndex::FixingTypeN/SN/S
Tenor: QuantLib::Period10YN/S
FwdCurve: QuantLib::YieldTermStructureEURYC6MN/S
DiscCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectEuriborSwap

qlLiborSwap

Parameter nameType (in C++)Example valueConst?
Currency: QuantLib::CurrencyN/SN/S
FixingType: QuantLibAddin::SwapIndex::FixingTypeN/SN/S
Tenor: QuantLib::Period10YN/S
FwdCurve: QuantLib::YieldTermStructureEURYC6MN/S
DiscCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectLiborSwap

qlEuriborSwapIsdaFixA

Parameter nameType (in C++)Example valueConst?
Tenor: QuantLib::Period10YN/S
FwdCurve: QuantLib::YieldTermStructureEURYC6MN/S
DiscCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectEuriborSwapIsdaFixA

qlBMAIndex

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureUSDYCN/S
Output objectBMAIndex

qlProxyIbor

Parameter nameType (in C++)Example valueConst?
FamilyName: stringEuriborN/S
Tenor: QuantLib::Period6MN/S
FixingDays: QuantLib::Natural2N/S
Currency: QuantLib::CurrencyEURN/S
Calendar: QuantLib::CalendarTARGETN/S
BDayConvention: QuantLib::BusinessDayConventionModified FollowingN/S
EndOfMonth: boolTRUEN/S
DayCounter: QuantLib::DayCounterActual/360N/S
IborIndex: QuantLib::IborIndexN/SN/S
Gearing: QuantLib::Quote1.0N/S
Spread: QuantLib::Quote0.005N/S
Output objectProxyIbor

qlInterpolation

Parameter nameType (in C++)Example valueConst?
InterpolationType: stringN/SN/S
XArray: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0N/S
YArray: QuantLib::Quote2.0,4.0,6.0,8.0,10.0,12.0N/S
Output objectGenericInterp

qlMixedLinearCubicInterpolation

Parameter nameType (in C++)Example valueConst?
XArray: QuantLib::Real1.0,2.0,3.0,4.0,5.0N/S
SwitchIndex: QuantLib::SizeN/SN/S
DerApprox: QuantLib::CubicInterpolation::DerivativeApproxN/SN/S
Monotonic: boolN/SN/S
LeftConditionType: QuantLib::CubicInterpolation::BoundaryConditionN/SN/S
LeftConditionValue: QuantLib::RealN/SN/S
RightConditionType: QuantLib::CubicInterpolation::BoundaryConditionN/SN/S
RightConditionValue: QuantLib::RealN/SN/S
YArray: QuantLib::Quote1.0,8.0,27.0,64.0,125.0N/S
Output objectMixedLinearCubicInterpolation

qlCubicInterpolation

Parameter nameType (in C++)Example valueConst?
XArray: QuantLib::Real1.0,2.0,3.0,4.0,5.0N/S
DerApprox: QuantLib::CubicInterpolation::DerivativeApproxN/SN/S
Monotonic: boolN/SN/S
LeftConditionType: QuantLib::CubicInterpolation::BoundaryConditionN/SN/S
LeftConditionValue: QuantLib::RealN/SN/S
RightConditionType: QuantLib::CubicInterpolation::BoundaryConditionN/SN/S
RightConditionValue: QuantLib::RealN/SN/S
YArray: QuantLib::Quote1.0,8.0,27.0,64.0,125.0N/S
Output objectCubicInterpolation

qlAbcdInterpolation

Parameter nameType (in C++)Example valueConst?
XArray: QuantLib::Real0.0300,0.0400,0.0500,0.0700N/S
A: QuantLib::RealN/SN/S
B: QuantLib::RealN/SN/S
C: QuantLib::RealN/SN/S
D: QuantLib::RealN/SN/S
AIsFixed: boolN/SN/S
BIsFixed: boolN/SN/S
CIsFixed: boolN/SN/S
DIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
OptimizationMeth: QuantLib::OptimizationMethodN/SN/S
YArray: QuantLib::Quote0.0850,0.0733,0.0844,0.1082N/S
Output objectAbcdInterpolation

qlSABRInterpolation

Parameter nameType (in C++)Example valueConst?
XArray: QuantLib::Real0.0300,0.0400,0.0500,0.0700N/S
Expiry: QuantLib::Time1.0N/S
Alpha: QuantLib::RealN/SN/S
Beta: QuantLib::RealN/SN/S
Nu: QuantLib::RealN/SN/S
Rho: QuantLib::RealN/SN/S
AlphaIsFixed: boolN/SN/S
BetaIsFixed: boolN/SN/S
NuIsFixed: boolN/SN/S
RhoIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
OptimizationMeth: QuantLib::OptimizationMethodN/SN/S
YArray: QuantLib::Quote0.0850,0.0733,0.0844,0.1082N/S
Forward: QuantLib::Quote0.039N/S
Output objectSABRInterpolation

qlInterpolation2D

Parameter nameType (in C++)Example valueConst?
InterpolationType: stringN/SN/S
XArray: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0N/S
YArray: QuantLib::Real1.0,2.0,3.0,4.0,5.0,6.0N/S
ZMatrix: QuantLib::MatrixN/SN/S
Output objectInterpolation2D

qlGaussianDefaultProbLM

Parameter nameType (in C++)Example valueConst?
Factors: doubleN/SN/S
Basket: QuantLib::BasketN/SN/S
Output objectGaussianDefProbLM

qlTDefaultProbLM

Parameter nameType (in C++)Example valueConst?
Torders: QuantLib::IntegerN/SN/S
Factors: doubleN/SN/S
Basket: QuantLib::BasketN/SN/S
Output objectTDefProbLM

qlLeg

Parameter nameType (in C++)Example valueConst?
Amounts: double1000000.0,500000.0N/S
Dates: QuantLib::Date40238,40330N/S
ToBeSorted: boolN/SN/S
Output objectLeg

qlLegFromCapFloor

Parameter nameType (in C++)Example valueConst?
CapFloor: QuantLib::CapFloorN/SN/S
Output objectLeg

qlLegFromSwap

Parameter nameType (in C++)Example valueConst?
Swap: QuantLib::SwapN/SN/S
LegNumber: long1N/S
Output objectLeg

qlMultiPhaseLeg

Parameter nameType (in C++)Example valueConst?
LegIDs: QuantLibAddin::LegN/SN/S
ToBeSorted: boolN/SN/S
Output objectMultiPhaseLeg

qlInterestRate

Parameter nameType (in C++)Example valueConst?
Rate: QuantLib::Rate0.04N/S
DayCounter: QuantLib::DayCounter"Actual/365 (Fixed)"N/S
Compounding: QuantLib::Compounding"Simple"False
Frequency: QuantLib::FrequencyN/SFalse
Output objectInterestRate

qlForwardRatePc

Parameter nameType (in C++)Example valueConst?
BrownianGeneratorFactory: QuantLib::BrownianGeneratorFactoryN/SN/S
Numeraires: QuantLib::Size5,5,5,5,5N/S
MarketModel: QuantLib::MarketModelN/SN/S
Output objectLogNormalFwdRatePc

qlForwardRateIpc

Parameter nameType (in C++)Example valueConst?
BrownianGeneratorFactory: QuantLib::BrownianGeneratorFactoryN/SN/S
Numeraires: QuantLib::Size5,5,5,5,5N/S
MarketModel: QuantLib::MarketModelN/SN/S
Output objectLogNormalFwdRateIpc

qlForwardRateNormalPc

Parameter nameType (in C++)Example valueConst?
BrownianGeneratorFactory: QuantLib::BrownianGeneratorFactoryN/SN/S
Numeraires: QuantLib::Size5,5,5,5,5N/S
MarketModel: QuantLib::MarketModelN/SN/S
Output objectNormalFwdRatePc

qlFlatVol

Parameter nameType (in C++)Example valueConst?
Volatilities: QuantLib::Volatility0.2,0.2,0.2,0.2,0.2N/S
Factors: long5N/S
InitialRates: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
Correlations: QuantLib::PiecewiseConstantCorrelationN/SN/S
EvolutionDescription: QuantLib::EvolutionDescriptionN/SN/S
Output objectFlatVol

qlAbcdVol

Parameter nameType (in C++)Example valueConst?
A: double-0.06N/S
B: double0.17N/S
C: double0.54N/S
D: double0.17N/S
Ks: double1.0,1.0,1.0,1.0,1.0N/S
Factors: long5N/S
InitialRates: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
Correlations: QuantLib::PiecewiseConstantCorrelationN/SN/S
EvolutionDescription: QuantLib::EvolutionDescriptionN/SN/S
Output objectAbcdVol

qlPseudoRootFacade

Parameter nameType (in C++)Example valueConst?
Calibrator: QuantLib::CTSMMCapletCalibrationN/SN/S
Output objectPseudoRootFacade

qlCotSwapToFwdAdapter

Parameter nameType (in C++)Example valueConst?
CoterminalModel: QuantLib::MarketModelN/SN/S
Output objectCotSwapToFwdAdapter

qlFwdPeriodAdapter

Parameter nameType (in C++)Example valueConst?
Period: QuantLib::Size2N/S
Offset: QuantLib::Size0N/S
Displacements: QuantLib::Spread0.0,0.0,0.0,0.0,0.0N/S
LargeModel: QuantLib::MarketModelN/SN/S
Output objectFwdPeriodAdapter

qlFwdToCotSwapAdapter

Parameter nameType (in C++)Example valueConst?
ForwardModel: QuantLib::MarketModelN/SN/S
Output objectFwdToCotSwapAdapter

qlFlatVolFactory

Parameter nameType (in C++)Example valueConst?
LongTermCorr: double0.5N/S
Beta: double0.2N/S
Times: QuantLib::Time0.1,0.2,0.3,0.4,0.5N/S
Volatilities: QuantLib::Volatility0.2,0.2,0.2,0.2,0.2N/S
Displacement: QuantLib::SpreadN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectFlatVolFactory

qlSymmetricSchurDecomposition

Parameter nameType (in C++)Example valueConst?
SymmetricMatrix: QuantLib::MatrixN/SN/S
Output objectSymmetricSchurDecomposition

qlCovarianceDecomposition

Parameter nameType (in C++)Example valueConst?
SymmetricMatrix: QuantLib::MatrixN/SN/S
Tolerance: doubleN/SN/S
Output objectCovarianceDecomposition

qlEndCriteria

Parameter nameType (in C++)Example valueConst?
MaxIterations: long1000N/S
MaxStationaryStateIterations: long100N/S
RootEpsilon: double1e-8N/S
FunctionEpsilon: double1e-8N/S
GradientNormEpsilon: double1e-8N/S
Output objectEndCriteria

qlNoConstraint

Parameter nameType (in C++)Example valueConst?
Output objectNoConstraint

qlSimplex

Parameter nameType (in C++)Example valueConst?
Lambda: double0.01N/S
Output objectSimplex

qlLevenbergMarquardt

Parameter nameType (in C++)Example valueConst?
Epsfcn: doubleN/SN/S
Xtol: doubleN/SN/S
Gtol: doubleN/SN/S
Output objectLevenbergMarquardt

qlConjugateGradient

Parameter nameType (in C++)Example valueConst?
LineSearch: QuantLib::LineSearchN/SN/S
Output objectConjugateGradient

qlSteepestDescent

Parameter nameType (in C++)Example valueConst?
LineSearch: QuantLib::LineSearchN/SN/S
Output objectSteepestDescent

qlArmijoLineSearch

Parameter nameType (in C++)Example valueConst?
Epsilon: doubleN/SN/S
Alpha: doubleN/SN/S
Beta: doubleN/SN/S
Output objectArmijoLineSearch

qlBarrierOption

Parameter nameType (in C++)Example valueConst?
BarrierType: QuantLib::Barrier::TypeN/SN/S
Barrier: QuantLib::Real1.0N/S
Rebate: QuantLib::Real1.0N/S
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectBarrierOption

qlCaAsianOption

Parameter nameType (in C++)Example valueConst?
AverageType: QuantLib::Average::TypeN/SN/S
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectContinuousAveragingAsianOption

qlDaAsianOption

Parameter nameType (in C++)Example valueConst?
AverageType: QuantLib::Average::TypeN/SN/S
RunningAccumulator: QuantLib::Real1.0N/S
PastFixings: QuantLib::Size3N/S
FixingDates: QuantLib::Date1Y,2YN/S
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectDiscreteAveragingAsianOption

qlDividendVanillaOption

Parameter nameType (in C++)Example valueConst?
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
DividendDates: QuantLib::Date1Y,2YN/S
Dividends: QuantLib::Real0.01,0.01N/S
Output objectDividendVanillaOption

qlForwardVanillaOption

Parameter nameType (in C++)Example valueConst?
Moneyness: QuantLib::Real1.0N/S
ResetDate: QuantLib::Date1YN/S
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectForwardVanillaOption

qlVanillaOption

Parameter nameType (in C++)Example valueConst?
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectVanillaOption

qlEuropeanOption

Parameter nameType (in C++)Example valueConst?
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectEuropeanOption

qlQuantoVanillaOption

Parameter nameType (in C++)Example valueConst?
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectQuantoVanillaOption

qlQuantoForwardVanillaOption

Parameter nameType (in C++)Example valueConst?
Moneyness: QuantLib::Real1.0N/S
ResetDate: QuantLib::Date1YN/S
Payoff: QuantLib::StrikedTypePayoffN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
Output objectQuantoForwardVanillaOption

qlOvernightIndexedSwap

Parameter nameType (in C++)Example valueConst?
PayerReceiver: QuantLib::OvernightIndexedSwap::TypeN/SN/S
Nominal: QuantLib::RealN/SN/S
FixedRate: QuantLib::RateN/SN/S
FixDayCounter: QuantLib::DayCounterActual/360N/S
OvernightIndex: QuantLib::OvernightIndexN/SN/S
Spread: QuantLib::SpreadN/SN/S
Schedule: QuantLib::ScheduleOisScheduleN/S
Output objectOvernightIndexedSwap

qlMakeOIS

Parameter nameType (in C++)Example valueConst?
SettlDays: QuantLib::NaturalN/SN/S
SwapTenor: QuantLib::Period5YN/S
OvernightIndex: QuantLib::OvernightIndexEoniaN/S
FixedRate: QuantLib::RateN/SN/S
ForwardStart: QuantLib::Period"0D"N/S
FixDayCounter: QuantLib::DayCounterN/SN/S
Spread: QuantLib::SpreadN/SN/S
Output objectOvernightIndexedSwap

qlMakeDatedOIS

Parameter nameType (in C++)Example valueConst?
StartDate: QuantLib::DateN/SN/S
EndDate: QuantLib::DateN/SN/S
OvernightIndex: QuantLib::OvernightIndexEoniaN/S
FixedRate: QuantLib::RateN/SN/S
FixDayCounter: QuantLib::DayCounterN/SN/S
Spread: QuantLib::SpreadN/SN/S
Output objectOvernightIndexedSwap

qlOvernightIndexedSwapFromOISRateHelper

Parameter nameType (in C++)Example valueConst?
OISRateHelper: QuantLib::OISRateHelperN/SN/S
Output objectOvernightIndexedSwap

qlStrikedTypePayoff

Parameter nameType (in C++)Example valueConst?
PayoffID: stringN/SN/S
OptionType: QuantLib::Option::TypeCallN/S
Strike: QuantLib::Real100.0N/S
ThirdParameter: doubleN/SN/S
Output objectStrikedTypePayoff

qlDoubleStickyRatchetPayoff

Parameter nameType (in C++)Example valueConst?
Type1: QuantLib::Real-1.0N/S
Type2: QuantLib::Real-1.0N/S
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Gearing3: QuantLib::Real1.2N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
Spread3: QuantLib::Real0.003N/S
InitialValue1: QuantLib::Real0.02N/S
InitialValue2: QuantLib::Real0.03N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectDoubleStickyRatchetPayoff

qlRatchetPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
InitialValue: QuantLib::Real0.02N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectRatchetPayoff

qlStickyPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
InitialValue: QuantLib::Real0.02N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectStickyPayoff

qlRatchetMaxPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Gearing3: QuantLib::Real1.2N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
Spread3: QuantLib::Real0.003N/S
InitialValue1: QuantLib::Real0.02N/S
InitialValue2: QuantLib::Real0.03N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectRatchetMaxPayoff

qlRatchetMinPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Gearing3: QuantLib::Real1.2N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
Spread3: QuantLib::Real0.003N/S
InitialValue1: QuantLib::Real0.02N/S
InitialValue2: QuantLib::Real0.03N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectRatchetMinPayoff

qlStickyMaxPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Gearing3: QuantLib::Real1.2N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
Spread3: QuantLib::Real0.003N/S
InitialValue1: QuantLib::Real0.02N/S
InitialValue2: QuantLib::Real0.03N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectStickyMaxPayoff

qlStickyMinPayoff

Parameter nameType (in C++)Example valueConst?
Gearing1: QuantLib::Real1.0N/S
Gearing2: QuantLib::Real1.1N/S
Gearing3: QuantLib::Real1.2N/S
Spread1: QuantLib::Real0.001N/S
Spread2: QuantLib::Real0.002N/S
Spread3: QuantLib::Real0.003N/S
InitialValue1: QuantLib::Real0.02N/S
InitialValue2: QuantLib::Real0.03N/S
AccrualFactor: QuantLib::Real0.5N/S
Output objectStickyMinPayoff

qlPiecewiseYieldCurve

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::NaturalN/SN/S
Calendar: QuantLib::CalendarN/SN/S
RateHelpers: QuantLib::RateHelperEUROND,EURTND,EURSND,EURSWD,EUR2WDN/S
DayCounter: QuantLib::DayCounterN/SN/S
JumpDates: QuantLib::Date1YN/S
Accuracy: QuantLib::RealN/SN/S
TraitsID: stringN/SN/S
InterpolatorID: stringN/SN/S
Jumps: QuantLib::Quote1.0N/S
Output objectPiecewiseYieldCurve

qlPiecewiseYieldCurveMixedInterpolation

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::NaturalN/SN/S
Calendar: QuantLib::CalendarN/SN/S
RateHelpers: QuantLib::RateHelperEUROND,EURTND,EURSND,EURSWD,EUR2WDN/S
DayCounter: QuantLib::DayCounterN/SN/S
JumpDates: QuantLib::Date1YN/S
Accuracy: QuantLib::RealN/SN/S
TraitsID: stringN/SN/S
InterpolatorID: stringN/SN/S
MixedInterpolationBehavior: QuantLib::MixedInterpolation::BehaviorN/SN/S
PillarsBeforeChange: QuantLib::Size3N/S
Jumps: QuantLib::Quote1.0N/S
Output objectPiecewiseYieldCurve

qlBlackCalculator2

Parameter nameType (in C++)Example valueConst?
PayoffID: QuantLib::StrikedTypePayoffN/SN/S
AtmForwardValue: QuantLib::Real100.0N/S
StdDev: QuantLib::Real0.20N/S
Deflator: QuantLib::RealN/SN/S
Output objectBlackCalculator

qlBlackCalculator

Parameter nameType (in C++)Example valueConst?
OptionType: QuantLib::Option::TypeN/SN/S
Strike: QuantLib::Real100.0N/S
AtmForwardValue: QuantLib::Real100.0N/S
StdDev: QuantLib::Real0.20N/S
Deflator: QuantLib::RealN/SN/S
Output objectBlackCalculator

qlBlackScholesCalculator2

Parameter nameType (in C++)Example valueConst?
PayoffID: QuantLib::StrikedTypePayoffN/SN/S
Spot: QuantLib::Real100.0N/S
Growth: QuantLib::DiscountFactorN/SN/S
StdDev: QuantLib::Real0.20N/S
Deflator: QuantLib::RealN/SN/S
Output objectBlackScholesCalculator

qlBlackScholesCalculator

Parameter nameType (in C++)Example valueConst?
OptionType: QuantLib::Option::TypeN/SN/S
Strike: QuantLib::Real100.0N/S
Spot: QuantLib::Real100.0N/S
Growth: QuantLib::DiscountFactorN/SN/S
StdDev: QuantLib::Real0.20N/S
Deflator: QuantLib::RealN/SN/S
Output objectBlackScholesCalculator

qlPricingEngine

Parameter nameType (in C++)Example valueConst?
EngineID: stringN/SN/S
ProcessID: QuantLib::GeneralizedBlackScholesProcessN/SN/S
Output objectPricingEngine

qlDiscountingSwapEngine

Parameter nameType (in C++)Example valueConst?
IncludeSettlDate: boolN/SFalse
SettlementDate: QuantLib::DateN/SFalse
NpvDate: QuantLib::DateN/SFalse
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectDiscountingSwapEngine

qlBinomialPricingEngine

Parameter nameType (in C++)Example valueConst?
EngineID: stringN/SN/S
TimeSteps: longN/SN/S
ProcessID: QuantLib::GeneralizedBlackScholesProcessN/SN/S
Output objectPricingEngine

qlBlackSwaptionEngine

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureN/SN/S
VolTS: QuantLib::SwaptionVolatilityStructureN/SN/S
Output objectBlackSwaptionEngine

qlBlackSwaptionEngine2

Parameter nameType (in C++)Example valueConst?
Displacement: QuantLib::RealN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Vol: QuantLib::QuoteN/SN/S
Output objectBlackSwaptionEngine

qlBlackCapFloorEngine

Parameter nameType (in C++)Example valueConst?
Displacement: QuantLib::RealN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
VolTS: QuantLib::OptionletVolatilityStructureEUROptionlet6MN/S
Output objectBlackCapFloorEngine

qlBlackCapFloorEngine2

Parameter nameType (in C++)Example valueConst?
Displacement: QuantLib::RealN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Vol: QuantLib::QuoteN/SN/S
Output objectBlackCapFloorEngine

qlBachelierCapFloorEngine

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
VolTS: QuantLib::OptionletVolatilityStructureEUROptionlet6MN/S
Output objectBachelierCapFloorEngine

qlBachelierCapFloorEngine2

Parameter nameType (in C++)Example valueConst?
DayCounter: QuantLib::DayCounterN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Vol: QuantLib::QuoteN/SN/S
Output objectBachelierCapFloorEngine

qlAnalyticCapFloorEngine

Parameter nameType (in C++)Example valueConst?
HandleModel: QuantLib::AffineModelN/SN/S
Output objectAnalyticCapFloorEngine

qlBondEngine

Parameter nameType (in C++)Example valueConst?
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectBondEngine

qlJamshidianSwaptionEngine

Parameter nameType (in C++)Example valueConst?
Model: QuantLib::OneFactorAffineModelN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectJamshidianSwaptionEngine

qlTreeSwaptionEngine

Parameter nameType (in C++)Example valueConst?
Model: QuantLib::OneFactorAffineModelN/SN/S
Nsteps: QuantLib::SizeN/SN/S
YieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectTreeSwaptionEngine

qlModelG2SwaptionEngine

Parameter nameType (in C++)Example valueConst?
Model: QuantLib::G2N/SN/S
Range: QuantLib::RealN/SN/S
Intervals: QuantLib::SizeN/SN/S
Output objectG2SwaptionEngine

qlGeneralizedBlackScholesProcess

Parameter nameType (in C++)Example valueConst?
BlackVolID: QuantLib::BlackVolTermStructureN/SN/S
Underlying: doubleN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
SettlementDate: QuantLib::DateN/SN/S
RiskFreeRate: doubleN/SN/S
DividendYield: doubleN/SN/S
Output objectGeneralizedBlackScholesProcess

qlMarketModelMultiProductComposite

Parameter nameType (in C++)Example valueConst?
Output objectMultiProductComposite

qlMarketModelOneStepForwards

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Accruals: double1.0,1.0,1.0,1.0,1.0N/S
PaymentTimes: QuantLib::Time1.0,2.0,3.0,4.0,5.0N/S
Strikes: QuantLib::Rate0.01,0.01,0.01,0.01,0.01N/S
Output objectOneStepForwards

qlMarketModelMultiStepRatchet

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Accruals: double1.0,1.0,1.0,1.0,1.0N/S
PaymentTimes: QuantLib::Time1.0,2.0,3.0,4.0,5.0N/S
GearingOfFloor: QuantLib::Real1.0N/S
GearingOfFixing: QuantLib::Real1.0N/S
SpreadOfFloor: QuantLib::Real0.0N/S
SpreadOfFixing: QuantLib::Real0.0N/S
InitialFloor: QuantLib::Real0.01N/S
Payer: booltrueN/S
Output objectMultiStepRatchet

qlMarketModelOneStepOptionlets

Parameter nameType (in C++)Example valueConst?
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Accruals: QuantLib::TimeN/SN/S
PaymentTimes: QuantLib::TimeN/SN/S
Payoffs: QuantLib::PayoffN/SN/S
Output objectOneStepOptionlets

qlSimpleQuote

Parameter nameType (in C++)Example valueConst?
Value: QuantLib::RealN/SN/S
TickValue: QuantLib::Real0.0001N/S
Output objectSimpleQuote

qlForwardValueQuote

Parameter nameType (in C++)Example valueConst?
IborIndex: QuantLib::IborIndexN/SN/S
FixingDate: QuantLib::DateN/SN/S
Output objectForwardValueQuote

qlForwardSwapQuote

Parameter nameType (in C++)Example valueConst?
SwapIndex: QuantLib::SwapIndexN/SN/S
ForwardStart: QuantLib::Period"0D"N/S
Spread: QuantLib::Quote0.0N/S
Output objectForwardSwapQuote

qlImpliedStdDevQuote

Parameter nameType (in C++)Example valueConst?
OptionType: QuantLib::Option::TypeN/SN/S
Strike: QuantLib::RealN/SN/S
Guess: QuantLib::RealN/SN/S
Accuracy: QuantLib::RealN/SN/S
AtmForwardValue: QuantLib::QuoteN/SN/S
OptionPrice: QuantLib::QuoteN/SN/S
Output objectImpliedStdDevQuote

qlEurodollarFuturesImpliedStdDevQuote

Parameter nameType (in C++)Example valueConst?
Strike: QuantLib::RealN/SN/S
Guess: QuantLib::RealN/SN/S
Accuracy: QuantLib::RealN/SN/S
AtmForwardValue: QuantLib::QuoteN/SN/S
CallPrice: QuantLib::QuoteN/SN/S
PutPrice: QuantLib::QuoteN/SN/S
Output objectEurodollarFuturesImpliedStdDevQuote

qlCompositeQuote

Parameter nameType (in C++)Example valueConst?
Operator: stringN/SN/S
Element1: QuantLib::QuoteN/SN/S
Element2: QuantLib::QuoteN/SN/S
Output objectCompositeQuote

qlFuturesConvAdjustmentQuote

Parameter nameType (in C++)Example valueConst?
IborIndex: QuantLib::IborIndexN/SN/S
ImmCode: stringN/SN/S
FuturesQuote: QuantLib::QuoteN/SN/S
Volatility: QuantLib::QuoteN/SN/S
MeanReversion: QuantLib::QuoteN/SN/S
Output objectFuturesConvAdjustmentQuote

qlLastFixingQuote

Parameter nameType (in C++)Example valueConst?
Index: QuantLib::IndexN/SN/S
Output objectLastFixingQuote

qlRelinkableHandleQuote

Parameter nameType (in C++)Example valueConst?
CurrentLink: stringN/SN/S
Output objectRelinkableHandleImpl<QuantLibAddin::Quote, QuantLib::Quote>

qlMersenneTwisterRsg

Parameter nameType (in C++)Example valueConst?
Dimension: long3N/S
Seed: long2N/S
Output objectMersenneTwisterRsg

qlFaureRsg

Parameter nameType (in C++)Example valueConst?
Dimension: long2N/S
Output objectFaureRsg

qlHaltonRsg

Parameter nameType (in C++)Example valueConst?
Dimension: long2N/S
Seed: long2N/S
Output objectHaltonRsg

qlSobolRsg

Parameter nameType (in C++)Example valueConst?
Dimension: long3N/S
Seed: long2N/S
Output objectSobolRsg

qlRangeAccrualFloatersCoupon

Parameter nameType (in C++)Example valueConst?
Nominal: doubleN/SN/S
PaymentDate: QuantLib::DateN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
StartDate: QuantLib::DateN/SN/S
EndDate: QuantLib::DateN/SN/S
FixingDays: longN/SN/S
DayCountID: QuantLib::DayCounterN/SN/S
Gearings: doubleN/SN/S
Spreads: doubleN/SN/S
RefPeriodStart: QuantLib::DateN/SN/S
RefPeriodEnd: QuantLib::DateN/SN/S
LowerTrigger: doubleN/SN/S
UpperTrigger: doubleN/SN/S
ObserSchedID: QuantLib::ScheduleN/SN/S
Output objectRangeAccrualFloatersCoupon

qlRangeAccrualFloatersCouponFromLeg

Parameter nameType (in C++)Example valueConst?
Position: QuantLib::SizeN/SN/S
RangeAccrualLeg: QuantLib::LegN/SN/S
Output objectRangeAccrualFloatersCoupon

qlRangeAccrualPricerByBgm

Parameter nameType (in C++)Example valueConst?
Correlation: doubleN/SN/S
WithSmile: boolN/SN/S
ByCallSpread: boolN/SN/S
SmileOnStartDateID: QuantLib::SmileSectionN/SN/S
SmileOnEndDateID: QuantLib::SmileSectionN/SN/S
Output objectRangeAccrualPricerByBgm

qlDepositRateHelper

Parameter nameType (in C++)Example valueConst?
IborIndex: QuantLib::IborIndexEuribor6MN/S
Rate: QuantLib::Quote0.036565N/S
Output objectDepositRateHelper

qlDepositRateHelper2

Parameter nameType (in C++)Example valueConst?
Tenor: QuantLib::Period6MN/S
FixingDays: QuantLib::Natural2N/S
Calendar: QuantLib::CalendarTARGETN/S
Convention: QuantLib::BusinessDayConventionModified FollowingN/S
EndOfMonth: booltrueN/S
DayCounter: QuantLib::DayCounterActual/360N/S
Rate: QuantLib::Quote0.036565N/S
Output objectDepositRateHelper

qlSwapRateHelper

Parameter nameType (in C++)Example valueConst?
SwapIndex: QuantLib::SwapIndexEuriborSwapIsdaFixA10YN/S
ForwardStart: QuantLib::Period"0D"N/S
PillarDate: QuantLib::Pillar::ChoiceN/SN/S
CustomPillarDate: QuantLib::DateN/SN/S
Rate: QuantLib::Quote0.042322N/S
Spread: QuantLib::Quote0.0N/S
DiscountingCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectSwapRateHelper

qlSwapRateHelper2

Parameter nameType (in C++)Example valueConst?
SettlDays: QuantLib::NaturalN/SN/S
Tenor: QuantLib::Period10YN/S
Calendar: QuantLib::CalendarTARGETN/S
FixedLegFrequency: QuantLib::FrequencyAnnualN/S
FixedLegConvention: QuantLib::BusinessDayConventionModifiedFollowingN/S
FixedLegDayCounter: QuantLib::DayCounter30/360 (Bond Basis)N/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
ForwardStart: QuantLib::Period"0D"N/S
PillarDate: QuantLib::Pillar::ChoiceN/SN/S
CustomPillarDate: QuantLib::DateN/SN/S
Rate: QuantLib::Quote0.042322N/S
Spread: QuantLib::Quote0.0N/S
DiscountingCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectSwapRateHelper

qlOISRateHelper

Parameter nameType (in C++)Example valueConst?
SettlDays: QuantLib::Natural2N/S
Tenor: QuantLib::Period10YN/S
ONIndex: QuantLib::OvernightIndexEoniaN/S
FixedRate: QuantLib::Quote0.00423N/S
DiscountingCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectOISRateHelper

qlDatedOISRateHelper

Parameter nameType (in C++)Example valueConst?
StartDate: QuantLib::Date39000N/S
EndDate: QuantLib::Date40000N/S
ONIndex: QuantLib::OvernightIndexEoniaN/S
FixedRate: QuantLib::Quote0.00423N/S
DiscountingCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectDatedOISRateHelper

qlFraRateHelper

Parameter nameType (in C++)Example valueConst?
PeriodToStart: QuantLib::Period3MN/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
PillarDate: QuantLib::Pillar::ChoiceN/SN/S
CustomPillarDate: QuantLib::DateN/SN/S
Rate: QuantLib::Quote0.041234N/S
Output objectFraRateHelper

qlFraRateHelper2

Parameter nameType (in C++)Example valueConst?
PeriodToStart: QuantLib::Period3MN/S
LengthInMonths: QuantLib::Natural9N/S
FixingDays: QuantLib::Natural2N/S
Calendar: QuantLib::CalendarTARGETN/S
Convention: QuantLib::BusinessDayConventionModifiedFollowingN/S
EndOfMonth: booltrueN/S
DayCounter: QuantLib::DayCounterActual/360N/S
PillarDate: QuantLib::Pillar::ChoiceN/SN/S
CustomPillarDate: QuantLib::DateN/SN/S
Rate: QuantLib::Quote0.041234N/S
Output objectFraRateHelper

qlBondHelper

Parameter nameType (in C++)Example valueConst?
Bond: QuantLib::BondDE0003088704N/S
UseCleanPrice: boolN/SN/S
Price: QuantLib::Quote100.4332N/S
Output objectBondHelper

qlFixedRateBondHelper

Parameter nameType (in C++)Example valueConst?
SettlementDays: QuantLib::Size3N/S
FaceAmount: doubleN/SN/S
Coupons: QuantLib::Rate0.04N/S
DayCounter: QuantLib::DayCounterActual/Actual (ISMA)N/S
PaymentBDC: QuantLib::BusinessDayConventionN/SN/S
Redemption: doubleN/SN/S
IssueDate: QuantLib::DateN/SN/S
PaymentCalendar: QuantLib::CalendarTARGETN/S
ExCouponPeriod: QuantLib::Period10DN/S
ExCouponCalendar: QuantLib::CalendarTARGETN/S
ExCouponBDC: QuantLib::BusinessDayConventionModified FollowingN/S
ExCouponEndOfMonth: booltrueN/S
UseCleanPrice: booltrueN/S
Price: QuantLib::Quote100.4332N/S
ScheduleID: QuantLib::ScheduleN/SN/S
Output objectFixedRateBondHelper

qlFuturesRateHelper

Parameter nameType (in C++)Example valueConst?
FuturesType: QuantLib::Futures::TypeN/SN/S
FuturesDate: QuantLib::DateN/SN/S
IborIndex: QuantLib::IborIndexN/SN/S
Price: QuantLib::Quote95.9285N/S
ConvexityAdjQuote: QuantLib::Quote0.0N/S
Output objectFuturesRateHelper

qlFuturesRateHelper2

Parameter nameType (in C++)Example valueConst?
FuturesType: QuantLib::Futures::TypeN/SN/S
FuturesDate: QuantLib::DateN/SN/S
LengthInMonths: longN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
Convention: QuantLib::BusinessDayConventionN/SN/S
EndOfMonth: boolN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Price: QuantLib::Quote95.9285N/S
ConvexityAdjQuote: QuantLib::Quote0.0N/S
Output objectFuturesRateHelper

qlFuturesRateHelper3

Parameter nameType (in C++)Example valueConst?
FuturesType: QuantLib::Futures::TypeN/SN/S
FuturesDate: QuantLib::DateN/SN/S
EndDate: QuantLib::DateN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Price: QuantLib::Quote95.9285N/S
ConvexityAdjQuote: QuantLib::Quote0.0N/S
Output objectFuturesRateHelper

qlFxSwapRateHelper

Parameter nameType (in C++)Example valueConst?
Tenor: QuantLib::Period3MN/S
FixingDays: QuantLib::Natural2N/S
Calendar: QuantLib::CalendarTARGETN/S
Convention: QuantLib::BusinessDayConventionModified FollowingN/S
EndOfMonth: booltrueN/S
IsFxBaseCurrencyCollateralCurrency: booltrueN/S
FwdPoint: QuantLib::Quote0.136565N/S
SpotFx: QuantLib::Quote1.076565N/S
CollateralCurve: QuantLib::YieldTermStructureEURONN/S
Output objectFxSwapRateHelper

qlSchedule

Parameter nameType (in C++)Example valueConst?
EffectiveDate: QuantLib::DateN/SN/S
TerminationDate: QuantLib::Date122MN/S
Tenor: QuantLib::Period1YN/S
Calendar: QuantLib::CalendarN/SN/S
Convention: QuantLib::BusinessDayConventionN/SN/S
TermDateConv: QuantLib::BusinessDayConventionN/SN/S
GenRule: QuantLib::DateGeneration::RuleN/SN/S
EndOfMonth: boolN/SN/S
FirstDate: QuantLib::DateN/SN/S
NextToLastDate: QuantLib::DateN/SN/S
Output objectSchedule

qlScheduleFromDateVector

Parameter nameType (in C++)Example valueConst?
EffectiveDate: QuantLib::DateN/SN/S
Output objectSchedule

qlScheduleTruncated

Parameter nameType (in C++)Example valueConst?
TruncationDate: QuantLib::Date54MN/S
OriginalSchedule: QuantLib::ScheduleN/SN/S
Output objectSchedule

qlSequenceStatistics

Statistics analysis of N-dimensional (sequence) data.

Parameter nameType (in C++)Example valueConst?
Dimension: QuantLib::SizeN/SN/S
Output objectSequenceStatistics

qlSequenceStatistics2

Statistics analysis of N-dimensional (sequence) data.

Parameter nameType (in C++)Example valueConst?
Dimension: QuantLib::SizeN/SN/S
Values: QuantLib::MatrixN/SN/S
Weights: QuantLib::RealN/SN/S
Output objectSequenceStatistics

qlSequenceStatisticsInc

Statistics analysis of N-dimensional (sequence) data.

Parameter nameType (in C++)Example valueConst?
Dimension: QuantLib::SizeN/SN/S
Output objectSequenceStatisticsInc

qlSequenceStatisticsInc2

Statistics analysis of N-dimensional (sequence) data.

Parameter nameType (in C++)Example valueConst?
Dimension: QuantLib::SizeN/SN/S
Values: QuantLib::MatrixN/SN/S
Weights: QuantLib::RealN/SN/S
Output objectSequenceStatisticsInc

qlHullWhite

Parameter nameType (in C++)Example valueConst?
A: double0.03N/S
Sigma: double0.15N/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectHullWhite

qlVasicek

Parameter nameType (in C++)Example valueConst?
R0: doubleN/SN/S
A: doubleN/SN/S
B: doubleN/SN/S
Sigma: doubleN/SN/S
Lambda: doubleN/SN/S
Output objectVasicek

qlModelG2

Parameter nameType (in C++)Example valueConst?
A: doubleN/SN/S
Sigma: doubleN/SN/S
B: doubleN/SN/S
Eta: doubleN/SN/S
Correlation: doubleN/SN/S
YieldCurve: QuantLib::YieldTermStructureEURYCN/S
Output objectG2

qlFlatSmileSection

Parameter nameType (in C++)Example valueConst?
OptionDate: QuantLib::Date3mN/S
Volatility: QuantLib::Volatility0.14N/S
DayCounter: QuantLib::DayCounterN/SN/S
RefDate: QuantLib::Date34567N/S
AtmValue: QuantLib::Real0.04N/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
Output objectFlatSmileSection

qlSabrInterpolatedSmileSection

Parameter nameType (in C++)Example valueConst?
OptionDate: QuantLib::Date3mN/S
ForwardRate: QuantLib::RateN/SN/S
Strike: QuantLib::Rate0.01, 0.02, 0.03, 0.04 N/S
FloatingStrike: boolN/SN/S
AtmVolatility: QuantLib::Volatility0.045N/S
VolatilitySpreads: QuantLib::RateN/SN/S
Alpha: doubleN/SN/S
Beta: doubleN/SN/S
Nu: doubleN/SN/S
Rho: doubleN/SN/S
AlphaIsFixed: boolN/SN/S
BetaIsFixed: boolN/SN/S
NuIsFixed: boolN/SN/S
RhoIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Method: QuantLib::OptimizationMethodN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectSabrInterpolatedSmileSection

qlSabrInterpolatedSmileSection1

Parameter nameType (in C++)Example valueConst?
OptionDate: QuantLib::Date3mN/S
Strike: QuantLib::Rate0.01, 0.02, 0.03, 0.04 N/S
FloatingStrike: boolN/SN/S
Alpha: doubleN/SN/S
Beta: doubleN/SN/S
Nu: doubleN/SN/S
Rho: doubleN/SN/S
AlphaIsFixed: boolN/SN/S
BetaIsFixed: boolN/SN/S
NuIsFixed: boolN/SN/S
RhoIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Method: QuantLib::OptimizationMethodN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
ForwardRate: QuantLib::QuoteN/SN/S
AtmVolatility: QuantLib::Quote0.045N/S
VolatilitySpreads: QuantLib::QuoteN/SN/S
Output objectSabrInterpolatedSmileSection

qlSabrSmileSection

Parameter nameType (in C++)Example valueConst?
OptionTime: QuantLib::Time1.0 N/S
Strikes: QuantLib::Rate0.01, 0.02, 0.03, 0.04 N/S
Alpha: doubleN/SN/S
Beta: doubleN/SN/S
Nu: doubleN/SN/S
Rho: doubleN/SN/S
AlphaIsFixed: boolN/SN/S
BetaIsFixed: boolN/SN/S
NuIsFixed: boolN/SN/S
RhoIsFixed: boolN/SN/S
VegaWeighted: boolN/SN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
Method: QuantLib::OptimizationMethodN/SN/S
StdDevs: QuantLib::Quote0.1, 0.2, 0.3, 0.4 N/S
Forward: QuantLib::Quote0.045 N/S
Output objectSabrSmileSection

qlInterpolatedSmileSection

Parameter nameType (in C++)Example valueConst?
OptionDate: QuantLib::Date3mN/S
Strikes: QuantLib::Rate0.01, 0.02, 0.03, 0.04 N/S
DayCounter: QuantLib::DayCounterN/SN/S
VolatilityType: QuantLib::VolatilityTypeN/SN/S
Displacement: QuantLib::RealN/SN/S
StdDevs: QuantLib::Quote0.1, 0.2, 0.3, 0.4 N/S
AtmLevel: QuantLib::Quote0.1N/S
Output objectInterpolatedSmileSection

qlSmileSectionFromSabrVolSurface

Parameter nameType (in C++)Example valueConst?
OptionTime: QuantLib::TimeN/SN/S
SabrVolSurface: QuantLib::SabrVolSurfaceN/SN/S
Output objectSmileSectionFromSabrVolSurface

qlStatistics

Statistics and risk measures tool.

Parameter nameType (in C++)Example valueConst?
Values: QuantLib::Real1.0,1.5,2.0N/S
Weights: QuantLib::Real1.0,1.0,1.0N/S
Output objectStatistics

qlIncrementalStatistics

Statistics and risk measures tool.

Parameter nameType (in C++)Example valueConst?
Values: QuantLib::Real1.0,1.5,2.0N/S
Weights: QuantLib::Real1.0,1.0,1.0N/S
Output objectIncrementalStatistics

qlSwap

Parameter nameType (in C++)Example valueConst?
LegIDs: QuantLibAddin::LegN/SN/S
Payer: boolN/SN/S
Output objectSwap

qlMakeCms

Parameter nameType (in C++)Example valueConst?
SwapTenor: QuantLib::Period10YN/S
SwapIndex: QuantLib::SwapIndexEuriborSwapIsdaFixA10YN/S
IborIndex: QuantLib::IborIndexEuribor3MN/S
IborSpread: QuantLib::SpreadN/SN/S
ForwardStart: QuantLib::Period"0D"N/S
CmsCouponPricer: QuantLib::CmsCouponPricerCmsCouponPricerIDN/S
Output objectSwap

qlSwaption

Parameter nameType (in C++)Example valueConst?
VanillaSwap: QuantLib::VanillaSwapN/SN/S
Exercise: QuantLib::ExerciseN/SN/S
SettlementType: QuantLib::Settlement::TypeN/SN/S
Output objectSwaption

qlMakeSwaption

Parameter nameType (in C++)Example valueConst?
SwapIndex: QuantLib::SwapIndexEuriborSwapIsdaFixA10YN/S
OptionTenor: QuantLib::Period5YN/S
Strike: QuantLib::RateN/SN/S
PricingEngineID: QuantLib::PricingEngineSwaptionEngineIDN/S
Output objectSwaption

qlRelinkableHandleSwaptionVolatilityStructure

Parameter nameType (in C++)Example valueConst?
CurrentLink: stringN/SN/S
Output objectRelinkableHandleImpl<QuantLibAddin::SwaptionVolatilityStructure, QuantLib::SwaptionVolatilityStructure>

qlConstantSwaptionVolatility

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarTARGETN/S
BusinessDayConvention: QuantLib::BusinessDayConventionN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Volatility: QuantLib::QuoteN/SN/S
Output objectConstantSwaptionVolatility

qlSpreadedSwaptionVolatility

Parameter nameType (in C++)Example valueConst?
BaseVolStructure: QuantLib::SwaptionVolatilityStructureN/SN/S
Spread: QuantLib::Quote0.01N/S
Output objectSpreadedSwaptionVolatility

qlSwaptionVTSMatrix

Parameter nameType (in C++)Example valueConst?
Calendar: QuantLib::CalendarN/SN/S
BusinessDayConvention: QuantLib::BusinessDayConvention"Following"N/S
OptionTenors: QuantLib::Period2y, 5yN/S
SwapTenors: QuantLib::Period2y, 5yN/S
DayCounter: QuantLib::DayCounterN/SN/S
Volatilities: QuantLib::QuoteN/SN/S
Output objectSwaptionVolatilityMatrix

qlSwaptionVolCube2

Parameter nameType (in C++)Example valueConst?
OptionTenor: QuantLib::Period5yN/S
SwapTenor: QuantLib::Period2yN/S
StrikeSpreads: QuantLib::Spread.01, .02, .03N/S
SwapIndexBase: QuantLib::SwapIndexN/SN/S
ShortSwapIndexBase: QuantLib::SwapIndexN/SN/S
VegaWeightedSmileFit: boolN/SN/S
AtmVolStructure: QuantLib::SwaptionVolatilityStructureN/SN/S
SpreadVols: QuantLib::QuoteN/SN/S
Output objectSwaptionVolCube2

qlSwaptionVolCube1

Parameter nameType (in C++)Example valueConst?
OptionTenors: QuantLib::Period5yN/S
SwapTenors: QuantLib::Period2yN/S
StrikeSpreads: QuantLib::Spread.01, .02, .03N/S
SwapIndexBase: QuantLib::SwapIndexN/SN/S
ShortSwapIndexBase: QuantLib::SwapIndexN/SN/S
VegaWeightedSmileFit: boolN/SN/S
IsFixed: boolFALSE, TRUE, FALSE, FALSEN/S
IsAtmCalibrated: boolFALSEN/S
EndCriteria: QuantLib::EndCriteriaN/SN/S
MaxErrorTol: doubleN/SN/S
OptMethod: QuantLib::OptimizationMethodN/SN/S
AtmVolStructure: QuantLib::SwaptionVolatilityStructureN/SN/S
SpreadVols: QuantLib::QuoteN/SN/S
Guess: QuantLib::QuoteN/SN/S
Output objectSwaptionVolCube1

qlSmileSectionByCube

Parameter nameType (in C++)Example valueConst?
VolCube: QuantLib::SwaptionVolatilityCubeN/SN/S
OptionDate: QuantLib::Date5yN/S
SwapTenor: QuantLib::Period2yN/S
Output objectSmileSectionByCube

qlSmileSectionByCube2

Parameter nameType (in C++)Example valueConst?
VolCube: QuantLib::SwaptionVolatilityCubeN/SN/S
OptionDate: QuantLib::Period5yN/S
SwapTenor: QuantLib::Period2yN/S
Output objectSmileSectionByCube

qlRelinkableHandleYieldTermStructure

Parameter nameType (in C++)Example valueConst?
CurrentLink: stringN/SN/S
Output objectRelinkableHandleImpl<QuantLibAddin::YieldTermStructure, QuantLib::YieldTermStructure>

qlDiscountCurve

Parameter nameType (in C++)Example valueConst?
CurveDates: QuantLib::Date'2M,3M,4M,5M,6MN/S
CurveDiscounts: QuantLib::DiscountFactor1.0,0.95,0.9,0.85,0.8N/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectDiscountCurve

qlZeroCurve

Parameter nameType (in C++)Example valueConst?
CurveDates: QuantLib::Date'2M,3M,4M,5M,6MN/S
CurveYields: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectZeroCurve

qlForwardCurve

Parameter nameType (in C++)Example valueConst?
CurveDates: QuantLib::Date'2M,3M,4M,5M,6MN/S
ForwardYields: QuantLib::Rate0.02,0.02,0.02,0.02,0.02N/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectForwardCurve

qlFlatForward

Parameter nameType (in C++)Example valueConst?
NDays: QuantLib::SizeN/SN/S
Calendar: QuantLib::CalendarN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Compounding: QuantLib::CompoundingN/SN/S
Frequency: QuantLib::FrequencyN/SN/S
Rate: QuantLib::Quote0.044N/S
Output objectFlatForward

qlForwardSpreadedTermStructure

Parameter nameType (in C++)Example valueConst?
BaseYieldCurve: QuantLib::YieldTermStructureN/SN/S
Spread: QuantLib::Quote0.0N/S
Output objectForwardSpreadedTermStructure

qlImpliedTermStructure

Parameter nameType (in C++)Example valueConst?
ReferenceDate: QuantLib::Date1DN/S
BaseYieldCurve: QuantLib::YieldTermStructureN/SN/S
Output objectImpliedTermStructure

qlInterpolatedYieldCurve

Parameter nameType (in C++)Example valueConst?
Dates: QuantLib::Date0D,1M,3M,6M,1Y,2Y,3Y,5Y,10YN/S
Data: QuantLib::Real1.0,0.99,0.96,0.94,0.9,0.8,0.7,0.6,0.4N/S
Calendar: QuantLib::CalendarN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
JumpDates: QuantLib::Date1YN/S
TraitsID: stringN/SN/S
InterpolatorID: stringN/SN/S
MixedInterpolationBehavior: QuantLib::MixedInterpolation::BehaviorN/SN/S
NRateHelper: QuantLib::SizeN/SN/S
Jumps: QuantLib::Quote1.0N/S
Output objectInterpolatedYieldCurve

qlTimeSeries

Parameter nameType (in C++)Example valueConst?
Dates: QuantLib::DateN/SN/S
Values: QuantLib::RealN/SN/S
Output objectTimeSeriesDef

qlTimeSeriesFromIndex

Parameter nameType (in C++)Example valueConst?
Index: QuantLib::IndexN/SN/S
Output objectTimeSeriesDef

qlVanillaSwap

Parameter nameType (in C++)Example valueConst?
PayerReceiver: QuantLib::VanillaSwap::TypeN/SN/S
Nominal: doubleN/SN/S
FixedRate: QuantLib::RateN/SN/S
FixDayCounter: QuantLib::DayCounter30/360 (Bond Basis)N/S
IborIndex: QuantLib::IborIndexN/SN/S
Spread: QuantLib::SpreadN/SN/S
FloatingLegDayCounter: QuantLib::DayCounterActual/360N/S
PaymentConvention: QuantLib::BusinessDayConventionN/SN/S
FixSchedule: QuantLib::ScheduleFixedScheduleN/S
FloatingLegSchedule: QuantLib::ScheduleFloatingScheduleN/S
Output objectVanillaSwap

qlMakeVanillaSwap

Parameter nameType (in C++)Example valueConst?
SettlDays: QuantLib::NaturalN/SN/S
SwapTenor: QuantLib::Period5YN/S
IborIndex: QuantLib::IborIndexEuribor6MN/S
FixedRate: QuantLib::RateN/SN/S
ForwardStart: QuantLib::Period"0D"N/S
FixDayCounter: QuantLib::DayCounterN/SN/S
Spread: QuantLib::SpreadN/SN/S
PricingEngineID: QuantLib::PricingEngineDiscountSwapEngineIDN/S
Output objectVanillaSwap

qlMakeIMMSwap

Parameter nameType (in C++)Example valueConst?
SwapTenor: QuantLib::Period2YN/S
IborIndex: QuantLib::IborIndexEuribor3MN/S
FixedRate: QuantLib::RateN/SN/S
FirstImmDate: QuantLib::DateN/SN/S
FixDayCounter: QuantLib::DayCounterN/SN/S
Spread: QuantLib::SpreadN/SN/S
PricingEngineID: QuantLib::PricingEngineDiscountSwapEngineIDN/S
Output objectVanillaSwap

qlVanillaSwapFromSwapIndex

Parameter nameType (in C++)Example valueConst?
SwapIndex: QuantLib::SwapIndexN/SN/S
FixingDate: QuantLib::DateN/SN/S
Output objectVanillaSwap

qlVanillaSwapFromSwapRateHelper

Parameter nameType (in C++)Example valueConst?
SwapRateHelper: QuantLib::SwapRateHelperN/SN/S
Output objectVanillaSwap

qlBlackConstantVol

Parameter nameType (in C++)Example valueConst?
SettlementDate: QuantLib::Date0DN/S
Calendar: QuantLib::CalendarTARGETN/S
Volatility: double0.2N/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectBlackConstantVol

qlBlackVarianceSurface

Parameter nameType (in C++)Example valueConst?
SettlementDate: QuantLib::Date0DN/S
Calendar: QuantLib::CalendarTARGETN/S
Dates: QuantLib::Date3m, 1y, 5yN/S
Strikes: double0.03, 0.05, 0.10N/S
Volatilities: QuantLib::MatrixN/SN/S
DayCounter: QuantLib::DayCounterN/SN/S
Output objectBlackVarianceSurface

qlAbcdAtmVolCurve

Parameter nameType (in C++)Example valueConst?
SettlementDays: QuantLib::Natural2DN/S
Calendar: QuantLib::CalendarTARGETN/S
OptionTenors: QuantLib::PeriodN/SN/S
InclusionInInterpolation: boolN/SN/S
Convention: QuantLib::BusinessDayConventionFollowingN/S
DayCounter: QuantLib::DayCounterN/SN/S
VolatilitiesQuotes: QuantLib::QuoteN/SN/S
Output objectAbcdAtmVolCurve

qlSabrVolSurface

Parameter nameType (in C++)Example valueConst?
InterestRateIndex: QuantLib::InterestRateIndexN/SN/S
OptionTenors: QuantLib::PeriodN/SN/S
AtmRateSpreads: QuantLib::SpreadN/SN/S
BlackAtmVolCurve: QuantLib::BlackAtmVolCurveN/SN/S
VolatilitiesQuotes: QuantLib::QuoteN/SN/S
Output objectSabrVolSurface

qlPiecewiseConstantAbcdVariance

Parameter nameType (in C++)Example valueConst?
A: doubleN/SN/S
B: doubleN/SN/S
C: doubleN/SN/S
D: doubleN/SN/S
ResetIndex: long0N/S
RateTimes: QuantLib::Time0.5,1.0,1.5,2.0,2.5,3.0,3.5,4.0,4.5,5.0,5.5N/S
Output objectPiecewiseConstantAbcdVariance

qlMarketModelLmExtLinearExponentialVolModel

Parameter nameType (in C++)Example valueConst?
FixingTimes: double0.0,1.0,2.0,3.0,4.0,5.0N/S
A: double1.0N/S
B: double1.0N/S
C: double1.0N/S
D: double1.0N/S
Output objectLmExtLinearExponentialVolModel