bbldc_basicactual36525

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Computing Day Count and Year Fraction

Purpose

Provide stateless functions for the Actual/365.25 convention.

Classes

• bbldc::BasicActual36525: Actual/365.25 convention stateless functions

Description

This component provides a struct, bbldc::BasicActual36525, that serves as a namespace for defining a suite of date-related functions used to compute the day count and year fraction between two dates as per the Actual/365.25 day-count convention. In this day-count convention, we simply measure the number of days occurring in a time period, and to calculate years, divide that by 365.25. Note that this means the number of years between January 1, 2004 and January 1, 2005 comes out to about 1.00205. No end-of-month rule adjustments are made. Given beginDate and endDate:

yearsDiff ::= sign(endDate - beginDate) *
                              (days between beginDate and endDate) / 365.25

Usage

This section illustrates intended use of this component.

Example 1: Computing Day Count and Year Fraction

The following snippets of code illustrate how to use bbldc::BasicActual36525 methods. First, create four bdlt::Date variables:

const bdlt::Date dA(2004, 2, 1);
const bdlt::Date dB(2004, 3, 1);
const bdlt::Date dC(2004, 5, 1);
const bdlt::Date dD(2005, 2, 1);

Then, compute the day count between some pairs of these dates:

int daysDiff;
daysDiff = bbldc::BasicActual36525::daysDiff(dA, dB);
assert( 29 == daysDiff);
daysDiff = bbldc::BasicActual36525::daysDiff(dA, dC);
assert( 90 == daysDiff);
daysDiff = bbldc::BasicActual36525::daysDiff(dA, dD);
assert(366 == daysDiff);
daysDiff = bbldc::BasicActual36525::daysDiff(dB, dC);
assert( 61 == daysDiff);

Finally, compute the year fraction between some of the dates:

double yearsDiff;
yearsDiff = bbldc::BasicActual36525::yearsDiff(dA, dC);
// Need fuzzy comparison since 'yearsDiff' is a 'double'.
assert(yearsDiff > 0.2464 && yearsDiff < 0.2465);
yearsDiff = bbldc::BasicActual36525::yearsDiff(dA, dD);
assert(yearsDiff > 1.0020 && yearsDiff < 1.0021);