QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.6
Public Types | Public Member Functions | List of all members
UnitedStates Class Reference

United States calendars. More...

#include <ql/time/calendars/unitedstates.hpp>

+ Inheritance diagram for UnitedStates:

Public Types

enum  Market { Settlement, NYSE, GovernmentBond, NERC }
 US calendars. More...
 

Public Member Functions

 UnitedStates (Market market=Settlement)
 
- Public Member Functions inherited from Calendar
 Calendar ()
 
bool empty () const
 Returns whether or not the calendar is initialized.
 
std::string name () const
 Returns the name of the calendar. More...
 
bool isBusinessDay (const Date &d) const
 
bool isHoliday (const Date &d) const
 
bool isWeekend (Weekday w) const
 
bool isEndOfMonth (const Date &d) const
 
Date endOfMonth (const Date &d) const
 last business day of the month to which the given date belongs
 
void addHoliday (const Date &)
 
void removeHoliday (const Date &)
 
Date adjust (const Date &, BusinessDayConvention convention=Following) const
 
Date advance (const Date &, Integer n, TimeUnit unit, BusinessDayConvention convention=Following, bool endOfMonth=false) const
 
Date advance (const Date &date, const Period &period, BusinessDayConvention convention=Following, bool endOfMonth=false) const
 
BigInteger businessDaysBetween (const Date &from, const Date &to, bool includeFirst=true, bool includeLast=false) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Calendar
static std::vector< DateholidayList (const Calendar &calendar, const Date &from, const Date &to, bool includeWeekEnds=false)
 Returns the holidays between two dates.
 
- Protected Attributes inherited from Calendar
boost::shared_ptr< Implimpl_
 

Detailed Description

United States calendars.

Public holidays (see: http://www.opm.gov/fedhol/):

Holidays for the stock exchange (data from http://www.nyse.com):

Holidays for the government bond market (data from http://www.bondmarkets.com):

Holidays for the North American Energy Reliability Council (data from http://www.nerc.com/~oc/offpeaks.html):

Tests:
the correctness of the returned results is tested against a list of known holidays.
Examples:
Bonds.cpp, and CallableBonds.cpp.