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

Synopsis

Declared in <bbldc_basicdaycountutil.h>

static
double
yearsDiff(
    bdlt::Date const& beginDate,
    bdlt::Date const& endDate,
    DayCountConvention::Enum convention);

Description

Return the (signed fractional) number of years between the specified beginDate and endDate according to the specified day‐count convention. If beginDate <= endDate then the result is non‐negative. The behavior is undefined unless isSupported(convention). 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 dates b and e, and day‐count conventions c.

Return Value

signed fractional year difference according to convention

Parameters

Name

Description

beginDate

start of the date range

endDate

end of the date range

convention

day‐count convention to apply

Created with MrDocs