RcppBDT Date functions: Date accessor and construction functions from Boost Date_Time

Description

This constants are provided for convenience. In the C++ sources, enumeration types are used for days of the week, months of the year as well as the ordering terms.

Similar package-level constants are provided here as well. This should be considered as experimental and may be withdrawn in a later version of the package.

Usage

getEndOfBizWeek(date)
getEndOfMonth(date)
getYear(date)
getMonth(date)
getDay(date)
getDayOfWeek(date)
getDayOfYear(date)
getIMMDate(mon, year)
getNthDayOfWeek(nthday, dow, mon, year)
getLastDayOfWeekInMonth(nthday, mon, year) 
getFirstDayOfWeekInMonth(nthday, mon, year) 
getFirstDayOfWeekAfter(dow, date) 
getLastDayOfWeekBefore(dow, date)

Arguments

date

a Date object

mon

a month, specified either as an integer or one of the constants Jan, Feb, ... defined in this package

year

a four-digit year, specified as an integer

nthday

either an integer between 1 and 5, or one of the constants first, second, ... fifth defined in this package.

dow

either an integer between 0 and 6 denoting a day of the week, or one of the constants Sun, Mon, ... Sat defined in this package.

Value

All functions return a Date object.

Details

Details of the Boost functions are provided by the Boost documentation.

References

Boost Date_Time: http://www.boost.org/doc/html/date_time.html