Linux Manuals session 3

Section 3: library functions

  • |

    BlackVolatilityTermStructure (3) Linux Manual Page

    QuantLib::BlackVolatilityTermStructure – Black-volatility term structure. Synopsis#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> Inherits QuantLib::BlackVolTermStructure. Inherited by BlackConstantVol. Public Member FunctionsConstructors See the TermStructure documentation for issues regarding constructors. BlackVolatilityTermStructure (const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) default constructor BlackVolatilityTermStructure (const Date &referenceDate, const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) initialize with a fixed reference date BlackVolatilityTermStructure (Natural settlementDays,…

  • |

    BlackVolTermStructure (3) Linux Manual Page

    ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp – Black volatility term structure base classes. Synopsis#include <ql/termstructures/voltermstructure.hpp> #include <ql/patterns/visitor.hpp> Classesclass BlackVolTermStructure Black-volatility term structure. class BlackVolatilityTermStructure Black-volatility term structure. class BlackVarianceTermStructure Black variance term structure. Detailed DescriptionBlack volatility term structure base classes. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    BlackVolSurface (3) Linux Manual Page

    QuantLib::BlackVolSurface – Black volatility (smile) surface. Synopsis#include <ql/experimental/volatility/blackvolsurface.hpp> Inherits QuantLib::BlackAtmVolCurve. Inherited by EquityFXVolSurface, and InterestRateVolSurface. Public Member FunctionsConstructors See the TermStructure documentation for issues regarding constructors. BlackVolSurface (const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) default constructor BlackVolSurface (const Date &referenceDate, const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) initialize with a fixed reference date…

  • |

    BlackVarianceTermStructure (3) Linux Manual Page

    QuantLib::BlackVarianceTermStructure – Black variance term structure. Synopsis#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> Inherits QuantLib::BlackVolTermStructure. Inherited by BlackVarianceCurve, BlackVarianceSurface, ExtendedBlackVarianceCurve, ExtendedBlackVarianceSurface, and ImpliedVolTermStructure. Public Member FunctionsConstructors See the TermStructure documentation for issues regarding constructors. BlackVarianceTermStructure (const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) default constructor BlackVarianceTermStructure (const Date &referenceDate, const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter()) initialize with a…

  • |

    BlackVarianceSurface (3) Linux Manual Page

    ql/termstructures/volatility/equityfx/blackvariancesurface.hpp – Black volatility surface modelled as variance surface. Synopsis#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> #include <ql/math/matrix.hpp> #include <ql/math/interpolations/interpolation2d.hpp> #include <ql/time/daycounters/actual365fixed.hpp> Classesclass BlackVarianceSurface Black volatility surface modelled as variance surface. Detailed DescriptionBlack volatility surface modelled as variance surface. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    BlackVarianceCurve (3) Linux Manual Page

    ql/termstructures/volatility/equityfx/blackvariancecurve.hpp – Black volatility curve modelled as variance curve. Synopsis#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> #include <ql/math/interpolation.hpp> Classesclass BlackVarianceCurve Black volatility curve modelled as variance curve. Detailed DescriptionBlack volatility curve modelled as variance curve. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    BlackSwaptionEngine (3) Linux Manual Page

    QuantLib::BlackSwaptionEngine – Black-formula swaption engine. Synopsis#include <ql/pricingengines/swaption/blackswaptionengine.hpp> Inherits QuantLib::Swaption::engine. Public Member FunctionsBlackSwaptionEngine (const Handle< YieldTermStructure > &termStructure, Volatility vol, const DayCounter &dc=Actual365Fixed()) BlackSwaptionEngine (const Handle< YieldTermStructure > &termStructure, const Handle< Quote > &vol, const DayCounter &dc=Actual365Fixed()) BlackSwaptionEngine (const Handle< YieldTermStructure > &discountCurve, const Handle< SwaptionVolatilityStructure > &vol) void calculate () const Handle< YieldTermStructure > termStructure…

  • |

    BlackScholesProcess (3) Linux Manual Page

    ql/processes/blackscholesprocess.hpp – Black-Scholes processes. Synopsis#include <ql/stochasticprocess.hpp> #include <ql/processes/eulerdiscretization.hpp> #include <ql/termstructures/yieldtermstructure.hpp> #include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> #include <ql/termstructures/volatility/equityfx/localvoltermstructure.hpp> #include <ql/quote.hpp> Classesclass GeneralizedBlackScholesProcess Generalized Black-Scholes stochastic process. class BlackScholesProcess Black-Scholes (1973) stochastic process. class BlackScholesMertonProcess Merton (1973) extension to the Black-Scholes stochastic process. class BlackProcess Black (1976) stochastic process. class GarmanKohlagenProcess Garman-Kohlhagen (1983) stochastic process. Detailed DescriptionBlack-Scholes processes. AuthorGenerated automatically…

  • |

    BlackScholesMertonProcess (3) Linux Manual Page

    QuantLib::BlackScholesMertonProcess – Merton (1973) extension to the Black-Scholes stochastic process. Synopsis#include <ql/processes/blackscholesprocess.hpp> Inherits QuantLib::GeneralizedBlackScholesProcess. Public Member FunctionsBlackScholesMertonProcess (const Handle< Quote > &x0, const Handle< YieldTermStructure > &dividendTS, const Handle< YieldTermStructure > &riskFreeTS, const Handle< BlackVolTermStructure > &blackVolTS, const boost::shared_ptr< discretization > &d=boost::shared_ptr< discretization >(new EulerDiscretization)) Detailed DescriptionMerton (1973) extension to the Black-Scholes stochastic process. This…

  • |

    BlackScholesLattice (3) Linux Manual Page

    QuantLib::BlackScholesLattice – Simple binomial lattice approximating the Black-Scholes model. Synopsis#include <ql/methods/lattices/bsmlattice.hpp> Inherits TreeLattice1D< BlackScholesLattice< T > >. Public Member FunctionsBlackScholesLattice (const boost::shared_ptr< T > &tree, Rate riskFreeRate, Time end, Size steps) Size size (Size i) const DiscountFactor discount (Size, Size) const void stepback (Size i, const Array &values, Array &newValues) const Real underlying (Size i,…

  • |

    BlackScholesCalculator (3) Linux Manual Page

    QuantLib::BlackScholesCalculator – Black-Scholes 1973 calculator class. Synopsis#include <ql/pricingengines/blackscholescalculator.hpp> Inherits QuantLib::BlackCalculator. Public Member FunctionsBlackScholesCalculator (const boost::shared_ptr< StrikedTypePayoff > &payoff, Real spot, DiscountFactor growth, Real stdDev, DiscountFactor discount) Real delta () const Real elasticity () const Real gamma () const Real theta (Time maturity) const Real thetaPerDay (Time maturity) const Protected AttributesReal spot_ DiscountFactor growth_ Detailed DescriptionBlack-Scholes…

  • |

    BlackProcess (3) Linux Manual Page

    QuantLib::BlackProcess – Black (1976) stochastic process. Synopsis#include <ql/processes/blackscholesprocess.hpp> Inherits QuantLib::GeneralizedBlackScholesProcess. Public Member FunctionsBlackProcess (const Handle< Quote > &x0, const Handle< YieldTermStructure > &riskFreeTS, const Handle< BlackVolTermStructure > &blackVolTS, const boost::shared_ptr< discretization > &d=boost::shared_ptr< discretization >(new EulerDiscretization)) Detailed DescriptionBlack (1976) stochastic process. This class describes the stochastic process for a forward or futures contract given by…

  • |

    BlackPixelOfScreen (3) Linux Manual Page

    BlackPixelOfScreen, WhitePixelOfScreen, CellsOfScreen, DefaultColormapOfScreen, DefaultDepthOfScreen, DefaultGCOfScreen, DefaultVisualOfScreen, DoesBackingStore, DoesSaveUnders, DisplayOfScreen, XScreenNumberOfScreen, EventMaskOfScreen, HeightOfScreen, HeightMMOfScreen, MaxCmapsOfScreen, MinCmapsOfScreen, PlanesOfScreen, RootWindowOfScreen, WidthOfScreen, WidthMMOfScreen – screen information functions and macros Syntaxunsigned long BlackPixelOfScreen(Screen *screen); unsigned long WhitePixelOfScreen(Screen *screen); int CellsOfScreen(Screen *screen); Colormap DefaultColormapOfScreen(Screen *screen); int DefaultDepthOfScreen(Screen *screen); GC DefaultGCOfScreen(Screen *screen); Visual *DefaultVisualOfScreen(Screen *screen); int DoesBackingStore(Screen *screen); Bool DoesSaveUnders(Screen *screen);…

  • |

    BlackPixel (3) Linux Manual Page

    AllPlanes, BlackPixel, WhitePixel, ConnectionNumber, DefaultColormap, DefaultDepth, XListDepths, DefaultGC, DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize, LastKnownRequestProcessed, NextRequest, ProtocolVersion, ProtocolRevision, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease – Display macros and functions Syntaxunsigned long AllPlanes; unsigned long BlackPixel(Display *display, int screen_number); unsigned long WhitePixel(Display *display, int screen_number); int ConnectionNumber(Display *display); Colormap DefaultColormap(Display *display, int screen_number);…

  • |

    BlackKarasinski (3) Linux Manual Page

    ql/models/shortrate/onefactormodels/blackkarasinski.hpp – Black-Karasinski model. Synopsis#include <ql/models/shortrate/onefactormodel.hpp> #include <ql/processes/ornsteinuhlenbeckprocess.hpp> Classesclass BlackKarasinski Standard Black-Karasinski model class. class Dynamics Short-rate dynamics in the Black-Karasinski model. Detailed DescriptionBlack-Karasinski model. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    BlackIborCouponPricer (3) Linux Manual Page

    QuantLib::BlackIborCouponPricer – Black-formula pricer for capped/floored Ibor coupons. Synopsis#include <ql/cashflows/couponpricer.hpp> Inherits QuantLib::IborCouponPricer. Inherited by BlackIborQuantoCouponPricer. Public Member FunctionsBlackIborCouponPricer (const Handle< OptionletVolatilityStructure > &v=Handle< OptionletVolatilityStructure >()) virtual void initialize (const FloatingRateCoupon &coupon) Real swapletPrice () const Rate swapletRate () const Real capletPrice (Rate effectiveCap) const Rate capletRate (Rate effectiveCap) const Real floorletPrice (Rate effectiveFloor) const Rate…

  • |

    BlackConstantVol (3) Linux Manual Page

    ql/termstructures/volatility/equityfx/blackconstantvol.hpp – Black constant volatility, no time dependence, no strike dependence. Synopsis#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp> #include <ql/quotes/simplequote.hpp> #include <ql/time/daycounters/actual365fixed.hpp> Classesclass BlackConstantVol Constant Black volatility, no time-strike dependence. Detailed DescriptionBlack constant volatility, no time dependence, no strike dependence. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    BlackCapFloorEngine (3) Linux Manual Page

    QuantLib::BlackCapFloorEngine – Black-formula cap/floor engine. Synopsis#include <ql/pricingengines/capfloor/blackcapfloorengine.hpp> Inherits QuantLib::CapFloor::engine. Public Member FunctionsBlackCapFloorEngine (const Handle< YieldTermStructure > &termStructure, Volatility vol, const DayCounter &dc=Actual365Fixed()) BlackCapFloorEngine (const Handle< YieldTermStructure > &termStructure, const Handle< Quote > &vol, const DayCounter &dc=Actual365Fixed()) BlackCapFloorEngine (const Handle< YieldTermStructure > &discountCurve, const Handle< OptionletVolatilityStructure > &vol) void calculate () const Handle< YieldTermStructure > termStructure…

  • |

    BlackCallableZeroCouponBondEngine (3) Linux Manual Page

    QuantLib::BlackCallableZeroCouponBondEngine – Black-formula callable zero coupon bond engine. Synopsis#include <ql/experimental/callablebonds/blackcallablebondengine.hpp> Inherits QuantLib::BlackCallableFixedRateBondEngine. Public Member FunctionsBlackCallableZeroCouponBondEngine (const Handle< Quote > &fwdYieldVol, const Handle< YieldTermStructure > &discountCurve) volatility is the quoted fwd yield volatility, not price vol BlackCallableZeroCouponBondEngine (const Handle< CallableBondVolatilityStructure > &yieldVolStructure, const Handle< YieldTermStructure > &discountCurve) volatility is the quoted fwd yield volatility, not price…

  • |

    BlackCallableFixedRateBondEngine (3) Linux Manual Page

    QuantLib::BlackCallableFixedRateBondEngine – Black-formula callable fixed rate bond engine. Synopsis#include <ql/experimental/callablebonds/blackcallablebondengine.hpp> Inherits QuantLib::CallableBond::engine. Inherited by BlackCallableZeroCouponBondEngine. Public Member FunctionsBlackCallableFixedRateBondEngine (const Handle< Quote > &fwdYieldVol, const Handle< YieldTermStructure > &discountCurve) volatility is the quoted fwd yield volatility, not price vol BlackCallableFixedRateBondEngine (const Handle< CallableBondVolatilityStructure > &yieldVolStructure, const Handle< YieldTermStructure > &discountCurve) volatility is the quoted fwd yield…