Linux Manuals session 3

Section 3: library functions

  • |

    ConstantCapFloorTermVolatility (3) Linux Manual Page

    QuantLib::ConstantCapFloorTermVolatility – Constant caplet volatility, no time-strike dependence. Synopsis#include <ql/termstructures/volatility/capfloor/constantcapfloortermvol.hpp> Inherits QuantLib::CapFloorTermVolatilityStructure. Public Member FunctionsConstantCapFloorTermVolatility (Natural settlementDays, const Calendar &cal, BusinessDayConvention bdc, const Handle< Quote > &volatility, const DayCounter &dc) floating reference date, floating market data ConstantCapFloorTermVolatility (const Date &referenceDate, const Calendar &cal, BusinessDayConvention bdc, const Handle< Quote > &volatility, const DayCounter &dc) fixed reference…

  • |

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

  • |

    ConjugateGradient (3) Linux Manual Page

    QuantLib::ConjugateGradient – Multi-dimensional Conjugate Gradient class. Synopsis#include <ql/math/optimization/conjugategradient.hpp> Inherits QuantLib::LineSearchBasedMethod. Public Member FunctionsConjugateGradient (const boost::shared_ptr< LineSearch > &lineSearch=boost::shared_ptr< LineSearch >()) virtual EndCriteria::Type minimize (Problem &P, const EndCriteria &endCriteria) solve the optimization problem P Detailed DescriptionMulti-dimensional Conjugate Gradient class. Fletcher-Reeves-Polak-Ribiere algorithm adapted from Numerical Recipes in C, 2nd edition. User has to provide line-search method and…

  • |

    Configure::Writer (3) Linux Manual Page

    XMLTV::Configure::Writer – Configuration file writer for XMLTV grabbers DescriptionUtility class that helps grabbers write configuration descriptions. Synopsis use XMLTV::Configure::Writer; my $result; my $writer = new XMLTV::Writer::Configure( OUTPUT => \$result, encoding => ‘iso-8859-1’ ); $writer->start( { grabber => ‘tv_grab_xxx’ } ); $writer->write_string( { id => ‘username’, title => [ [ ‘Username’, ‘en’ ], [ ‘Anva.ndarnamn’, ‘sv’…

  • |

    Configure (3) Linux Manual Page

    XMLTV::Configure – Configuration file handling for XMLTV grabbers DescriptionUtility library that helps grabbers read from configuration files and implement a configuration method that can be run from the command-line. Exported FunctionsAll these functions are exported on demand. LoadConfig Takes the name of the configuration file to load as a parameter. Returns a hashref with configuration…

  • |

    CompoundForward (3) Linux Manual Page

    QuantLib::CompoundForward – compound-forward structure Synopsis#include <ql/legacy/termstructures/compoundforward.hpp> Inherits QuantLib::ForwardRateStructure. Public Member FunctionsCompoundForward (const Date &referenceDate, const std::vector< Date > &dates, const std::vector< Rate > &forwards, const Calendar &calendar, const BusinessDayConvention conv, const Integer compounding, const DayCounter &dayCounter) BusinessDayConvention businessDayConvention () const Integer compounding () const Date maxDate () const the latest date for which the curve…

  • |

    CompositeQuote (3) Linux Manual Page

    ql/quotes/compositequote.hpp – purely virtual base class for market observables Synopsis#include <ql/quote.hpp> #include <ql/types.hpp> #include <ql/handle.hpp> #include <ql/errors.hpp> Classesclass CompositeQuote< BinaryFunction > market element whose value depends on two other market element Detailed Descriptionpurely virtual base class for market observables AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    Composite (3) Linux Manual Page

    Composite — The Composite widget class Synopsis#include <Xm/Xm.h>DescriptionComposite widgets are intended to be containers for other widgets and can have an arbitrary number of children. Their responsibilities (implemented either directly by the widget class or indirectly by Intrinsics functions) include: • Overall management of children from creation to destruction. • Destruction of descendants when the…

  • |

    CommodityType (3) Linux Manual Page

    QuantLib::CommodityCurve – Commodity term structure. Synopsis#include <ql/experimental/commodities/commoditycurve.hpp> Inherits QuantLib::TermStructure. Public Member FunctionsCommodityCurve (const std::string &name, const CommodityType &commodityType, const Currency &currency, const UnitOfMeasure &unitOfMeasure, const Calendar &calendar, const std::vector< Date > &dates, const std::vector< Real > &prices, const DayCounter &dayCounter=Actual365Fixed()) CommodityCurve (const std::string &name, const CommodityType &commodityType, const Currency &currency, const UnitOfMeasure &unitOfMeasure, const Calendar…

  • |

    CommodityIndex (3) Linux Manual Page

    ql/experimental/commodities/commodityindex.hpp – Commodity index. Synopsis#include <ql/experimental/commodities/commoditycurve.hpp> #include <ql/indexes/indexmanager.hpp> Classesclass CommodityIndex base class for commodity indexes Functionsbool operator== (const CommodityIndex &i1, const CommodityIndex &i2) Detailed DescriptionCommodity index. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    CommodityCurve (3) Linux Manual Page

    ql/experimental/commodities/commoditycurve.hpp – Commodity curve. Synopsis#include <ql/termstructure.hpp> #include <ql/experimental/commodities/commoditytype.hpp> #include <ql/experimental/commodities/unitofmeasure.hpp> #include <ql/experimental/commodities/exchangecontract.hpp> #include <ql/currency.hpp> #include <ql/math/interpolations/forwardflatinterpolation.hpp> Classesclass CommodityCurve Commodity term structure. Functionsbool operator== (const CommodityCurve &c1, const CommodityCurve &c2) Detailed DescriptionCommodity curve. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    CommodityCashFlows (3) Linux Manual Page

    ql/experimental/commodities/commoditycashflow.hpp – Commodity cash flow. Synopsis#include <ql/cashflow.hpp> #include <ql/money.hpp> #include <map> Typedefstypedef std::map< Date, boost::shared_ptr< CommodityCashFlow > > CommodityCashFlows Functionsstd::ostream & operator<< (std::ostream &out, const SecondaryCostAmounts &secondaryCostAmounts) Detailed DescriptionCommodity cash flow. AuthorGenerated automatically by Doxygen for QuantLib from the source code.

  • |

    Commodity (3) Linux Manual Page

    ql/experimental/commodities/commodity.hpp – Commodity base class. Synopsis#include <ql/instrument.hpp> #include <ql/money.hpp> #include <vector> #include <ostream> Classesclass Commodity Commodity base class. Typedefstypedef std::map< std::string, boost::any > SecondaryCosts typedef std::map< std::string, Money > SecondaryCostAmounts typedef std::vector< PricingError > PricingErrors Functionsstd::ostream & operator<< (std::ostream &out, const SecondaryCostAmounts &secondaryCostAmounts) std::ostream & operator<< (std::ostream &out, const PricingError &error) std::ostream & operator<< (std::ostream…

  • |

    CmsRateBond (3) Linux Manual Page

    QuantLib::CmsRateBond – CMS-rate bond. Synopsis#include <ql/instruments/bonds/cmsratebond.hpp> Inherits QuantLib::Bond. Public Member FunctionsCmsRateBond (Natural settlementDays, Real faceAmount, const Schedule &schedule, const boost::shared_ptr< SwapIndex > &index, const DayCounter &paymentDayCounter, BusinessDayConvention paymentConvention=Following, Natural fixingDays=Null< Natural >(), const std::vector< Real > &gearings=std::vector< Real >(1, 1.0), const std::vector< Spread > &spreads=std::vector< Spread >(1, 0.0), const std::vector< Rate > &caps=std::vector< Rate >(),…

  • |

    CmsMarket (3) Linux Manual Page

    QuantLib::CmsMarket – set of CMS quotes Synopsis#include <ql/termstructures/volatility/swaption/cmsmarket.hpp> Inherits QuantLib::LazyObject. Public Member FunctionsCmsMarket (const std::vector< Period > &swapLengths, const std::vector< boost::shared_ptr< SwapIndex > > &swapIndexes, const boost::shared_ptr< IborIndex > &iborIndex, const std::vector< std::vector< Handle< Quote > > > &bidAskSpreads, const std::vector< boost::shared_ptr< HaganPricer > > &pricers, const Handle< YieldTermStructure > &discountingTS) void reprice (const Handle<…

  • |

    CmsLeg (3) Linux Manual Page

    QuantLib::CmsLeg – helper class building a sequence of capped/floored cms-rate coupons Synopsis#include <ql/cashflows/cmscoupon.hpp> Public Member FunctionsCmsLeg (const Schedule &schedule, const boost::shared_ptr< SwapIndex > &swapIndex) CmsLeg & withNotionals (Real notional) CmsLeg & withNotionals (const std::vector< Real > &notionals) CmsLeg & withPaymentDayCounter (const DayCounter &) CmsLeg & withPaymentAdjustment (BusinessDayConvention) CmsLeg & withFixingDays (Natural fixingDays) CmsLeg & withFixingDays…

  • |

    CmsCouponPricer (3) Linux Manual Page

    QuantLib::CmsCouponPricer – base pricer for vanilla CMS coupons Synopsis#include <ql/cashflows/couponpricer.hpp> Inherits QuantLib::FloatingRateCouponPricer. Inherited by HaganPricer. Public Member FunctionsCmsCouponPricer (const Handle< SwaptionVolatilityStructure > &v=Handle< SwaptionVolatilityStructure >()) Handle< SwaptionVolatilityStructure > swaptionVolatility () const void setSwaptionVolatility (const Handle< SwaptionVolatilityStructure > &v=Handle< SwaptionVolatilityStructure >()) Detailed Descriptionbase pricer for vanilla CMS coupons AuthorGenerated automatically by Doxygen for QuantLib from the…

  • |

    CmsCoupon (3) Linux Manual Page

    QuantLib::CmsCoupon – CMS coupon class. Synopsis#include <ql/cashflows/cmscoupon.hpp> Inherits QuantLib::FloatingRateCoupon. Public Member FunctionsCmsCoupon (const Date &paymentDate, const Real nominal, const Date &startDate, const Date &endDate, const Natural fixingDays, const boost::shared_ptr< SwapIndex > &index, const Real gearing=1.0, const Spread spread=0.0, const Date &refPeriodStart=Date(), const Date &refPeriodEnd=Date(), const DayCounter &dayCounter=DayCounter(), bool isInArrears=false) Inspectors const boost::shared_ptr< SwapIndex > &…

  • |

    Closest (3) Linux Manual Page

    QuantLib::Rounding – basic rounding class Synopsis#include <ql/math/rounding.hpp> Inherited by CeilingTruncation, ClosestRounding, DownRounding, FloorTruncation, and UpRounding. Public Typesenum Type { None, Up, Down, Closest, Floor, Ceiling } rounding methods Public Member FunctionsRounding () default constructor Rounding (Integer precision, Type type=Closest, Integer digit=5) Decimal operator() (Decimal value) const perform rounding InspectorsInteger precision () const Type type ()…