Linux Manuals session 3

Section 3: library functions

  • |

    DoubleStickyRatchetPayoff (3) Linux Manual Page

    QuantLib::DoubleStickyRatchetPayoff – Intermediate class for single/double sticky/ratchet payoffs. Synopsis#include <ql/instruments/stickyratchet.hpp> Inherits QuantLib::Payoff. Inherited by RatchetMaxPayoff, RatchetMinPayoff, RatchetPayoff, StickyMaxPayoff, StickyMinPayoff, and StickyPayoff. Public Member FunctionsDoubleStickyRatchetPayoff (Real type1, Real type2, Real gearing1, Real gearing2, Real gearing3, Real spread1, Real spread2, Real spread3, Real initialValue1, Real initialValue2, Real accrualFactor) Payoff interface std::string name () const Real operator() (Real…

  • |

    DotProduct (3) Linux Manual Page

    QuantLib::Array – 1-D array used in linear algebra. Synopsis#include <ql/math/array.hpp> Public Typestypedef Real value_type typedef Real * iterator typedef const Real * const_iterator typedef boost::reverse_iterator< iterator > reverse_iterator typedef boost::reverse_iterator< const_iterator > const_reverse_iterator Public Member FunctionsConstructors, destructor, and assignment Array (Size size=0) creates the array with the given dimension Array (Size size, Real value) creates…

  • |

    DoesSaveUnders (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);…

  • |

    DoesBackingStore (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);…

  • |

    DividendVector (3) Linux Manual Page

    ql/cashflows/dividend.hpp – A stock dividend. Synopsis#include <ql/cashflow.hpp> #include <ql/utilities/null.hpp> #include <vector> Classesclass Dividend Predetermined cash flow. class FixedDividend Predetermined cash flow. class FractionalDividend Predetermined cash flow. Functionsstd::vector< boost::shared_ptr< Dividend > > DividendVector (const std::vector< Date > &dividendDates, const std::vector< Real > &dividends) helper function building a sequence of fixed dividends Detailed DescriptionA stock dividend. AuthorGenerated…

  • |

    DividendVanillaOption (3) Linux Manual Page

    ql/instruments/dividendvanillaoption.hpp – Vanilla option on a single asset with discrete dividends. Synopsis#include <ql/instruments/oneassetoption.hpp> #include <ql/instruments/dividendschedule.hpp> #include <ql/instruments/payoffs.hpp> Classesclass DividendVanillaOption Single-asset vanilla option (no barriers) with discrete dividends. class arguments Arguments for dividend vanilla option calculation class engine Dividend-vanilla-option engine base class Detailed DescriptionVanilla option on a single asset with discrete dividends. AuthorGenerated automatically by Doxygen…

  • |

    DividendBarrierOption (3) Linux Manual Page

    ql/experimental/finitedifferences/dividendbarrieroption.hpp – Barrier option on a single asset with discrete dividends. Synopsis#include <ql/instruments/barrieroption.hpp> #include <ql/instruments/dividendschedule.hpp> #include <ql/instruments/payoffs.hpp> Classesclass DividendBarrierOption Single-asset barrier option with discrete dividends. class arguments Arguments for dividend barrier option calculation class engine Dividend-barrier-option engine base class Detailed DescriptionBarrier option on a single asset with discrete dividends. AuthorGenerated automatically by Doxygen for QuantLib…

  • |

    Dividend (3) Linux Manual Page

    ql/cashflows/dividend.hpp – A stock dividend. Synopsis#include <ql/cashflow.hpp> #include <ql/utilities/null.hpp> #include <vector> Classesclass Dividend Predetermined cash flow. class FixedDividend Predetermined cash flow. class FractionalDividend Predetermined cash flow. Functionsstd::vector< boost::shared_ptr< Dividend > > DividendVector (const std::vector< Date > &dividendDates, const std::vector< Real > &dividends) helper function building a sequence of fixed dividends Detailed DescriptionA stock dividend. AuthorGenerated…

  • |

    DivYieldFunction (3) Linux Manual Page

    QuantLib::SingleAssetOption – Black-Scholes-Merton option. Synopsis#include <ql/legacy/pricers/singleassetoption.hpp> Inherited by DiscreteGeometricASO. Public Member FunctionsSingleAssetOption (Option::Type type, Real underlying, Real strike, Spread dividendYield, Rate riskFreeRate, Time residualTime, Volatility volatility) virtual void setVolatility (Volatility newVolatility) virtual void setRiskFreeRate (Rate newRate) virtual void setDividendYield (Rate newDividendYield) virtual Real value () const =0 virtual Real delta () const =0 virtual Real…

  • |

    Disposable (3) Linux Manual Page

    QuantLib::Disposable – generic disposable object with move semantics Synopsis#include <ql/utilities/disposable.hpp> Inherits T. Public Member FunctionsDisposable (T &t) Disposable (const Disposable< T > &t) Disposable< T > & operator= (const Disposable< T > &t) Detailed Descriptiontemplate<class T> class QuantLib::Disposable< T >generic disposable object with move semantics This class can be used for returning a value by…

  • |

    DisplayWidthMM (3) Linux Manual Page

    ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues – image format functions and macros SyntaxXPixmapFormatValues *XListPixmapFormats(Display *display, int *count_return); int ImageByteOrder(Display *display); int BitmapBitOrder(Display *display); int BitmapPad(Display *display); int BitmapUnit(Display *display); int DisplayHeight(Display *display, int screen_number); int DisplayHeightMM(Display *display, int screen_number); int DisplayWidth(Display *display, int screen_number); int DisplayWidthMM(Display *display, int screen_number);Argumentsdisplay Specifies the…

  • |

    DisplayWidth (3) Linux Manual Page

    ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues – image format functions and macros SyntaxXPixmapFormatValues *XListPixmapFormats(Display *display, int *count_return); int ImageByteOrder(Display *display); int BitmapBitOrder(Display *display); int BitmapPad(Display *display); int BitmapUnit(Display *display); int DisplayHeight(Display *display, int screen_number); int DisplayHeightMM(Display *display, int screen_number); int DisplayWidth(Display *display, int screen_number); int DisplayWidthMM(Display *display, int screen_number);Argumentsdisplay Specifies the…

  • |

    DisplayString (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);…

  • |

    DisplayPlanes (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);…

  • |

    DisplayOfScreen (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);…

  • |

    DisplayOfCCC (3) Linux Manual Page

    DisplayOfCCC, VisualOfCCC, ScreenNumberOfCCC, ScreenWhitePointOfCCC, ClientWhitePointOfCCC – Color Conversion Context macros SyntaxDisplay *DisplayOfCCC(XcmsCCC ccc); Visual *VisualOfCCC(XcmsCCC ccc); int ScreenNumberOfCCC(XcmsCCC ccc); XcmsColor *ScreenWhitePointOfCCC(XcmsCCC ccc); XcmsColor *ClientWhitePointOfCCC(XcmsCCC ccc);Argumentsccc Specifies the CCC.DescriptionThe DisplayOfCCC macro returns the display associated with the specified CCC. The VisualOfCCC macro returns the visual associated with the specified CCC. The ScreenNumberOfCCC macro returns the number…

  • |

    DisplayHeightMM (3) Linux Manual Page

    ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues – image format functions and macros SyntaxXPixmapFormatValues *XListPixmapFormats(Display *display, int *count_return); int ImageByteOrder(Display *display); int BitmapBitOrder(Display *display); int BitmapPad(Display *display); int BitmapUnit(Display *display); int DisplayHeight(Display *display, int screen_number); int DisplayHeightMM(Display *display, int screen_number); int DisplayWidth(Display *display, int screen_number); int DisplayWidthMM(Display *display, int screen_number);Argumentsdisplay Specifies the…

  • |

    DisplayHeight (3) Linux Manual Page

    ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues – image format functions and macros SyntaxXPixmapFormatValues *XListPixmapFormats(Display *display, int *count_return); int ImageByteOrder(Display *display); int BitmapBitOrder(Display *display); int BitmapPad(Display *display); int BitmapUnit(Display *display); int DisplayHeight(Display *display, int screen_number); int DisplayHeightMM(Display *display, int screen_number); int DisplayWidth(Display *display, int screen_number); int DisplayWidthMM(Display *display, int screen_number);Argumentsdisplay Specifies the…

  • |

    DisplayCells (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);…

  • |

    DiscretizedOption (3) Linux Manual Page

    QuantLib::DiscretizedOption – Discretized option on a given asset. Synopsis#include <ql/discretizedasset.hpp> Inherits QuantLib::DiscretizedAsset. Inherited by DiscretizedSwaption. Public Member FunctionsDiscretizedOption (const boost::shared_ptr< DiscretizedAsset > &underlying, Exercise::Type exerciseType, const std::vector< Time > &exerciseTimes) void reset (Size size) std::vector< Time > mandatoryTimes () const Protected Member Functionsvoid postAdjustValuesImpl () void applyExerciseCondition () Protected Attributesboost::shared_ptr< DiscretizedAsset > underlying_ Exercise::Type exerciseType_…