Return the (signed fractional) number of years between two dates.
Declared in <bbldc_terminateddaycountutil.h>
static
double
yearsDiff(
bdlt::Date const& beginDate,
bdlt::Date const& endDate,
bdlt::Date const& terminationDate,
DayCountConvention::Enum convention);Return the (signed fractional) number of years between the specified beginDate and endDate according to the specified day-count convention with the specified terminationDate. 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, t, c) + yearsDiff(e, b, t, c)| <= 1.0e-15 for all valid dates b, e, and t, and day-count conventions c.
signed fractional year difference according to convention
| Name | Description |
|---|---|
| beginDate | start of the date range |
| endDate | end of the date range |
| terminationDate | termination date used by the convention |
| convention | day-count convention to apply |