Linux Manuals session 3

Section 3: library functions

  • |

    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_…

  • |

    DiscreteGeometricASO (3) Linux Manual Page

    ql/legacy/pricers/discretegeometricaso.hpp – Discrete geometric average-strike Asian option. Synopsis#include <ql/legacy/pricers/singleassetoption.hpp> #include <ql/math/distributions/normaldistribution.hpp> #include <vector> Classesclass DiscreteGeometricASO Discrete geometric average-strike Asian option (European style). Detailed DescriptionDiscrete geometric average-strike Asian option. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    DiscreteAveragingAsianOption (3) Linux Manual Page

    QuantLib::DiscreteAveragingAsianOption – Discrete-averaging Asian option. Synopsis#include <ql/instruments/asianoption.hpp> Inherits QuantLib::OneAssetOption. Classesclass arguments Extra arguments for single-asset discrete-average Asian option. class engine Discrete-averaging Asian engine base class. Public Member FunctionsDiscreteAveragingAsianOption (Average::Type averageType, Real runningAccumulator, Size pastFixings, const std::vector< Date > &fixingDates, const boost::shared_ptr< StrikedTypePayoff > &payoff, const boost::shared_ptr< Exercise > &exercise) void setupArguments (PricingEngine::arguments *) const Protected…

  • |

    DiscrepancyStatistics (3) Linux Manual Page

    QuantLib::DiscrepancyStatistics – Statistic tool for sequences with discrepancy calculation. Synopsis#include <ql/math/statistics/discrepancystatistics.hpp> Inherits GenericSequenceStatistics< Statistics >. Public Typestypedef SequenceStatistics::value_type value_type Public Member FunctionsDiscrepancyStatistics (Size dimension) template<class Sequence > void add (const Sequence &sample, Real weight=1.0) template<class Iterator > void add (Iterator begin, Iterator end, Real weight=1.0) void reset (Size dimension=0) 1-dimensional inspectors Real discrepancy () const…

  • |

    DiscountFactor (3) Linux Manual Page

    QuantLib::InterestRate – Concrete interest rate class. Synopsis#include <ql/interestrate.hpp> Public Member Functionsconstructors InterestRate () Default constructor returning a null interest rate. InterestRate (Rate r, const DayCounter &dc=Actual365Fixed(), Compounding comp=Continuous, Frequency freq=Annual) Standard constructor. conversions operator Rate () const inspectors Rate rate () const const DayCounter & dayCounter () const Compounding compounding () const Frequency frequency ()…

  • |

    DiscountCurve (3) Linux Manual Page

    ql/termstructures/yield/discountcurve.hpp – interpolated discount factor structure Synopsis#include <ql/termstructures/yieldtermstructure.hpp> #include <ql/math/interpolations/loginterpolation.hpp> #include <ql/math/comparison.hpp> #include <boost/noncopyable.hpp> #include <vector> #include <utility> Classesclass InterpolatedDiscountCurve< Interpolator > Term structure based on interpolation of discount factors. Typedefstypedef InterpolatedDiscountCurve< LogLinear > DiscountCurve Term structure based on log-linear interpolation of discount factors. Detailed Descriptioninterpolated discount factor structure AuthorGenerated automatically by Doxygen for QuantLib…

  • |

    DirichletBC (3) Linux Manual Page

    QuantLib::DirichletBC – Neumann boundary condition (i.e., constant value). Synopsis#include <ql/methods/finitedifferences/boundarycondition.hpp> Inherits BoundaryCondition< TridiagonalOperator >. Public Member FunctionsDirichletBC (Real value, Side side) void applyBeforeApplying (TridiagonalOperator &) const void applyAfterApplying (Array &) const void applyBeforeSolving (TridiagonalOperator &, Array &rhs) const void applyAfterSolving (Array &) const void setTime (Time) Detailed DescriptionNeumann boundary condition (i.e., constant value). Possible enhancements…

  • |

    Direct (3) Linux Manual Page

    QuantLib::ExchangeRate – exchange rate between two currencies Synopsis#include <ql/exchangerate.hpp> Public Typesenum Type { Direct, Derived } Public Member FunctionsConstructors ExchangeRate () ExchangeRate (const Currency &source, const Currency &target, Decimal rate) Inspectors const Currency & source () const the source currency. const Currency & target () const the target currency. Type type () const the type…