boost/random/ranlux.hpp

0001 /* boost random/ranlux.hpp header file
0002  *
0003  * Copyright Jens Maurer 2002
0004  * Distributed under the Boost Software License, Version 1.0. (See
0005  * accompanying file LICENSE_1_0.txt or copy at
0006  * http://www.boost.org/LICENSE_1_0.txt)
0007  *
0008  * See http://www.boost.org for most recent version including documentation.
0009  *
0010  * $Id$
0011  *
0012  * Revision history
0013  *  2001-02-18  created
0014  */
0015
0016 #ifndef BOOST_RANDOM_RANLUX_HPP
0017 #define BOOST_RANDOM_RANLUX_HPP
0018
0019 #include <boost/config.hpp>
0020 #include <boost/random/subtract_with_carry.hpp>
0021 #include <boost/random/discard_block.hpp>
0022
0023 namespace boost {
0024
0025 namespace random {
0026
0027 namespace detail {
0028 /**
0029  * The ranlux family of generators are described in
0030  *
0031  *  @blockquote
0032  *  "A portable high-quality random number generator for lattice field theory
0033  *  calculations", M. Luescher, Computer Physics Communications, 79 (1994)
0034  *  pp 100-110.
0035  *  @endblockquote
0036  *
0037  * The levels are given in
0038  *
0039  *  @blockquote
0040  *  "RANLUX: A Fortran implementation of the high-quality
0041  *  pseudorandom number generator of Luescher", F. James,
0042  *  Computer Physics Communications 79 (1994) 111-114
0043  *  @endblockquote
0044  */
0045 class ranlux_documentation {};
0046 }
0047
0048 typedef subtract_with_carry_engine<uint32_t, 24, 10, 24> ranlux_base;
0049 typedef subtract_with_carry_01_engine<float, 24, 10, 24> ranlux_base_01;
0050 typedef subtract_with_carry_01_engine<double, 48, 10, 24> ranlux64_base_01;
0051
0052
0053 /** @copydoc boost::random::detail::ranlux_documentation */
0054 typedef discard_block_engine<ranlux_base, 223, 24> ranlux3;
0055 /** @copydoc boost::random::detail::ranlux_documentation */
0056 typedef discard_block_engine<ranlux_base, 389, 24> ranlux4;
0057
0058 /** @copydoc boost::random::detail::ranlux_documentation */
0059 typedef discard_block_engine<ranlux_base_01, 223, 24> ranlux3_01;
0060 /** @copydoc boost::random::detail::ranlux_documentation */
0061 typedef discard_block_engine<ranlux_base_01, 389, 24> ranlux4_01;
0062
0063 /** @copydoc boost::random::detail::ranlux_documentation */
0064 typedef discard_block_engine<ranlux64_base_01, 223, 24> ranlux64_3_01;
0065 /** @copydoc boost::random::detail::ranlux_documentation */
0066 typedef discard_block_engine<ranlux64_base_01, 389, 24> ranlux64_4_01;
0067
0068 #if !defined(BOOST_NO_INT64_T) && !defined(BOOST_NO_INTEGRAL_INT64_T)
0069 typedef subtract_with_carry_engine<uint64_t, 48, 10, 24> ranlux64_base;
0070 /** @copydoc boost::random::detail::ranlux_documentation */
0071 typedef discard_block_engine<ranlux64_base, 223, 24> ranlux64_3;
0072 /** @copydoc boost::random::detail::ranlux_documentation */
0073 typedef discard_block_engine<ranlux64_base, 389, 24> ranlux64_4;
0074 #endif /* !BOOST_NO_INT64_T && !BOOST_NO_INTEGRAL_INT64_T */
0075
0076
0077 typedef subtract_with_carry_engine<uint32_t, 24, 10, 24> ranlux24_base;
0078 typedef subtract_with_carry_engine<uint64_t, 48, 5, 12> ranlux48_base;
0079
0080 typedef discard_block_engine<ranlux24_base, 223, 23> ranlux24;
0081 #if !defined(BOOST_NO_INT64_T) && !defined(BOOST_NO_INTEGRAL_INT64_T)
0082 typedef discard_block_engine<ranlux48_base, 389, 11> ranlux48;
0083 #endif
0084 }
0085
0086 using random::ranlux3;
0087 using random::ranlux4;
0088 using random::ranlux3_01;
0089 using random::ranlux4_01;
0090 using random::ranlux64_3_01;
0091 using random::ranlux64_4_01;
0092 #if !defined(BOOST_NO_INT64_T) && !defined(BOOST_NO_INTEGRAL_INT64_T)
0093 using random::ranlux64_3;
0094 using random::ranlux64_4;
0095 #endif
0096
0097 } // namespace boost
0098
0099 #endif // BOOST_RANDOM_LINEAR_CONGRUENTIAL_HPP