Section 3: library functions
ql/experimental/credit/basket.hpp – basket of issuers and related notionals Synopsis#include <ql/default.hpp> #include <ql/issuer.hpp> #include <ql/termstructures/defaulttermstructure.hpp> #include <ql/experimental/credit/pool.hpp> #include <ql/experimental/credit/loss.hpp> Classesclass Basket Detailed Descriptionbasket of issuers and related notionals AuthorGenerated automatically by Doxygen for QuantLib from the source code.
QuantLib::Quantity – Amount of a commodity. Synopsis#include <ql/experimental/commodities/quantity.hpp> Public Member FunctionsConstructors Quantity () Quantity (const CommodityType &commodityType, const UnitOfMeasure &unitOfMeasure, Real amount) Inspectors const CommodityType & commodityType () const const UnitOfMeasure & unitOfMeasure () const Real amount () const Quantity rounded () const Quantity arithmetics See below for non-member functions and for settings which determine…
QuantLib::Money – amount of cash Synopsis#include <ql/money.hpp> Public Member FunctionsConstructors Money () Money (const Currency ¤cy, Decimal value) Money (Decimal value, const Currency ¤cy) Inspectors const Currency & currency () const Decimal value () const Money rounded () const Money arithmetics See below for non-member functions and for settings which determine the behavior of the…
ql/instruments/barrieroption.hpp – Barrier option on a single asset. Synopsis#include <ql/instruments/oneassetoption.hpp> #include <ql/instruments/barriertype.hpp> #include <ql/instruments/payoffs.hpp> Classesclass BarrierOption Barrier option on a single asset. class arguments Arguments for barrier option calculation class engine Barrier-option engine base class Detailed DescriptionBarrier option on a single asset. AuthorGenerated automatically by Doxygen for QuantLib from the source code.
QuantLib::BaroneAdesiWhaleyApproximationEngine – Barone-Adesi and Whaley pricing engine for American options (1987). Synopsis#include <ql/pricingengines/vanilla/baroneadesiwhaleyengine.hpp> Inherits VanillaOption::engine. Public Member FunctionsBaroneAdesiWhaleyApproximationEngine (const boost::shared_ptr< GeneralizedBlackScholesProcess > &) void calculate () const Static Public Member Functionsstatic Real criticalPrice (const boost::shared_ptr< StrikedTypePayoff > &payoff, DiscountFactor riskFreeDiscount, DiscountFactor dividendDiscount, Real variance, Real tolerance=1e-6) Detailed DescriptionBarone-Adesi and Whaley pricing engine for American options…
ql/math/interpolations/backwardflatinterpolation.hpp – backward-flat interpolation between discrete points Synopsis#include <ql/math/interpolation.hpp> #include <vector> Classesclass BackwardFlatInterpolation Backward-flat interpolation between discrete points. class BackwardFlat Backward-flat interpolation factory and traits. Detailed Descriptionbackward-flat interpolation between discrete points AuthorGenerated automatically by Doxygen for QuantLib from the source code.
QuantLib::DateGeneration – Date-generation rule. Synopsis#include <ql/time/dategenerationrule.hpp> Public Typesenum Rule { Backward, Forward, Zero, ThirdWednesday, Twentieth, TwentiethIMM } Related Functions(Note that these are not member functions.) std::ostream & operator<< (std::ostream &, DateGeneration::Rule) Detailed DescriptionDate-generation rule. These conventions specify the rule used to generate dates in a Schedule. Member Enumeration Documentationenum RuleEnumerator: Backward Backward from termination date…
QuantLib::BSpline – B-spline basis functions. Synopsis#include <ql/math/bspline.hpp> Public Member FunctionsBSpline (Natural p, Natural n, const std::vector< Real > &knots) Real operator() (Natural i, Real x) const Detailed DescriptionB-spline basis functions. Follows treatment and notation from: Weisstein, Eric W. ‘B-Spline.’ From MathWorld–A Wolfram Web Resource. <http://mathworld.wolfram.com/B-Spline.html> $ (p+1) $-th order B-spline (or p degree polynomial) basis…
QuantLib::Slovakia – Slovak calendars. Synopsis#include <ql/time/calendars/slovakia.hpp> Inherits QuantLib::Calendar. Public Typesenum Market { BSSE } Public Member FunctionsSlovakia (Market m=BSSE) Detailed DescriptionSlovak calendars. Holidays for the Bratislava stock exchange (data from <http://www.bsse.sk/>): * Saturdays * Sundays * New Year’s Day, January 1st * Epiphany, January 6th * Good Friday * Easter Monday * May Day, May…
ql/methods/finitedifferences/bsmtermoperator.hpp – differential operator for Black-Scholes-Merton equation Synopsis#include <ql/methods/finitedifferences/tridiagonaloperator.hpp> #include <ql/processes/blackscholesprocess.hpp> #include <ql/math/transformedgrid.hpp> #include <ql/methods/finitedifferences/pdebsm.hpp> Typedefstypedef PdeOperator< PdeBSM > BSMTermOperator Black-Scholes-Merton differential operator. Detailed Descriptiondifferential operator for Black-Scholes-Merton equation AuthorGenerated automatically by Doxygen for QuantLib from the source code.
ql/methods/finitedifferences/bsmoperator.hpp – differential operator for Black-Scholes-Merton equation Synopsis#include <ql/methods/finitedifferences/tridiagonaloperator.hpp> #include <ql/processes/blackscholesprocess.hpp> Classesclass BSMOperator Black-Scholes-Merton differential operator. Detailed Descriptiondifferential operator for Black-Scholes-Merton equation AuthorGenerated automatically by Doxygen for QuantLib from the source code.
ql/qldefines.hpp – Global definitions and compiler switches. Synopsis#include <boost/config.hpp> #include <boost/version.hpp> #include <ql/config.ansi.hpp> #include <cmath> #include <boost/limits.hpp> Defines#define BOOST_ENABLE_ASSERT_HANDLER #define QL_INTEGER int #define QL_BIG_INTEGER long #define QL_REAL double #define QL_VERSION ‘0.9.7’ version string #define QL_HEX_VERSION 0x000907f0 version hexadecimal number #define QL_LIB_VERSION ‘0_9_7’ version string for output lib name #define QL_MIN_INTEGER ((std::numeric_limits<QL_INTEGER>::min)()) #define QL_MAX_INTEGER ((std::numeric_limits<QL_INTEGER>::max)()) #define…
QuantLib::Mexico – Mexican calendars Synopsis#include <ql/time/calendars/mexico.hpp> Inherits QuantLib::Calendar. Public Typesenum Market { BMV } Public Member FunctionsMexico (Market m=BMV) Detailed DescriptionMexican calendars Holidays for the Mexican stock exchange (data from <http://www.bmv.com.mx/>): * Saturdays * Sundays * New Year’s Day, January 1st * Constitution Day, February 5th * Birthday of Benito Juarez, March 21st * Holy…
QuantLib::BMASwapRateHelper – Rate helper for bootstrapping over BMA swap rates. Synopsis#include <ql/termstructures/yield/ratehelpers.hpp> Inherits QuantLib::RelativeDateRateHelper. Public Member FunctionsBMASwapRateHelper (const Handle< Quote > &liborFraction, const Period &tenor, Natural settlementDays, const Calendar &calendar, const Period &bmaPeriod, BusinessDayConvention bmaConvention, const DayCounter &bmaDayCount, const boost::shared_ptr< BMAIndex > &bmaIndex, const boost::shared_ptr< IborIndex > &index) RateHelper interface Real impliedQuote () const void…
QuantLib::BMASwap – swap paying Libor against BMA coupons Synopsis#include <ql/instruments/bmaswap.hpp> Inherits QuantLib::Swap. Public Typesenum Type { Receiver = -1, Payer = 1 } Public Member FunctionsBMASwap (Type type, Real nominal, const Schedule &liborSchedule, Rate liborFraction, Rate liborSpread, const boost::shared_ptr< IborIndex > &liborIndex, const DayCounter &liborDayCount, const Schedule &bmaSchedule, const boost::shared_ptr< BMAIndex > &bmaIndex, const DayCounter…
QuantLib::BMAIndex – Bond Market Association index. Synopsis#include <ql/indexes/bmaindex.hpp> Inherits QuantLib::InterestRateIndex. Public Member FunctionsBMAIndex (const Handle< YieldTermStructure > &h=Handle< YieldTermStructure >()) Index interface std::string name () const bool isValidFixingDate (const Date &fixingDate) const returns TRUE if the fixing date is a valid one InterestRateIndex interface Handle< YieldTermStructure > termStructure () const Date maturityDate (const Date &valueDate)…
xerbla_array.f – SynopsisFunctions/Subroutinessubroutine xerbla_array (SRNAME_ARRAY, SRNAME_LEN, INFO) XERBLA_ARRAY Function/Subroutine Documentationsubroutine xerbla_array (character(1), dimension(srname_len)SRNAME_ARRAY, integerSRNAME_LEN, integerINFO)XERBLA_ARRAY Purpose: XERBLA_ARRAY assists other languages in calling XERBLA, the LAPACK and BLAS error handler. Rather than taking a Fortran string argument as the function’s name, XERBLA_ARRAY takes an array of single characters along with the array’s length. XERBLA_ARRAY then copies…
xerbla_array.f – SynopsisFunctions/Subroutinessubroutine xerbla_array (SRNAME_ARRAY, SRNAME_LEN, INFO) XERBLA_ARRAY Function/Subroutine Documentationsubroutine xerbla_array (character(1), dimension(srname_len)SRNAME_ARRAY, integerSRNAME_LEN, integerINFO)XERBLA_ARRAY Purpose: XERBLA_ARRAY assists other languages in calling XERBLA, the LAPACK and BLAS error handler. Rather than taking a Fortran string argument as the function’s name, XERBLA_ARRAY takes an array of single characters along with the array’s length. XERBLA_ARRAY then copies…
xerbla.f – SynopsisFunctions/Subroutinessubroutine xerbla (SRNAME, INFO) XERBLA Function/Subroutine Documentationsubroutine xerbla (character*(*)SRNAME, integerINFO)XERBLA Purpose: XERBLA is an error handler for the LAPACK routines. It is called by an LAPACK routine if an input parameter has an invalid value. A message is printed and execution stops. Installers may consider modifying the STOP statement in order to call…
xerbla.f – SynopsisFunctions/Subroutinessubroutine xerbla (SRNAME, INFO) XERBLA Function/Subroutine Documentationsubroutine xerbla (character*(*)SRNAME, integerINFO)XERBLA Purpose: XERBLA is an error handler for the LAPACK routines. It is called by an LAPACK routine if an input parameter has an invalid value. A message is printed and execution stops. Installers may consider modifying the STOP statement in order to call…