bdlsta.h

Go to the documentation of this file.

/// @file bdlsta.h
///
///
/// @defgroup bdlsta Package bdlsta
/// @brief  Basic Development Library STAtistics (bdlsta)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlsta
/// @{
/// * <a href="#bdlsta-purpose"> Purpose</a>
/// * <a href="#bdlsta-mnemonic"> Mnemonic </a>
/// * <a href="#bdlsta-description"> Description </a>
///   * <a href="#bdlsta-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdlsta-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdlsta-purpose}
/// Provide basic statistical computations.
///
/// # Mnemonic {#bdlsta-mnemonic}
/// Basic Development Library STAtistics (bdlsta)
///
/// # Description {#bdlsta-description}
/// The 'bdlsta' package provides basic statistical computations.  At
/// the moment, this package contains a component, @ref bdlsta_moment , for
/// calculating mean, variance, skew, and kurtosis.  Another component,
/// @ref bdlsta_linefit , is for calculating linear sqaures line fit.
///
/// ## Hierarchical Synopsis {#bdlsta-hierarchical-synopsis}
///
/// The 'bdlsta' package currently has 2 components having 1 level of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  1. bdlsta_linefit
///     bdlsta_moment
/// @endcode
///
/// ## Component Synopsis {#bdlsta-component-synopsis}
///
///  @ref bdlsta_linefit :
///       Online algorithm for computing the least squares regression line.
/// 
///  @ref bdlsta_moment :
///       Online algorithm for mean, variance, skew, and kurtosis.
///
/// @}
/** @} */