cannam@160: //  Copyright John Maddock 2006.
cannam@160: //  Use, modification and distribution are subject to the
cannam@160: //  Boost Software License, Version 1.0. (See accompanying file
cannam@160: //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
cannam@160: 
cannam@160: #ifndef BOOST_STATS_LOGNORMAL_HPP
cannam@160: #define BOOST_STATS_LOGNORMAL_HPP
cannam@160: 
cannam@160: // http://www.itl.nist.gov/div898/handbook/eda/section3/eda3669.htm
cannam@160: // http://mathworld.wolfram.com/LogNormalDistribution.html
cannam@160: // http://en.wikipedia.org/wiki/Lognormal_distribution
cannam@160: 
cannam@160: #include <boost/math/distributions/fwd.hpp>
cannam@160: #include <boost/math/distributions/normal.hpp>
cannam@160: #include <boost/math/special_functions/expm1.hpp>
cannam@160: #include <boost/math/distributions/detail/common_error_handling.hpp>
cannam@160: 
cannam@160: #include <utility>
cannam@160: 
cannam@160: namespace boost{ namespace math
cannam@160: {
cannam@160: namespace detail
cannam@160: {
cannam@160: 
cannam@160:   template <class RealType, class Policy>
cannam@160:   inline bool check_lognormal_x(
cannam@160:         const char* function,
cannam@160:         RealType const& x,
cannam@160:         RealType* result, const Policy& pol)
cannam@160:   {
cannam@160:      if((x < 0) || !(boost::math::isfinite)(x))
cannam@160:      {
cannam@160:         *result = policies::raise_domain_error<RealType>(
cannam@160:            function,
cannam@160:            "Random variate is %1% but must be >= 0 !", x, pol);
cannam@160:         return false;
cannam@160:      }
cannam@160:      return true;
cannam@160:   }
cannam@160: 
cannam@160: } // namespace detail
cannam@160: 
cannam@160: 
cannam@160: template <class RealType = double, class Policy = policies::policy<> >
cannam@160: class lognormal_distribution
cannam@160: {
cannam@160: public:
cannam@160:    typedef RealType value_type;
cannam@160:    typedef Policy policy_type;
cannam@160: 
cannam@160:    lognormal_distribution(RealType l_location = 0, RealType l_scale = 1)
cannam@160:       : m_location(l_location), m_scale(l_scale)
cannam@160:    {
cannam@160:       RealType result;
cannam@160:       detail::check_scale("boost::math::lognormal_distribution<%1%>::lognormal_distribution", l_scale, &result, Policy());
cannam@160:       detail::check_location("boost::math::lognormal_distribution<%1%>::lognormal_distribution", l_location, &result, Policy());
cannam@160:    }
cannam@160: 
cannam@160:    RealType location()const
cannam@160:    {
cannam@160:       return m_location;
cannam@160:    }
cannam@160: 
cannam@160:    RealType scale()const
cannam@160:    {
cannam@160:       return m_scale;
cannam@160:    }
cannam@160: private:
cannam@160:    //
cannam@160:    // Data members:
cannam@160:    //
cannam@160:    RealType m_location;  // distribution location.
cannam@160:    RealType m_scale;     // distribution scale.
cannam@160: };
cannam@160: 
cannam@160: typedef lognormal_distribution<double> lognormal;
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline const std::pair<RealType, RealType> range(const lognormal_distribution<RealType, Policy>& /*dist*/)
cannam@160: { // Range of permissible values for random variable x is >0 to +infinity.
cannam@160:    using boost::math::tools::max_value;
cannam@160:    return std::pair<RealType, RealType>(static_cast<RealType>(0), max_value<RealType>());
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline const std::pair<RealType, RealType> support(const lognormal_distribution<RealType, Policy>& /*dist*/)
cannam@160: { // Range of supported values for random variable x.
cannam@160:    // This is range where cdf rises from 0 to 1, and outside it, the pdf is zero.
cannam@160:    using boost::math::tools::max_value;
cannam@160:    return std::pair<RealType, RealType>(static_cast<RealType>(0),  max_value<RealType>());
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: RealType pdf(const lognormal_distribution<RealType, Policy>& dist, const RealType& x)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160: 
cannam@160:    static const char* function = "boost::math::pdf(const lognormal_distribution<%1%>&, %1%)";
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale(function, sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location(function, mu, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_lognormal_x(function, x, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    if(x == 0)
cannam@160:       return 0;
cannam@160: 
cannam@160:    RealType exponent = log(x) - mu;
cannam@160:    exponent *= -exponent;
cannam@160:    exponent /= 2 * sigma * sigma;
cannam@160: 
cannam@160:    result = exp(exponent);
cannam@160:    result /= sigma * sqrt(2 * constants::pi<RealType>()) * x;
cannam@160: 
cannam@160:    return result;
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType cdf(const lognormal_distribution<RealType, Policy>& dist, const RealType& x)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    static const char* function = "boost::math::cdf(const lognormal_distribution<%1%>&, %1%)";
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale(function, dist.scale(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location(function, dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_lognormal_x(function, x, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    if(x == 0)
cannam@160:       return 0;
cannam@160: 
cannam@160:    normal_distribution<RealType, Policy> norm(dist.location(), dist.scale());
cannam@160:    return cdf(norm, log(x));
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType quantile(const lognormal_distribution<RealType, Policy>& dist, const RealType& p)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    static const char* function = "boost::math::quantile(const lognormal_distribution<%1%>&, %1%)";
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale(function, dist.scale(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location(function, dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_probability(function, p, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    if(p == 0)
cannam@160:       return 0;
cannam@160:    if(p == 1)
cannam@160:       return policies::raise_overflow_error<RealType>(function, 0, Policy());
cannam@160: 
cannam@160:    normal_distribution<RealType, Policy> norm(dist.location(), dist.scale());
cannam@160:    return exp(quantile(norm, p));
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType cdf(const complemented2_type<lognormal_distribution<RealType, Policy>, RealType>& c)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    static const char* function = "boost::math::cdf(const lognormal_distribution<%1%>&, %1%)";
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale(function, c.dist.scale(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location(function, c.dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_lognormal_x(function, c.param, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    if(c.param == 0)
cannam@160:       return 1;
cannam@160: 
cannam@160:    normal_distribution<RealType, Policy> norm(c.dist.location(), c.dist.scale());
cannam@160:    return cdf(complement(norm, log(c.param)));
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType quantile(const complemented2_type<lognormal_distribution<RealType, Policy>, RealType>& c)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    static const char* function = "boost::math::quantile(const lognormal_distribution<%1%>&, %1%)";
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale(function, c.dist.scale(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location(function, c.dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_probability(function, c.param, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    if(c.param == 1)
cannam@160:       return 0;
cannam@160:    if(c.param == 0)
cannam@160:       return policies::raise_overflow_error<RealType>(function, 0, Policy());
cannam@160: 
cannam@160:    normal_distribution<RealType, Policy> norm(c.dist.location(), c.dist.scale());
cannam@160:    return exp(quantile(complement(norm, c.param)));
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType mean(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::mean(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::mean(const lognormal_distribution<%1%>&)", mu, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return exp(mu + sigma * sigma / 2);
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType variance(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::variance(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::variance(const lognormal_distribution<%1%>&)", mu, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return boost::math::expm1(sigma * sigma, Policy()) * exp(2 * mu + sigma * sigma);
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType mode(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::mode(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::mode(const lognormal_distribution<%1%>&)", mu, &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return exp(mu - sigma * sigma);
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType median(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160:    RealType mu = dist.location();
cannam@160:    return exp(mu); // e^mu
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType skewness(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    //RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160: 
cannam@160:    RealType ss = sigma * sigma;
cannam@160:    RealType ess = exp(ss);
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::skewness(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::skewness(const lognormal_distribution<%1%>&)", dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return (ess + 2) * sqrt(boost::math::expm1(ss, Policy()));
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType kurtosis(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    //RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160:    RealType ss = sigma * sigma;
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::kurtosis(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::kurtosis(const lognormal_distribution<%1%>&)", dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return exp(4 * ss) + 2 * exp(3 * ss) + 3 * exp(2 * ss) - 3;
cannam@160: }
cannam@160: 
cannam@160: template <class RealType, class Policy>
cannam@160: inline RealType kurtosis_excess(const lognormal_distribution<RealType, Policy>& dist)
cannam@160: {
cannam@160:    BOOST_MATH_STD_USING  // for ADL of std functions
cannam@160: 
cannam@160:    // RealType mu = dist.location();
cannam@160:    RealType sigma = dist.scale();
cannam@160:    RealType ss = sigma * sigma;
cannam@160: 
cannam@160:    RealType result = 0;
cannam@160:    if(0 == detail::check_scale("boost::math::kurtosis_excess(const lognormal_distribution<%1%>&)", sigma, &result, Policy()))
cannam@160:       return result;
cannam@160:    if(0 == detail::check_location("boost::math::kurtosis_excess(const lognormal_distribution<%1%>&)", dist.location(), &result, Policy()))
cannam@160:       return result;
cannam@160: 
cannam@160:    return exp(4 * ss) + 2 * exp(3 * ss) + 3 * exp(2 * ss) - 6;
cannam@160: }
cannam@160: 
cannam@160: } // namespace math
cannam@160: } // namespace boost
cannam@160: 
cannam@160: // This include must be at the end, *after* the accessors
cannam@160: // for this distribution have been defined, in order to
cannam@160: // keep compilers that support two-phase lookup happy.
cannam@160: #include <boost/math/distributions/detail/derived_accessors.hpp>
cannam@160: 
cannam@160: #endif // BOOST_STATS_STUDENTS_T_HPP
cannam@160: 
cannam@160: