bbldc_basicpsa30360eom.h

Go to the documentation of this file.

/// @file bbldc_basicpsa30360eom.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bbldc_basicpsa30360eom.h                                           -*-C++-*-
#ifndef INCLUDED_BBLDC_BASICPSA30360EOM
#define INCLUDED_BBLDC_BASICPSA30360EOM
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bbldc_basicpsa30360eom bbldc_basicpsa30360eom
/// @brief  Provide stateless functions for PSA 30/360 end-of-month convention.
/// @addtogroup bbl
/// @{
/// @addtogroup bbldc
/// @{
/// @addtogroup bbldc_basicpsa30360eom
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bbldc_basicpsa30360eom-purpose"> Purpose</a>
/// * <a href="#bbldc_basicpsa30360eom-classes"> Classes </a>
/// * <a href="#bbldc_basicpsa30360eom-description"> Description </a>
///   * <a href="#bbldc_basicpsa30360eom-psa-30360-eom-day-count-algorithm"> PSA 30360-eom Day Count Algorithm </a>
///   * <a href="#bbldc_basicpsa30360eom-usage"> Usage </a>
///     * <a href="#bbldc_basicpsa30360eom-example-1-computing-day-count-and-year-fraction"> Example 1: Computing Day Count and Year Fraction </a>
///
/// # Purpose {#bbldc_basicpsa30360eom-purpose}
/// Provide stateless functions for PSA 30/360 end-of-month convention.
///
/// # Classes {#bbldc_basicpsa30360eom-classes}
///
/// -  bbldc::BasicPsa30360Eom: PSA 30/360 eom convention stateless functions
///
/// # Description {#bbldc_basicpsa30360eom-description}
/// This component provides a `struct`, `bbldc::BasicPsa30360Eom`,
/// 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
/// prescribed by the Public Securities Association (PSA) 30/360 day-count
/// convention with end-of-month (eom) adjustments.
///
/// ## PSA 30360-eom Day Count Algorithm {#bbldc_basicpsa30360eom-psa-30360-eom-day-count-algorithm}
///
///
/// Given `beginDate` and `endDate`, let:
/// @code
/// Ye =  year of earlier date           Yl =  year of later date
/// Me = month of earlier date           Ml = month of later date
/// De =   day of earlier date           Dl =   day of later date
///
///   o If De is the last day of February (29 in a leap year, else 28),
///     change De to 30.
///
///   o If De is 31, change De to 30.
///
///   o If at this point De is 30 and Dl is 31, change Dl to 30.
///
/// daysDiff ::= sign(endDate - beginDate) *
///                           max((Yl - Ye) * 360 + (Ml - Me) * 30 + Dl - De, 0)
/// @endcode
/// The `max` function is required because `Dl` has no February adjustment and
/// simple differences like (19990228 - 19990228) produce -2 without `max`.
///
/// Reference: PSA Standard Formulas, page SF-17
///
/// The year fraction is simply the day count divided by 360.
///
/// ## Usage {#bbldc_basicpsa30360eom-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Computing Day Count and Year Fraction {#bbldc_basicpsa30360eom-example-1-computing-day-count-and-year-fraction}
///
///
/// The following snippets of code illustrate how to use
/// `bbldc::BasicPsa30360Eom` methods.  First, create two `bdlt::Date`
/// variables, `d1` and `d2`:
/// @code
/// const bdlt::Date d1(2004,  9, 30);
/// const bdlt::Date d2(2004, 12, 31);
/// @endcode
/// Then, compute the day count between the two dates:
/// @code
/// const int daysDiff = bbldc::BasicPsa30360Eom::daysDiff(d1, d2);
/// assert(90 == daysDiff);
/// @endcode
/// Finally, compute the year fraction between the two dates:
/// @code
/// const double yearsDiff = bbldc::BasicPsa30360Eom::yearsDiff(d1, d2);
/// assert(0.25 == yearsDiff);
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bbl
 * @{
 */
/** @addtogroup bbldc
 * @{
 */
/** @addtogroup bbldc_basicpsa30360eom
 * @{
 */
 
#include <bblscm_version.h>
 
 
namespace bdlt {
 
class Date;
 
}  // close namespace bdlt
 
namespace bbldc {
 
                         // =======================
                         // struct BasicPsa30360Eom
                         // =======================
 
/// This `struct` provides a namespace for a suite of pure functions that
/// compute values based on dates according to the PSA 30/360 end-of-month
/// day-count convention.
struct BasicPsa30360Eom {
 
    // CLASS METHODS
 
    /// Return the (signed) number of days between the specified `beginDate`
    /// and `endDate` according to the PSA 30/360 end-of-month day-count
    /// convention.  If `beginDate <= endDate`, then the result is
    /// non-negative.  Note that reversing the order of `beginDate` and
    /// `endDate` negates the result.
    static int daysDiff(const bdlt::Date& beginDate,
                        const bdlt::Date& endDate);
 
    /// Return the (signed fractional) number of years between the specified
    /// `beginDate` and `endDate` according to the PSA 30/360 end-of-month
    /// day-count convention.  If `beginDate <= endDate`, then the result is
    /// non-negative.  Note that reversing the order of `beginDate` and
    /// `endDate` negates the result; specifically,
    /// `|yearsDiff(b, e) + yearsDiff(e, b)| <= 1.0e-15` for all dates `b`
    /// and `e`.
    static double yearsDiff(const bdlt::Date& beginDate,
                            const bdlt::Date& endDate);
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */