rayleigh_distribution.hpp

Go to the documentation of this file.

//============================================================================
// vSMC/include/vsmc/rng/rayleigh_distribution.hpp
//----------------------------------------------------------------------------
//                         vSMC: Scalable Monte Carlo
//----------------------------------------------------------------------------
// Copyright (c) 2013-2016, Yan Zhou
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
//   Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//============================================================================

#ifndef VSMC_RNG_RAYLEIGH_DISTRIBUTION_HPP
#define VSMC_RNG_RAYLEIGH_DISTRIBUTION_HPP

#include <vsmc/rng/internal/common.hpp>
#include <vsmc/rng/u01_distribution.hpp>

namespace vsmc
{

namespace internal
{

template <typename RealType>
inline bool rayleigh_distribution_check_param(RealType sigma)
{
    return sigma > 0;
}

} // namespace vsmc::internal

template <typename RealType>
class RayleighDistribution
{
    VSMC_DEFINE_RNG_DISTRIBUTION_1(Rayleigh, rayleigh, sigma, 1)
    VSMC_DEFINE_RNG_DISTRIBUTION_MEMBER_0

    public:
    result_type min() const { return 0; }

    result_type max() const { return std::numeric_limits<result_type>::max(); }

    void reset() {}

    private:
    template <typename RNGType>
    result_type generate(RNGType &rng, const param_type &param)
    {
        U01OCDistribution<RealType> u01;

        return param.sigma() * std::sqrt(-2 * std::log(u01(rng)));
    }
}; // class RayleighDistribution

namespace internal
{

template <std::size_t, typename RealType, typename RNGType>
inline void rayleigh_distribution_impl(
    RNGType &rng, std::size_t n, RealType *r, RealType sigma)
{
    u01_oc_distribution(rng, n, r);
    log(n, r, r);
    mul(n, -2 * sigma * sigma, r, r);
    sqrt(n, r, r);
}

} // namespace vsmc::internal

VSMC_DEFINE_RNG_DISTRIBUTION_IMPL_1(rayleigh, sigma)
VSMC_DEFINE_RNG_DISTRIBUTION_RAND_1(Rayleigh, rayleigh, sigma)

} // namespace vsmc

#endif // VSMC_RNG_RAYLEIGH_DISTRIBUTION_HPP