Return the (signed fractional) number of years between two dates.

Synopsis

Declared in <bbldc_calendarbus252.h>

static
double
yearsDiff(
    bdlt::Date const& beginDate,
    bdlt::Date const& endDate,
    bdlt::Calendar const& calendar);

Description

Return the (signed fractional) number of years between the specified beginDate and endDate according to the BUS‐252 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 calendar.isInRange(beginDate) and calendar.isInRange(endDate). Note that reversing the order of beginDate and endDate negates the result; specifically, |yearsDiff(b, e, c) + yearsDiff(e, b, c)| <= 1.0e‐15 for all calendars c and valid dates b and e.

Return Value

the signed fractional number of years between the dates

Parameters

Name

Description

beginDate

start of the date range

endDate

end of the date range

calendar

calendar defining business days

Created with MrDocs