Return the (signed) number of days between two dates.

Synopsis

Declared in <bbldc_calendardaycountutil.h>

static
int
daysDiff(
    bdlt::Date const& beginDate,
    bdlt::Date const& endDate,
    bdlt::Calendar const& calendar,
    DayCountConvention::Enum convention);

Description

Return the (signed) number of days between the specified beginDate and endDate according to the specified day‐count convention with the specified calendar providing the definition of business days. If beginDate <= endDate then the result is non‐negative. The behavior is undefined unless isSupported(convention), calendar.isInRange(beginDate), and calendar.isInRange(endDate). Note that reversing the order of beginDate and endDate negates the result and that the result is 0 when beginDate == endDate.

Return Value

signed day difference according to convention

Parameters

Name

Description

beginDate

start of the date range

endDate

end of the date range

calendar

calendar defining business days

convention

day‐count convention to apply

Created with MrDocs