Headers

An instantiation of class template additive_combine_engine models a pseudo-random number generator . It combines two multiplicative linear_congruential_engine number generators, i.e. those with c = 0. It is described in

"Efficient and Portable Combined Random Number Generators", Pierre L'Ecuyer, Communications of the ACM, Vol. 31, No. 6, June 1988, pp. 742-749, 774

The template parameters MLCG1 and MLCG2 shall denote two different linear_congruential_engine number generators, each with c = 0. Each invocation returns a random number X(n) := (MLCG1(n) - MLCG2(n)) mod (m1 - 1), where m1 denotes the modulus of MLCG1. MLCG1 MLCG2 MLCG1::result_type

const bool

result_typeReturns the smallest value that the generator can produce result_typeReturns the largest value that the generator can produce

Constructs an additive_combine_engine using the default constructors of the two base generators. result_typeConstructs an additive_combine_engine, using seed as the constructor argument for both base generators. SeedSeq &Constructs an additive_combine_engine, using seq as the constructor argument for both base generators. The semantics of this function are liable to change. A seed_seq is designed to generate all the seeds in one shot, but this seeds the two base engines independantly and probably ends up giving the same sequence to both. typename MLCG1::result_typetypename MLCG2::result_typeConstructs an additive_combine_engine, using seed1 and seed2 as the constructor argument to the first and second base generators, respectively. It &ItContructs an additive_combine_engine with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.Throws: std::invalid_argument if the input range is too small.Exception Safety: Basic voidSeeds an additive_combine_engine using the default seeds of the two base generators. voidresult_typeSeeds an additive_combine_engine, using seed as the seed for both base generators. voidSeedSeq &Seeds an additive_combine_engine, using seq to seed both base generators.See the warning on the corresponding constructor. voidtypename MLCG1::result_typetypename MLCG2::result_typeSeeds an additive_combine generator, using seed1 and seed2 as the seeds to the first and second base generators, respectively. voidIt &ItSeeds an additive_combine_engine with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.Throws: std::invalid_argument if the input range is too small.Exception Safety: Basic result_typeReturns the next value of the generator. voidIterIterFills a range with random values voidboost::uintmax_tAdvances the state of the generator by z.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const additive_combine_engine &Writes the state of an additive_combine_engine to a std::ostream. The textual representation of an additive_combine_engine is the textual representation of the first base generator followed by the textual representation of the second base generator. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const additive_combine_engine &Reads the state of an additive_combine_engine from a std::istream. boolconst additive_combine_engine &const additive_combine_engine &Returns: true iff the two additive_combine_engines will produce the same sequence of values. boolconst additive_combine_engine &const additive_combine_engine &Returns: true iff the two additive_combine_engines will produce different sequences of values.

The specialization ecuyer1988 was suggested in

"Efficient and Portable Combined Random Number Generators", Pierre L'Ecuyer, Communications of the ACM, Vol. 31, No. 6, June 1988, pp. 742-749, 774

additive_combine_engine< linear_congruential_engine< uint32_t, 40014, 0, 2147483563 >, linear_congruential_engine< uint32_t, 40692, 0, 2147483399 > >

const bool

The specialization ecuyer1988 was suggested in

"Efficient and Portable Combined Random Number Generators", Pierre L'Ecuyer, Communications of the ACM, Vol. 31, No. 6, June 1988, pp. 742-749, 774

additive_combine_engine< linear_congruential_engine< uint32_t, 40014, 0, 2147483563 >, linear_congruential_engine< uint32_t, 40692, 0, 2147483399 > >

Instantiations of class template bernoulli_distribution model a random distribution . Such a random distribution produces bool values distributed with probabilities P(true) = p and P(false) = 1-p. p is the parameter of the distribution. bernoulli_distribution

RealType0.5Constructs the parameters of the distribution.Requires: 0 <= p <= 1 RealTypeReturns the p parameter of the distribution.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes the parameters to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const param_type &Reads the parameters from a std::istream. boolconst param_type &const param_type &Returns true if the two sets of parameters are equal. boolconst param_type &const param_type &Returns true if the two sets of parameters are different.

int bool

const RealType &0.5Constructs a bernoulli_distribution object. p is the parameter of the distribution.Requires: 0 <= p <= 1 const param_type &Constructs bernoulli_distribution from its parameters RealTypeReturns: The "p" parameter of the distribution. boolReturns the smallest value that the distribution can produce. boolReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. boolEngine &Returns: a random variate distributed according to the bernoulli_distribution . boolEngine &const param_type &Returns: a random variate distributed according to the bernoulli_distribution with parameters specified by param.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const bernoulli_distribution &Writes the parameters of the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const bernoulli_distribution &Reads the parameters of the distribution from a std::istream. boolconst bernoulli_distribution &const bernoulli_distribution &Returns true iff the two distributions will produce identical sequences of values given equal generators. boolconst bernoulli_distribution &const bernoulli_distribution &Returns true iff the two distributions will produce different sequences of values given equal generators.

RealType0.5Constructs the parameters of the distribution.Requires: 0 <= p <= 1 RealTypeReturns the p parameter of the distribution.

int bool

The beta distribution is a real-valued distribution which produces values in the range [0, 1]. It has two parameters, alpha and beta.It has $\displaystyle p(x) = \frac{x^{\alpha-1}(1-x)^{\beta-1}}{B(\alpha, \beta)}$$\displaystyle p(x) = \frac{x^{\alpha-1}(1-x)^{\beta-1}}{B(\alpha, \beta)}$. beta_distribution

RealType1.0RealType1.0Constructs a param_type from the "alpha" and "beta" parameters of the distribution.Requires: alpha > 0, beta > 0 RealTypeReturns the "alpha" parameter of the distribtuion. RealTypeReturns the "beta" parameter of the distribution.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes a param_type to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const param_type &Reads a param_type from a std::istream. boolconst param_type &const param_type &Returns true if the two sets of parameters are the same. boolconst param_type &const param_type &Returns true if the two sets of parameters are the different.

RealType RealType

RealType1.0RealType1.0Constructs an beta_distribution from its "alpha" and "beta" parameters.Requires: alpha > 0, beta > 0 const param_type &Constructs an beta_distribution from its parameters. RealTypeURNG &Returns a random variate distributed according to the beta distribution. RealTypeURNG &const param_type &Returns a random variate distributed accordint to the beta distribution with parameters specified by param. RealTypeReturns the "alpha" parameter of the distribution. RealTypeReturns the "beta" parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const beta_distribution &Writes an beta_distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const beta_distribution &Reads an beta_distribution from a std::istream. boolconst beta_distribution &const beta_distribution &Returns true if the two instances of beta_distribution will return identical sequences of values given equal generators. boolconst beta_distribution &const beta_distribution &Returns true if the two instances of beta_distribution will return different sequences of values given equal generators.

The binomial distribution is an integer valued distribution with two parameters, t and p. The values of the distribution are within the range [0,t].The distribution function is $\displaystyle P(k) = {t \choose k}p^k(1-p)^{t-k}$$\displaystyle P(k) = {t \choose k}p^k(1-p)^{t-k}$.The algorithm used is the BTRD algorithm described in

"The generation of binomial random variates", Wolfgang Hormann, Journal of Statistical Computation and Simulation, Volume 46, Issue 1 & 2 April 1993 , pages 101 - 110

binomial_distribution

IntType1RealType0.5Construct a param_type object. t and p are the parameters of the distribution.Requires: t >=0 && 0 <= p <= 1 IntTypeReturns the t parameter of the distribution. RealTypeReturns the p parameter of the distribution.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes the parameters of the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &param_type &Reads the parameters of the distribution from a std::istream. boolconst param_type &const param_type &Returns true if the parameters have the same values. boolconst param_type &const param_type &Returns true if the parameters have different values.

IntType RealType

IntType1RealType0.5Construct a binomial_distribution object. t and p are the parameters of the distribution.Requires: t >=0 && 0 <= p <= 1 const param_type &Construct an binomial_distribution object from the parameters. IntTypeURNG &Returns a random variate distributed according to the binomial distribution. IntTypeURNG &const param_type &Returns a random variate distributed according to the binomial distribution with parameters specified by param. IntTypeReturns the t parameter of the distribution. RealTypeReturns the p parameter of the distribution. IntTypeReturns the smallest value that the distribution can produce. IntTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const binomial_distribution &Writes the parameters of the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &binomial_distribution &Reads the parameters of the distribution from a std::istream. boolconst binomial_distribution &const binomial_distribution &Returns true if the two distributions will produce the same sequence of values, given equal generators. boolconst binomial_distribution &const binomial_distribution &Returns true if the two distributions could produce different sequences of values, given equal generators.

"The generation of binomial random variates", Wolfgang Hormann, Journal of Statistical Computation and Simulation, Volume 46, Issue 1 & 2 April 1993 , pages 101 - 110

binomial_distribution

IntType RealType

The cauchy distribution is a continuous distribution with two parameters, median and sigma.It has $\displaystyle p(x) = \frac{\sigma}{\pi(\sigma^2 + (x-m)^2)}$$\displaystyle p(x) = \frac{\sigma}{\pi(\sigma^2 + (x-m)^2)}$ cauchy_distribution

RealType0.0RealType1.0Constructs the parameters of the cauchy distribution. RealTypeReturns the median of the distribution. RealTypeReturns the sigma parameter of the distribution. RealTypeReturns the median of the distribution. RealTypeReturns the sigma parameter of the distribution.

RealType RealType

RealType0.0RealType1.0Constructs a cauchy_distribution with the paramters median and sigma. const param_type &Constructs a cauchy_distribution from it's parameters. RealTypeReturns: the "median" parameter of the distribution RealTypeReturns: the "sigma" parameter of the distribution RealTypeReturns: the "median" parameter of the distribution RealTypeReturns: the "sigma" parameter of the distribution RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_type voidconst param_type & voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. result_typeEngine &Returns: A random variate distributed according to the cauchy distribution. result_typeEngine &const param_type &Returns: A random variate distributed according to the cauchy distribution with parameters specified by param.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const cauchy_distribution &Writes the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const cauchy_distribution &Reads the distribution from a std::istream. boolconst cauchy_distribution &const cauchy_distribution &Returns true if the two distributions will produce identical sequences of values, given equal generators. boolconst cauchy_distribution &const cauchy_distribution &Returns true if the two distributions may produce different sequences of values, given equal generators.

RealType RealType

The chi squared distribution is a real valued distribution with one parameter, n. The distribution produces values > 0.The distribution function is $\displaystyle P(x) = \frac{x^{(n/2)-1}e^{-x/2}}{\Gamma(n/2)2^{n/2}}$$\displaystyle P(x) = \frac{x^{(n/2)-1}e^{-x/2}}{\Gamma(n/2)2^{n/2}}$. chi_squared_distribution

RealType1Construct a param_type object. n is the parameter of the distribution.Requires: t >=0 && 0 <= p <= 1 RealTypeReturns the n parameter of the distribution.

RealType RealType

RealType1Construct a chi_squared_distribution object. n is the parameter of the distribution.Requires: t >=0 && 0 <= p <= 1 const param_type &Construct an chi_squared_distribution object from the parameters. RealTypeURNG &Returns a random variate distributed according to the chi squared distribution. RealTypeURNG &const param_type &Returns a random variate distributed according to the chi squared distribution with parameters specified by param. RealTypeReturns the n parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const chi_squared_distribution &Writes the parameters of the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &chi_squared_distribution &Reads the parameters of the distribution from a std::istream. boolconst chi_squared_distribution &const chi_squared_distribution &Returns true if the two distributions will produce the same sequence of values, given equal generators. boolconst chi_squared_distribution &const chi_squared_distribution &Returns true if the two distributions could produce different sequences of values, given equal generators.

The class template discard_block_engine is a model of pseudo-random number generator . It modifies another generator by discarding parts of its output. Out of every block of p results, the first r will be returned and the rest discarded.Requires: 0 < p <= r UniformRandomNumberGenerator base_type::result_type

const std::size_t

const bool

const std::size_t

Uses the default seed for the base generator. const base_type &Constructs a new discard_block_engine with a copy of rng. base_type &&Constructs a new discard_block_engine with rng. seed_typeCreates a new discard_block_engine and seeds the underlying generator with value SeedSeq &Creates a new discard_block_engine and seeds the underlying generator with seq It &ItCreates a new discard_block_engine and seeds the underlying generator with first and last. voiddefault seeds the underlying generator. voidseed_typeSeeds the underlying generator with s. voidSeedSeq &Seeds the underlying generator with seq. voidIt &ItSeeds the underlying generator with first and last. const base_type &Returns the underlying engine. result_typeReturns the next value of the generator. voidboost::uintmax_t voidItIt

result_typeReturns the smallest value that the generator can produce. This is the same as the minimum of the underlying generator. result_typeReturns the largest value that the generator can produce. This is the same as the maximum of the underlying generator.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const discard_block_engine &Writes a discard_block_engine to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &discard_block_engine &Reads a discard_block_engine from a std::istream. boolconst discard_block_engine &const discard_block_engine &Returns true if the two generators will produce identical sequences. boolconst discard_block_engine &const discard_block_engine &Returns true if the two generators will produce different sequences.

const bool

const std::size_t

The class discrete_distribution models a random distribution . It produces integers in the range [0, n) with the probability of producing each value is specified by the parameters of the distribution. discrete_distribution

Constructs a param_type object, representing a distribution with $p(0) = 1$$p(0) = 1$ and $p(k|k>0) = 0$$p(k|k>0) = 0$. IterIterIf first == last, equivalent to the default constructor. Otherwise, the values of the range represent weights for the possible values of the distribution. const std::initializer_list< WeightType > &If wl.size() == 0, equivalent to the default constructor. Otherwise, the values of the initializer_list represent weights for the possible values of the distribution. const Range &If the range is empty, equivalent to the default constructor. Otherwise, the elements of the range represent weights for the possible values of the distribution. std::size_tdoubledoubleFuncIf nw is zero, equivalent to the default constructor. Otherwise, the range of the distribution is [0, nw), and the weights are found by calling fw with values evenly distributed between $\mbox{xmin} + \delta/2$$\mbox{xmin} + \delta/2$ and $\mbox{xmax} - \delta/2$$\mbox{xmax} - \delta/2$, where $\delta = (\mbox{xmax} - \mbox{xmin})/\mbox{nw}$$\delta = (\mbox{xmax} - \mbox{xmin})/\mbox{nw}$. std::vector< WeightType >Returns a vector containing the probabilities of each possible value of the distribution.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes the parameters to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const param_type &Reads the parameters from a std::istream. boolconst param_type &const param_type &Returns true if the two sets of parameters are the same. boolconst param_type &const param_type &Returns true if the two sets of parameters are different.

WeightType IntType

Creates a new discrete_distribution object that has $p(0) = 1$$p(0) = 1$ and $p(i|i>0) = 0$$p(i|i>0) = 0$. IterIterConstructs a discrete_distribution from an iterator range. If first == last, equivalent to the default constructor. Otherwise, the values of the range represent weights for the possible values of the distribution. std::initializer_list< WeightType >Constructs a discrete_distribution from a std::initializer_list. If the initializer_list is empty, equivalent to the default constructor. Otherwise, the values of the initializer_list represent weights for the possible values of the distribution. For example, given the distributiondiscrete_distribution<> dist{1, 4, 5}; The probability of a 0 is 1/10, the probability of a 1 is 2/5, the probability of a 2 is 1/2, and no other values are possible. const Range &Constructs a discrete_distribution from a Boost.Range range. If the range is empty, equivalent to the default constructor. Otherwise, the values of the range represent weights for the possible values of the distribution. std::size_tdoubledoubleFuncConstructs a discrete_distribution that approximates a function. If nw is zero, equivalent to the default constructor. Otherwise, the range of the distribution is [0, nw), and the weights are found by calling fw with values evenly distributed between $\mbox{xmin} + \delta/2$$\mbox{xmin} + \delta/2$ and $\mbox{xmax} - \delta/2$$\mbox{xmax} - \delta/2$, where $\delta = (\mbox{xmax} - \mbox{xmin})/\mbox{nw}$$\delta = (\mbox{xmax} - \mbox{xmin})/\mbox{nw}$. const param_type &Constructs a discrete_distribution from its parameters. IntTypeURNG &Returns a value distributed according to the parameters of the discrete_distribution. IntTypeURNG &const param_type &Returns a value distributed according to the parameters specified by param. result_typeReturns the smallest value that the distribution can produce. result_typeReturns the largest value that the distribution can produce. std::vector< WeightType >Returns a vector containing the probabilities of each value of the distribution. For example, givendiscrete_distribution<> dist = { 1, 4, 5 }; std::vector<double> p = dist.param(); the vector, p will contain {0.1, 0.4, 0.5}.If WeightType is integral, then the weights will be returned unchanged. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const discrete_distribution &Writes a distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const discrete_distribution &Reads a distribution from a std::istream boolconst discrete_distribution &const discrete_distribution &Returns true if the two distributions will return the same sequence of values, when passed equal generators. boolconst discrete_distribution &const discrete_distribution &Returns true if the two distributions may return different sequences of values, when passed equal generators.

The exponential distribution is a model of random distribution with a single parameter lambda.It has $\displaystyle p(x) = \lambda e^{-\lambda x}$$\displaystyle p(x) = \lambda e^{-\lambda x}$The implementation uses the "ziggurat" algorithm, as described in

"The Ziggurat Method for Generating Random Variables", George Marsaglia and Wai Wan Tsang, Journal of Statistical Software Volume 5, Number 8 (2000), 1-7.

exponential_distribution

RealType1.0Constructs parameters with a given lambda.Requires: lambda > 0 RealTypeReturns the lambda parameter of the distribution.

RealType RealType

RealType1.0Constructs an exponential_distribution with a given lambda.Requires: lambda > 0 const param_type &Constructs an exponential_distribution from its parameters RealTypeReturns the lambda parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. result_typeEngine &Returns a random variate distributed according to the exponential distribution. result_typeEngine &const param_type &Returns a random variate distributed according to the exponential distribution with parameters specified by param.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const exponential_distribution &Writes the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const exponential_distribution &Reads the distribution from a std::istream. boolconst exponential_distribution &const exponential_distribution &Returns true iff the two distributions will produce identical sequences of values given equal generators. boolconst exponential_distribution &const exponential_distribution &Returns true iff the two distributions will produce different sequences of values given equal generators.

"The Ziggurat Method for Generating Random Variables", George Marsaglia and Wai Wan Tsang, Journal of Statistical Software Volume 5, Number 8 (2000), 1-7.

exponential_distribution

RealType1.0Constructs parameters with a given lambda.Requires: lambda > 0 RealTypeReturns the lambda parameter of the distribution.

RealType RealType

The extreme value distribution is a real valued distribution with two parameters a and b.It has $\displaystyle p(x) = \frac{1}{b}e^{\frac{a-x}{b} - e^\frac{a-x}{b}}$$\displaystyle p(x) = \frac{1}{b}e^{\frac{a-x}{b} - e^\frac{a-x}{b}}$. extreme_value_distribution

RealType1.0RealType1.0Constructs a param_type from the "a" and "b" parameters of the distribution.Requires: b > 0 RealTypeReturns the "a" parameter of the distribtuion. RealTypeReturns the "b" parameter of the distribution.

RealType RealType

RealType1.0RealType1.0Constructs an extreme_value_distribution from its "a" and "b" parameters.Requires: b > 0 const param_type &Constructs an extreme_value_distribution from its parameters. RealTypeURNG &Returns a random variate distributed according to the extreme_value_distribution. RealTypeURNG &const param_type &Returns a random variate distributed accordint to the extreme value distribution with parameters specified by param. RealTypeReturns the "a" parameter of the distribution. RealTypeReturns the "b" parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const extreme_value_distribution &Writes an extreme_value_distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const extreme_value_distribution &Reads an extreme_value_distribution from a std::istream. boolconst extreme_value_distribution &const extreme_value_distribution &Returns true if the two instances of extreme_value_distribution will return identical sequences of values given equal generators. boolconst extreme_value_distribution &const extreme_value_distribution &Returns true if the two instances of extreme_value_distribution will return different sequences of values given equal generators.

Instantiations of class template faure_engine model a quasi-random number generator . The faure_engine uses the algorithm described in

Henri Faure, Discrepance de suites associees a un systeme de numeration (en dimension s), Acta Arithmetica, Volume 41, 1982, pages 337-351.

Bennett Fox, Algorithm 647: Implementation and Relative Efficiency of Quasirandom Sequence Generators, ACM Transactions on Mathematical Software, Volume 12, Number 4, December 1986, pages 362-376.

In the following documentation X denotes the concrete class of the template faure_engine returning objects of type RealType, u and v are the values of X.Some member functions may throw exceptions of type std::bad_alloc. RealType

boolconst faure_engine &const faure_engine &Returns true if the two generators will produce identical sequences of outputs. boolconst faure_engine &const faure_engine &Returns true if the two generators will produce different sequences of outputs. std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const faure_engine &Writes the textual representation of the generator to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const faure_engine &Reads the textual representation of the generator from a std::istream.

result_typeReturns: Tight lower bound on the set of values returned by operator().Throws: nothing. result_typeReturns: Tight upper bound on the set of values returned by operator().Throws: nothing.

std::size_tEffects: Constructs the s-dimensional default Faure quasi-random number generator.Throws: bad_alloc, invalid_argument. voidSeqSizeT0Effects: Effectively sets the quasi-random number generator state to the init-th vector in the s-dimensional quasi-random domain, where s == X::dimension(). X u, v; for(int i = 0; i < N; ++i) for( std::size_t j = 0; j < u.dimension(); ++j ) u(); v.seed(N); assert(u() == v()); Throws: bad_alloc. std::size_tReturns: The dimension of of the quasi-random domain.Throws: nothing. result_typeReturns: Returns a successive element of an s-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent s-dimensional vector.Throws: range_error. voidboost::uintmax_tEffects: Advances *this state as if z consecutive X::operator() invocations were executed. X u = v; for(int i = 0; i < N; ++i) u(); v.discard(N); assert(u() == v()); Throws: range_error. Throws: bad_alloc.

This specialization of faure_engine supports up to 1117 dimensions. However, it is possible to provide your own prime table to faure_engine should the default one be insufficient. faure_engine< double, boost::uint_least64_t, default_faure_prime_table >

The Fisher F distribution is a real valued distribution with two parameters m and n.It has $\displaystyle p(x) = \frac{\Gamma((m+n)/2)}{\Gamma(m/2)\Gamma(n/2)} \left(\frac{m}{n}\right)^{m/2} x^{(m/2)-1} \left(1+\frac{mx}{n}\right)^{-(m+n)/2} $$\displaystyle p(x) = \frac{\Gamma((m+n)/2)}{\Gamma(m/2)\Gamma(n/2)} \left(\frac{m}{n}\right)^{m/2} x^{(m/2)-1} \left(1+\frac{mx}{n}\right)^{-(m+n)/2} $. fisher_f_distribution

RealType1.0RealType1.0Constructs a param_type from the "m" and "n" parameters of the distribution.Requires: m > 0 and n > 0 RealTypeReturns the "m" parameter of the distribtuion. RealTypeReturns the "n" parameter of the distribution.

RealType RealType

RealType1.0RealType1.0Constructs a fisher_f_distribution from its "m" and "n" parameters.Requires: m > 0 and n > 0 const param_type &Constructs an fisher_f_distribution from its parameters. RealTypeURNG &Returns a random variate distributed according to the F distribution. RealTypeURNG &const param_type &Returns a random variate distributed according to the F distribution with parameters specified by param. RealTypeReturns the "m" parameter of the distribution. RealTypeReturns the "n" parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const fisher_f_distribution &Writes an fisher_f_distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const fisher_f_distribution &Reads an fisher_f_distribution from a std::istream. boolconst fisher_f_distribution &const fisher_f_distribution &Returns true if the two instances of fisher_f_distribution will return identical sequences of values given equal generators. boolconst fisher_f_distribution &const fisher_f_distribution &Returns true if the two instances of fisher_f_distribution will return different sequences of values given equal generators.

The gamma distribution is a continuous distribution with two parameters alpha and beta. It produces values > 0.It has $\displaystyle p(x) = x^{\alpha-1}\frac{e^{-x/\beta}}{\beta^\alpha\Gamma(\alpha)}$$\displaystyle p(x) = x^{\alpha-1}\frac{e^{-x/\beta}}{\beta^\alpha\Gamma(\alpha)}$. gamma_distribution

const RealType &1.0const RealType &1.0Constructs a param_type object from the "alpha" and "beta" parameters.Requires: alpha > 0 && beta > 0 RealTypeReturns the "alpha" parameter of the distribution. RealTypeReturns the "beta" parameter of the distribution.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes the parameters to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &param_type &Reads the parameters from a std::istream. boolconst param_type &const param_type &Returns true if the two sets of parameters are the same. boolconst param_type &const param_type &Returns true if the two sets fo parameters are different.

RealType RealType

const result_type &1.0const result_type &1.0Creates a new gamma_distribution with parameters "alpha" and "beta".Requires: alpha > 0 && beta > 0 const param_type &Constructs a gamma_distribution from its parameters. RealTypeReturns the "alpha" paramter of the distribution. RealTypeReturns the "beta" parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealType param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. result_typeEngine &Returns a random variate distributed according to the gamma distribution. RealTypeURNG &const param_type &

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const gamma_distribution &Writes a gamma_distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &gamma_distribution &Reads a gamma_distribution from a std::istream. boolconst gamma_distribution &const gamma_distribution &Returns true if the two distributions will produce identical sequences of random variates given equal generators. boolconst gamma_distribution &const gamma_distribution &Returns true if the two distributions can produce different sequences of random variates, given equal generators.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const param_type &Writes the parameters to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &param_type &Reads the parameters from a std::istream. boolconst param_type &const param_type &Returns true if the two sets of parameters are the same. boolconst param_type &const param_type &Returns true if the two sets fo parameters are different.

RealType RealType

The generalized inverse gaussian distribution is a real-valued distribution with three parameters p, a, and b. It produced values > 0.It has $\displaystyle p(x) = \frac{(a / b)^{p / 2}}{2 K_{p}(\sqrt{a b})} x^{p - 1} e^{-(a x + b / 2) / 2}$$\displaystyle p(x) = \frac{(a / b)^{p / 2}}{2 K_{p}(\sqrt{a b})} x^{p - 1} e^{-(a x + b / 2) / 2}$. where $\displaystyle K_{p}$$\displaystyle K_{p}$ is a modified Bessel function of the second kind.The algorithm used is from

"Random variate generation for the generalized inverse Gaussian distribution", Luc Devroye, Statistics and Computing, Volume 24, 2014, Pages 236 - 246

generalized_inverse_gaussian_distribution

RealType1.0RealType1.0RealType1.0Constructs a param_type object from the "p", "a", and "b" parameters.Requires: a > 0 && b >= 0 if p > 0, a > 0 && b > 0 if p == 0, a >= 0 && b > 0 if p < 0 RealTypeReturns the "p" parameter of the distribution. RealTypeReturns the "a" parameter of the distribution. RealTypeReturns the "b" parameter of the distribution.

RealType RealType

RealType1.0RealType1.0RealType1.0Constructs an generalized_inverse_gaussian_distribution from its "p", "a", and "b" parameters.Requires: a > 0 && b >= 0 if p > 0, a > 0 && b > 0 if p == 0, a >= 0 && b > 0 if p < 0 const param_type &Constructs an generalized_inverse_gaussian_distribution from its parameters. RealTypeURNG &Returns a random variate distributed according to the generalized inverse gaussian distribution. result_typeURNG &const param_type &Returns a random variate distributed accordint to the beta distribution with parameters specified by param. RealTypeReturns the "p" parameter of the distribution. RealTypeReturns the "a" parameter of the distribution. RealTypeReturns the "b" parameter of the distribution. RealTypeReturns the smallest value that the distribution can produce. RealTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const generalized_inverse_gaussian_distribution &Writes an generalized_inverse_gaussian_distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const generalized_inverse_gaussian_distribution &Reads an generalized_inverse_gaussian_distribution from a std::istream. boolconst generalized_inverse_gaussian_distribution &const generalized_inverse_gaussian_distribution &Returns true if the two instances of generalized_inverse_gaussian_distribution will return identical sequences of values given equal generators. boolconst generalized_inverse_gaussian_distribution &const generalized_inverse_gaussian_distribution &Returns true if the two instances of generalized_inverse_gaussian_distribution will return different sequences of values given equal generators.

"Random variate generation for the generalized inverse Gaussian distribution", Luc Devroye, Statistics and Computing, Volume 24, 2014, Pages 236 - 246

generalized_inverse_gaussian_distribution

RealType RealType

RealTypeURNG &Returns a value uniformly distributed in the range [0, 1) with at least bits random bits.

An instantiation of the class template geometric_distribution models a random distribution . The distribution produces positive integers which are the number of bernoulli trials with probability p required to get one that fails.For the geometric distribution, $p(i) = p(1-p)^{i}$$p(i) = p(1-p)^{i}$. This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::geometric_distribution. A backwards compatible wrapper is provided in namespace boost. geometric_distribution

RealType0.5Constructs the parameters with p. RealTypeReturns the p parameter of the distribution.

RealType IntType

const RealType &0.5Contructs a new geometric_distribution with the paramter p.Requires: 0 < p < 1 const param_type &Constructs a new geometric_distribution from its parameters. RealTypeReturns: the distribution parameter p IntTypeReturns the smallest value that the distribution can produce. IntTypeReturns the largest value that the distribution can produce. param_typeReturns the parameters of the distribution. voidconst param_type &Sets the parameters of the distribution. voidEffects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. result_typeEngine &Returns a random variate distributed according to the geometric_distribution. result_typeEngine &const param_type &Returns a random variate distributed according to the geometric distribution with parameters specified by param.

std::basic_ostream< CharT, Traits > &std::basic_ostream< CharT, Traits > &const geometric_distribution &Writes the distribution to a std::ostream. std::basic_istream< CharT, Traits > &std::basic_istream< CharT, Traits > &const geometric_distribution &Reads the distribution from a std::istream. boolconst geometric_distribution &const geometric_distribution &Returns true if the two distributions will produce identical sequences of values given equal generators. boolconst geometric_distribution &const geometric_distribution &Returns true if the two distributions may produce different sequences of values given equal generators.

The hyperexponential distribution is a real-valued continuous distribution with two parameters, the phase probability vector probs and the rate vector rates.A $k$$k$-phase hyperexponential distribution is a mixture of $k$$k$ exponential distributions. For this reason, it is also referred to as mixed exponential distribution or parallel $k$$k$-phase exponential distribution.A $k$$k$-phase hyperexponential distribution is characterized by two parameters, namely a phase probability vector $\mathbf{\alpha}=(\alpha_1,\ldots,\alpha_k)$$\mathbf{\alpha}=(\alpha_1,\ldots,\alpha_k)$ and a rate vector $\mathbf{\lambda}=(\lambda_1,\ldots,\lambda_k)$$\mathbf{\lambda}=(\lambda_1,\ldots,\lambda_k)$.A $k$$k$-phase hyperexponential distribution is frequently used in queueing theory to model the distribution of the superposition of $k$$k$ independent events, like, for instance, the service time distribution of a queueing station with $k$$k$ servers in parallel where the $i$$i$-th server is chosen with probability $\alpha_i$$\alpha_i$ and its service time distribution is an exponential distribution with rate $\lambda_i$$\lambda_i$ (Allen,1990; Papadopolous et al.,1993; Trivedi,2002).For instance, CPUs service-time distribution in a computing system has often been observed to possess such a distribution (Rosin,1965). Also, the arrival of different types of customer to a single queueing station is often modeled as a hyperexponential distribution (Papadopolous et al.,1993). Similarly, if a product manufactured in several parallel assemply lines and the outputs are merged, the failure density of the overall product is likely to be hyperexponential (Trivedi,2002).Finally, since the hyperexponential distribution exhibits a high Coefficient of Variation (CoV), that is a CoV > 1, it is especially suited to fit empirical data with large CoV (Feitelson,2014; Wolski et al.,2013) and to approximate long-tail probability distributions (Feldmann et al.,1998).See (Boost,2014) for more information and examples.A $k$$k$-phase hyperexponential distribution has a probability density function <alt>\[ f(x) = \sum_{i=1}^k \alpha_i \lambda_i e^{-x\lambda_i} \]</alt><mediaobject><imageobject role="html"><imagedata format="PNG" align="center" fileref="images/random//form_21.png"/></imageobject><textobject role="tex"><phrase>\[ f(x) = \sum_{i=1}^k \alpha_i \lambda_i e^{-x\lambda_i} \]</phrase></textobject></mediaobject></equation> where:<itemizedlist> <listitem><para><inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> is the <emphasis>number of phases</emphasis> and also the size of the input vector parameters,</para> </listitem><listitem><para><inlineequation><alt>$\mathbf{\alpha}=(\alpha_1,\ldots,\alpha_k)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_16.png"/></imageobject><textobject role="tex"><phrase>$\mathbf{\alpha}=(\alpha_1,\ldots,\alpha_k)$</phrase></textobject></inlinemediaobject></inlineequation> is the <emphasis>phase probability vector</emphasis> parameter, and</para> </listitem><listitem><para><inlineequation><alt>$\mathbf{\lambda}=(\lambda_1,\ldots,\lambda_k)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_17.png"/></imageobject><textobject role="tex"><phrase>$\mathbf{\lambda}=(\lambda_1,\ldots,\lambda_k)$</phrase></textobject></inlinemediaobject></inlineequation> is the <emphasis>rate vector</emphasis> parameter.</para> </listitem></itemizedlist> Given a <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation>-phase hyperexponential distribution with phase probability vector <inlineequation><alt>$\mathbf{\alpha}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_22.png"/></imageobject><textobject role="tex"><phrase>$\mathbf{\alpha}$</phrase></textobject></inlinemediaobject></inlineequation> and rate vector <inlineequation><alt>$\mathbf{\lambda}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_23.png"/></imageobject><textobject role="tex"><phrase>$\mathbf{\lambda}$</phrase></textobject></inlinemediaobject></inlineequation>, the random variate generation algorithm consists of the following steps (Tyszer,1999):<orderedlist> <listitem><para>Generate a random variable <inlineequation><alt>$U$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_24.png"/></imageobject><textobject role="tex"><phrase>$U$</phrase></textobject></inlinemediaobject></inlineequation> uniformly distribution on the interval <inlineequation><alt>$(0,1)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_25.png"/></imageobject><textobject role="tex"><phrase>$(0,1)$</phrase></textobject></inlinemediaobject></inlineequation>.</para> </listitem><listitem><para>Use <inlineequation><alt>$U$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_24.png"/></imageobject><textobject role="tex"><phrase>$U$</phrase></textobject></inlinemediaobject></inlineequation> to select the appropriate <inlineequation><alt>$\lambda_i$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_20.png"/></imageobject><textobject role="tex"><phrase>$\lambda_i$</phrase></textobject></inlinemediaobject></inlineequation> (e.g., the <emphasis>alias method</emphasis> can possibly be used for this step).</para> </listitem><listitem><para>Generate an exponentially distributed random variable <inlineequation><alt>$X$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_26.png"/></imageobject><textobject role="tex"><phrase>$X$</phrase></textobject></inlinemediaobject></inlineequation> with rate parameter <inlineequation><alt>$\lambda_i$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_20.png"/></imageobject><textobject role="tex"><phrase>$\lambda_i$</phrase></textobject></inlinemediaobject></inlineequation>.</para> </listitem><listitem><para>Return <inlineequation><alt>$X$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_26.png"/></imageobject><textobject role="tex"><phrase>$X$</phrase></textobject></inlinemediaobject></inlineequation>.</para> </listitem></orderedlist> References:<orderedlist> <listitem><para>A.O. Allen, <emphasis>Probability, Statistics, and Queuing Theory with Computer Science Applications, Second Edition</emphasis>, Academic Press, 1990.</para> </listitem><listitem><para>Boost C++ Libraries, <emphasis>Boost.Math / Statistical Distributions: Hyperexponential Distribution</emphasis>, Online: <ulink url="http://www.boost.org/doc/libs/release/libs/math/doc/html/dist.html">http://www.boost.org/doc/libs/release/libs/math/doc/html/dist.html</ulink> , 2014.</para> </listitem><listitem><para>D.G. Feitelson, <emphasis>Workload Modeling for Computer Systems Performance Evaluation</emphasis>, Cambridge University Press, 2014</para> </listitem><listitem><para>A. Feldmann and W. Whitt, <emphasis>Fitting mixtures of exponentials to long-tail distributions to analyze network performance models</emphasis>, Performance Evaluation 31(3-4):245, doi:10.1016/S0166-5316(97)00003-5, 1998.</para> </listitem><listitem><para>H.T. Papadopolous, C. Heavey and J. Browne, <emphasis>Queueing Theory in Manufacturing Systems Analysis and Design</emphasis>, Chapman & Hall/CRC, 1993, p. 35.</para> </listitem><listitem><para>R.F. Rosin, <emphasis>Determining a computing center environment</emphasis>, Communications of the ACM 8(7):463-468, 1965.</para> </listitem><listitem><para>K.S. Trivedi, <emphasis>Probability and Statistics with Reliability, Queueing, and Computer Science Applications</emphasis>, John Wiley & Sons, Inc., 2002.</para> </listitem><listitem><para>J. Tyszer, <emphasis>Object-Oriented Computer Simulation of Discrete-Event Systems</emphasis>, Springer, 1999.</para> </listitem><listitem><para>Wikipedia, <emphasis>Hyperexponential Distribution</emphasis>, Online: <ulink url="http://en.wikipedia.org/wiki/Hyperexponential_distribution">http://en.wikipedia.org/wiki/Hyperexponential_distribution</ulink> , 2014.</para> </listitem><listitem><para>Wolfram Mathematica, <emphasis>Hyperexponential Distribution</emphasis>, Online: <ulink url="http://reference.wolfram.com/language/ref/HyperexponentialDistribution.html">http://reference.wolfram.com/language/ref/HyperexponentialDistribution.html</ulink> , 2014.</para> </listitem></orderedlist> <para>Marco Guazzone (<ulink url="mailto:marco.guazzone@gmail.com">marco.guazzone@gmail.com</ulink>) </para> </para></description><class id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type" name="param_type"><description><para>The parameters of a hyperexponential distribution.</para><para>Stores the <emphasis>phase probability vector</emphasis> and the <emphasis>rate vector</emphasis> of the hyperexponential distribution.</para><para><para>Marco Guazzone (<ulink url="mailto:marco.guazzone@gmail.com">marco.guazzone@gmail.com</ulink>) </para> </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a51ba6c759e9efc231f1cdbdf5b5c85b5" name="distribution_type"><type><classname>hyperexponential_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a7beaa29e8c65d77683b5949cdfb8724c"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> with the default parameters of the distribution. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a2b085b721eedfec42fe93ee7fe59f74f"><template> <template-type-parameter name="ProbIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </para></purpose></template-type-parameter> <template-type-parameter name="RateIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]).</para></purpose></template-type-parameter> </template><parameter name="prob_first"><paramtype>ProbIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="prob_last"><paramtype>ProbIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="rate_first"><paramtype>RateIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the rates. </para></description></parameter><parameter name="rate_last"><paramtype>RateIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the rates.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the range defined by [<emphasis>prob_first</emphasis>, <emphasis>prob_last</emphasis>) iterator pair, and the <emphasis>rate vector</emphasis> parameter is given by the range defined by [<emphasis>rate_first</emphasis>, <emphasis>rate_last</emphasis>) iterator pair.</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1ad6c8123b46bcf09daa3eb8740d1b14d5"><template> <template-type-parameter name="ProbRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept. </para></purpose></template-type-parameter> <template-type-parameter name="RateRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept.</para></purpose></template-type-parameter> </template><parameter name="prob_range"><paramtype>ProbRangeT const &</paramtype><description><para>The range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="rate_range"><paramtype>RateRangeT const &</paramtype><description><para>The range of positive real elements representing the rates.</para></description></parameter><parameter name=""><paramtype>typename boost::disable_if_c< boost::has_pre_increment< ProbRangeT >::value||boost::has_pre_increment< RateRangeT >::value >::type *</paramtype><default>0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the range defined by <emphasis>prob_range</emphasis>, and the <emphasis>rate vector</emphasis> parameter is given by the range defined by <emphasis>rate_range</emphasis>.</para><para> <note><para>The final <computeroutput>disable_if</computeroutput> parameter is an implementation detail that differentiates between this two argument constructor and the iterator-based two argument constructor described below. </para> </note> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1ad319c36fba4c625327a54df2ff0397dc"><template> <template-type-parameter name="RateIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </para></purpose></template-type-parameter> </template><parameter name="rate_first"><paramtype>RateIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the rates. </para></description></parameter><parameter name="rate_last"><paramtype>RateIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the rates.</para></description></parameter><parameter name=""><paramtype>typename boost::enable_if_c< boost::has_pre_increment< RateIterT >::value >::type *</paramtype><default>0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the <emphasis>rate vector</emphasis> parameter of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the range defined by [<emphasis>rate_first</emphasis>, <emphasis>rate_last</emphasis>) iterator pair, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> <note><para>The final <computeroutput>disable_if</computeroutput> parameter is an implementation detail that differentiates between this two argument constructor and the range-based two argument constructor described above.</para> </note> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1aac157c92b8943ee8a2eef8a1520ec82b"><template> <template-type-parameter name="RateRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept.</para></purpose></template-type-parameter> </template><parameter name="rate_range"><paramtype>RateRangeT const &</paramtype><description><para>The range of positive real elements representing the rates. </para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the "rates" parameters of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the range defined by <emphasis>rate_range</emphasis>, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a198751fd58af370ab7065451f9828cec"><parameter name="l1"><paramtype>std::initializer_list< RealT ></paramtype><description><para>The initializer list for inizializing the phase probability vector. </para></description></parameter><parameter name="l2"><paramtype>std::initializer_list< RealT ></paramtype><description><para>The initializer list for inizializing the rate vector.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l1</emphasis>, and the <emphasis>rate vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l2</emphasis>.</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1abeeb8500d8d66be9ee1a73e9ebfc9d3c"><parameter name="l1"><paramtype>std::initializer_list< RealT ></paramtype><description><para>The initializer list for inizializing the rate vector.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the <emphasis>rate vector</emphasis> parameter of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l1</emphasis>, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a0be87b1b008134ef6a923a5f6775a1ec" name="probabilities" cv="const"><type>std::vector< RealT ></type><description><para>Gets the <emphasis>phase probability vector</emphasis> parameter of the distribtuion.</para><para> <note><para>The returned probabilities are the normalized version of the ones passed at construction time. </para> </note> </para></description><returns><para>The <emphasis>phase probability vector</emphasis> parameter of the distribution.</para> </returns></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a3d50b4e6b96b5f62fc2f10667b1f5092" name="rates" cv="const"><type>std::vector< RealT ></type><description><para>Gets the <emphasis>rate vector</emphasis> parameter of the distribtuion.</para><para> </para></description><returns><para>The <emphasis>rate vector</emphasis> parameter of the distribution. </para> </returns></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1aab4dda5b7c7d343d75de31b3f4fd1de5" name="result_type"><type>RealT</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1aad93d829b98d29cf83347fae382b8aae" name="input_type"><type>RealT</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a24d4b4b604013622d320fb1e5a9cd8f1"><description><para>Constructs a 1-phase <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> (i.e., an exponential distribution) with rate 1. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a4dee1c0522210d48fb52632bd60b26a4"><template> <template-type-parameter name="ProbIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </para></purpose></template-type-parameter> <template-type-parameter name="RateIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]).</para></purpose></template-type-parameter> </template><parameter name="prob_first"><paramtype>ProbIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="prob_last"><paramtype>ProbIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="rate_first"><paramtype>RateIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the rates. </para></description></parameter><parameter name="rate_last"><paramtype>RateIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the rates.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the range defined by [<emphasis>prob_first</emphasis>, <emphasis>prob_last</emphasis>) iterator pair, and the <emphasis>rate vector</emphasis> parameter is given by the range defined by [<emphasis>rate_first</emphasis>, <emphasis>rate_last</emphasis>) iterator pair.</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a203748c2c7193830b7e8881dba827900"><template> <template-type-parameter name="ProbRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept. </para></purpose></template-type-parameter> <template-type-parameter name="RateRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept.</para></purpose></template-type-parameter> </template><parameter name="prob_range"><paramtype>ProbRangeT const &</paramtype><description><para>The range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </para></description></parameter><parameter name="rate_range"><paramtype>RateRangeT const &</paramtype><description><para>The range of positive real elements representing the rates.</para></description></parameter><parameter name=""><paramtype>typename boost::disable_if_c< boost::has_pre_increment< ProbRangeT >::value||boost::has_pre_increment< RateRangeT >::value >::type *</paramtype><default>0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the range defined by <emphasis>prob_range</emphasis>, and the <emphasis>rate vector</emphasis> parameter is given by the range defined by <emphasis>rate_range</emphasis>.</para><para> <note><para>The final <computeroutput>disable_if</computeroutput> parameter is an implementation detail that differentiates between this two argument constructor and the iterator-based two argument constructor described below. </para> </note> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a1e2aebcff5262696573b9e01a2466297"><template> <template-type-parameter name="RateIterT"><purpose><para>Must meet the requirements of <computeroutput>InputIterator</computeroutput> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </para></purpose></template-type-parameter> </template><parameter name="rate_first"><paramtype>RateIterT</paramtype><description><para>The iterator to the beginning of the range of non-negative real elements representing the rates. </para></description></parameter><parameter name="rate_last"><paramtype>RateIterT</paramtype><description><para>The iterator to the ending of the range of non-negative real elements representing the rates.</para></description></parameter><parameter name=""><paramtype>typename boost::enable_if_c< boost::has_pre_increment< RateIterT >::value >::type *</paramtype><default>0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from the <emphasis>rate vector</emphasis> parameter of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the range defined by [<emphasis>rate_first</emphasis>, <emphasis>rate_last</emphasis>) iterator pair, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> <note><para>The final <computeroutput>disable_if</computeroutput> parameter is an implementation detail that differentiates between this two argument constructor and the range-based two argument constructor described above.</para> </note> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a4848cda473fed3e6235b5a8f83054e0c"><template> <template-type-parameter name="RateRangeT"><purpose><para>Must meet the requirements of <ulink url="boost:/libs/range/doc/html/range/concepts.html">Range</ulink> concept.</para></purpose></template-type-parameter> </template><parameter name="rate_range"><paramtype>RateRangeT const &</paramtype><description><para>The range of positive real elements representing the rates. </para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1_1param__type">param_type</link></computeroutput> from the "rates" parameters of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the range defined by <emphasis>rate_range</emphasis>, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a2dcf3ad5944f38f3bb8c853525b4dd25" specifiers="explicit"><parameter name="param"><paramtype><classname>param_type</classname> const &</paramtype><description><para>The parameters of the distribution. </para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from its parameters.</para><para> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1aedbc4cec021842cbaf9c5c12433ad825"><parameter name="l1"><paramtype>std::initializer_list< RealT > const &</paramtype><description><para>The initializer list for inizializing the phase probability vector. </para></description></parameter><parameter name="l2"><paramtype>std::initializer_list< RealT > const &</paramtype><description><para>The initializer list for inizializing the rate vector.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from the <emphasis>phase probability vector</emphasis> and <emphasis>rate vector</emphasis> parameters of the distribution.</para><para>The <emphasis>phase probability vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l1</emphasis>, and the <emphasis>rate vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l2</emphasis>.</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a3ea25e56ee9e621f09be6deb284a6e92"><parameter name="l1"><paramtype>std::initializer_list< RealT > const &</paramtype><description><para>The initializer list for inizializing the rate vector.</para></description></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from the <emphasis>rate vector</emphasis> parameter of the distribution and with equal phase probabilities.</para><para>The <emphasis>rate vector</emphasis> parameter is given by the <emphasis>brace-init-list</emphasis> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <emphasis>l1</emphasis>, and the <emphasis>phase probability vector</emphasis> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <inlineequation><alt>$k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_15.png"/></imageobject><textobject role="tex"><phrase>$k$</phrase></textobject></inlinemediaobject></inlineequation> of the <emphasis>rate vector</emphasis> and with each element set to <inlineequation><alt>$1.0/k$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_27.png"/></imageobject><textobject role="tex"><phrase>$1.0/k$</phrase></textobject></inlinemediaobject></inlineequation>).</para><para> References:<orderedlist> <listitem><para>ISO, <emphasis>ISO/IEC 14882-2014: Information technology - Programming languages - C++</emphasis>, 2014</para> </listitem></orderedlist> </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a87691d35ce91ee743ed144ee2e3b3879" name="operator()" cv="const"><type>RealT</type><template> <template-type-parameter name="URNG"><purpose><para>Must meet the requirements of <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> .</para></purpose></template-type-parameter> </template><parameter name="urng"><paramtype>URNG &</paramtype><description><para>A uniform random number generator object.</para></description></parameter><description><para>Gets a random variate distributed according to the hyperexponential distribution.</para><para> </para></description><returns><para>A random variate distributed according to the hyperexponential distribution. </para> </returns></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1ab8cf131a35d675fe3837a17c4b70873b" name="operator()" cv="const"><type>RealT</type><template> <template-type-parameter name="URNG"><purpose><para>Must meet the requirements of <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> .</para></purpose></template-type-parameter> </template><parameter name="urng"><paramtype>URNG &</paramtype><description><para>A uniform random number generator object. </para></description></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype><description><para>A distribution parameter object.</para></description></parameter><description><para>Gets a random variate distributed according to the hyperexponential distribution with parameters specified by <computeroutput>param</computeroutput>.</para><para> </para></description><returns><para>A random variate distributed according to the hyperexponential distribution. distribution with parameters specified by <computeroutput>param</computeroutput>. </para> </returns></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a13e5b222112f26735031a8631a5b833b" name="num_phases" cv="const"><type>std::size_t</type><description><para>Returns the number of phases of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1ae019614cc9cd91ec2dff306459289437" name="probabilities" cv="const"><type>std::vector< RealT ></type><description><para>Returns the <emphasis>phase probability vector</emphasis> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a91e61293608aa905762ad27262cb48af" name="rates" cv="const"><type>std::vector< RealT ></type><description><para>Returns the <emphasis>rate vector</emphasis> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1ad274da384a55786719dd3ecab8967f84" name="min" cv="const"><type>RealT</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1ae2b2e1ce0c3d4ce7ba36cfe49c9c6b88" name="max" cv="const"><type>RealT</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a0ae4ddc40714698ef0f77af68e825914" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a9179d63f1a4b7cb8c2ef8f440e2c1c03" name="param"><type>void</type><parameter name="param"><paramtype><classname>param_type</classname> const &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a64670d7145c552ae917e439054c51319" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1aa06dc41983022d0c078cf8524420d963" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="hd"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><description><para>Writes an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1ad02f9fcbccc124a8d9b3444166860641" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="hd"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><description><para>Reads an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a6657878b0ad3c40bb3d25b4ff7da6c3b" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution_1a8ec524e4c493bb9376cf0df0898f6058" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>hyperexponential_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1hyperexponential__distribution">hyperexponential_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.independent__bits_8hpp" name="boost/random/independent_bits.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine" name="independent_bits_engine"><template> <template-type-parameter name="Engine"/> <template-nontype-parameter name="w"><type>std::size_t</type></template-nontype-parameter> <template-type-parameter name="UIntType"/> </template><description><para>An instantiation of class template <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It generates random numbers distributed between [0, 2^w) by combining one or more invocations of the base engine.</para><para>Requires: 0 < w <= std::numeric_limits<UIntType>::digits </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a804aae374a18fd3e66a71da2daec5edf" name="base_type"><type>Engine</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a3a9c0f7b166a17c665324e29a7ae0d10" name="result_type"><type>UIntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1ab6ba29e7a965a4f21f2f083d471a46ac" name="base_result_type"><type>Engine::result_type</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1ae610b31494b26f74ded350682fb727d1" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a5ac02bfca124e1690f02589a528bbcee" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1aa810e9f67b52eceb84e1904d25327eae" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a505e2a187367307c58129f14dddfbcbf"><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> using the default constructor of the base generator. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a7032f006a2629f996a0c0363efcb0480" specifiers="explicit"><parameter name="seed"><paramtype>base_result_type</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput>, using seed as the constructor argument for both base generators. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a018dac6fd0427c37673876312082311e" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput>, using seq as the constructor argument for the base generator. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a3c001453d3d687ce40a6ec43913f7e9d"><parameter name="base_arg"><paramtype>const base_type &</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> by copying <computeroutput>base</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a472dc74603eb8275c1bf5c4457b68d36"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Contructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.</para><para>Throws: <computeroutput>std::invalid_argument</computeroutput> if the input range is too small.</para><para>Exception Safety: Basic </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1add71dc930e19dab7c13d1d93d9b0d398" name="seed"><type>void</type><description><para>Seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> using the default seed of the base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a05427d15647c2c9c47801df1a7e5b739" name="seed"><type>void</type><parameter name="seed"><paramtype>base_result_type</paramtype></parameter><description><para>Seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput>, using <computeroutput>seed</computeroutput> as the seed for the base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a0c7c7a5aef2b30df7379229abf879b57" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput>, using <computeroutput>seq</computeroutput> to seed the base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1ae6219552edde9c919d743a34fa9be9ed" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.</para><para>Throws: <computeroutput>std::invalid_argument</computeroutput> if the input range is too small.</para><para>Exception Safety: Basic </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a491a9f367d4aae50b69d21546e45ab89" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1ac4b5539aa93637e89659d6d27a985e6a" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1af64be62f5811be396be33128f74b3771" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1aad1b918a0d080ad453cdc45ad311394e" name="base" cv="const"><type>const base_type &</type></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a17f8bef620bc88aed389cb42063cc7b5" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation if the generator to a <computeroutput>std::ostream</computeroutput>. The textual representation of the engine is the textual representation of the base engine. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a3b41869e6a87f3ff336b3421195966e5" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><description><para>Reads the state of an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1independent__bits__engine">independent_bits_engine</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a75231dbd66015d3a5644a5ff56fae27a" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><description><para>Returns: true iff the two <computeroutput>independent_bits_engines</computeroutput> will produce the same sequence of values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1independent__bits__engine_1a91620cd2d6bfd236f946c372a0416564" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>independent_bits_engine</classname> &</paramtype></parameter><description><para>Returns: true iff the two <computeroutput>independent_bits_engines</computeroutput> will produce different sequences of values. </para></description></method> </method-group> </class><data-member id="doxygen.headers.independent__bits_8hpp_1afbc68b498f6fe7b0e679b7a6b7f16304" name="independent_bits_engine< Engine, w, UIntType >::has_fixed_range"><type>const bool</type></data-member> </namespace> </namespace> </header> <header id="doxygen.headers.inverse__gaussian__distribution_8hpp" name="boost/random/inverse_gaussian_distribution.hpp"> <namespace name="boost"> <namespace name="random"> </namespace> </namespace> </header> <header id="doxygen.headers.inversive__congruential_8hpp" name="boost/random/inversive_congruential.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine" name="inversive_congruential_engine"><template> <template-type-parameter name="IntType"/> <template-nontype-parameter name="a"><type>IntType</type></template-nontype-parameter> <template-nontype-parameter name="b"><type>IntType</type></template-nontype-parameter> <template-nontype-parameter name="p"><type>IntType</type></template-nontype-parameter> </template><description><para>Instantiations of class template <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses the inversive congruential algorithm (ICG) described in</para><para> <blockquote><para> "Inversive pseudorandom number generators: concepts, results and links", Peter Hellekalek, In: "Proceedings of the 1995 Winter Simulation Conference", C. Alexopoulos, K. Kang, W.R. Lilegdon, and D. Goldsman (editors), 1995, pp. 255-262. <ulink url="ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps">ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps</ulink> </para></blockquote> </para><para>The output sequence is defined by x(n+1) = (a*inv(x(n)) - b) (mod p), where x(0), a, b, and the prime number p are parameters of the generator. The expression inv(k) denotes the multiplicative inverse of k in the field of integer numbers modulo p, with inv(0) := 0.</para><para>The template parameter IntType shall denote a signed integral type large enough to hold p; a, b, and p are the parameters of the generators. The template parameter val is the validation value checked by validation.</para><para> <note><para> The implementation currently uses the Euclidian Algorithm to compute the multiplicative inverse. Therefore, the inversive generators are about 10-20 times slower than the others (see section"performance"). However, the paper talks of only 3x slowdown, so the Euclidian Algorithm is probably not optimal for calculating the multiplicative inverse. </para></note> </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a9c905f5b07c8cb10318a1086f81b681e" name="result_type"><type>IntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a1a7744e7ee21243a0d23cb5ddad3bcfe" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1afd057e4e5bfd54c5b82310505126a09f" name="multiplier" specifiers="static"><type>const result_type</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1af9e1072e1b3bc798e018397eaf2e8449" name="increment" specifiers="static"><type>const result_type</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a9adaf97e8ca5777278d0c1f3e358d619" name="modulus" specifiers="static"><type>const result_type</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a79d04551382da7271d9f2c82543ce8c7" name="default_seed" specifiers="static"><type>const IntType</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a188c23f9c6c1d99f036dfc1e28f545da" name="min" specifiers="static"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1ac87bd38f50703a2df393aae1ef09c01c" name="max" specifiers="static"><type>result_type</type></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a4df22ea45cecbb6d241082a9ee6c45e5"><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput>, seeding it with the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a24ab446b538bb7a8e340f778ce7f93e8" specifiers="explicit"><parameter name="x0"><paramtype>IntType</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput>, seeding it with <computeroutput>x0</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1accbf48672ab9b3ce1e1c52f992ea6f8d" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput>, seeding it with values produced by a call to <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1ac5b1dd5eeacfe0bca195cf681760888b"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput>, seeds it with values taken from the itrator range [first, last), and adjusts first to point to the element after the last one used. If there are not enough elements, throws <computeroutput>std::invalid_argument</computeroutput>.</para><para>first and last must be input iterators. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1abeb333952cea11d4a87226642fc37c7d" name="seed"><type>void</type><description><para>Calls seed(default_seed) </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a762bee3bebf1be7afc48c62acb2ea36d" name="seed"><type>void</type><parameter name="x0"><paramtype>IntType</paramtype></parameter><description><para>If c mod m is zero and x0 mod m is zero, changes the current value of the generator to 1. Otherwise, changes it to x0 mod m. If c is zero, distinct seeds in the range [1,m) will leave the generator in distinct states. If c is not zero, the range is [0,m). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1afa3b3a56d2bf5a562926bcf3de7449ee" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput> using values from a SeedSeq. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a054685e76353132afbcabfd207fc3f13" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>seeds an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine">inversive_congruential_engine</link></computeroutput> with values taken from the itrator range [first, last) and adjusts <computeroutput>first</computeroutput> to point to the element after the last one used. If there are not enough elements, throws <computeroutput>std::invalid_argument</computeroutput>.</para><para><computeroutput>first</computeroutput> and <computeroutput>last</computeroutput> must be input iterators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a038e10a676cea67a23f04978fbcb94ff" name="operator()"><type>IntType</type><description><para>Returns the next output of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1abf6b7a74185c857470a148a833edca43" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1aeec133826f9bf769c1f69f2610e48db7" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1ad6a9202f1eb4b0e37f549a605f4dc2f7" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="x"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a02b377108499ed23bd7b82d32c5658fe" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="x"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a5c8f6050fc67b48f1cf187bd092ff2ee" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1inversive__congruential__engine_1a050602f7a4ad511b67aefabbe16623ae" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>inversive_congruential_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of outputs. </para></description></method> </method-group> </class><typedef id="doxygen.headers.inversive__congruential_8hpp_1a70fd194ea5f8599d76496e98cb0412a5" name="hellekalek1995"><description><para>The specialization hellekalek1995 was suggested in</para><para> <blockquote><para> "Inversive pseudorandom number generators: concepts, results and links", Peter Hellekalek, In: "Proceedings of the 1995 Winter Simulation Conference", C. Alexopoulos, K. Kang, W.R. Lilegdon, and D. Goldsman (editors), 1995, pp. 255-262. <ulink url="ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps">ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps</ulink> </para></blockquote> </para></description><type><classname>inversive_congruential_engine</classname>< uint32_t, 9102, 2147483647-36884165, 2147483647 ></type></typedef> <data-member id="doxygen.headers.inversive__congruential_8hpp_1a58459c611c9b108c8a40dc25cd397671" name="inversive_congruential_engine< IntType, a, b, p >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.inversive__congruential_8hpp_1a55d987efade6e850dc77f0e083d02dce" name="inversive_congruential_engine< IntType, a, b, p >::multiplier"><type>const <classname>inversive_congruential_engine</classname>< IntType, a, b, p >::result_type</type></data-member> <data-member id="doxygen.headers.inversive__congruential_8hpp_1ae7d7477a20db68161d5ea6670397db2e" name="inversive_congruential_engine< IntType, a, b, p >::increment"><type>const <classname>inversive_congruential_engine</classname>< IntType, a, b, p >::result_type</type></data-member> <data-member id="doxygen.headers.inversive__congruential_8hpp_1af25cd6043f080e706d7c739ffe0b6799" name="inversive_congruential_engine< IntType, a, b, p >::modulus"><type>const <classname>inversive_congruential_engine</classname>< IntType, a, b, p >::result_type</type></data-member> <data-member id="doxygen.headers.inversive__congruential_8hpp_1ac5606792dc550c9fbce0808cc6bbdcb6" name="inversive_congruential_engine< IntType, a, b, p >::default_seed"><type>const <classname>inversive_congruential_engine</classname>< IntType, a, b, p >::result_type</type></data-member> </namespace> <typedef id="doxygen.headers.inversive__congruential_8hpp_1a70fd194ea5f8599d76496e98cb0412a5" name="hellekalek1995"><description><para>The specialization hellekalek1995 was suggested in</para><para> <blockquote><para> "Inversive pseudorandom number generators: concepts, results and links", Peter Hellekalek, In: "Proceedings of the 1995 Winter Simulation Conference", C. Alexopoulos, K. Kang, W.R. Lilegdon, and D. Goldsman (editors), 1995, pp. 255-262. <ulink url="ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps">ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps</ulink> </para></blockquote> </para></description><type>inversive_congruential_engine< uint32_t, 9102, 2147483647-36884165, 2147483647 ></type></typedef> </namespace> </header> <header id="doxygen.headers.lagged__fibonacci_8hpp" name="boost/random/lagged_fibonacci.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine" name="lagged_fibonacci_01_engine"><template> <template-type-parameter name="RealType"/> <template-nontype-parameter name="w"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="p"><type>unsigned int</type></template-nontype-parameter> <template-nontype-parameter name="q"><type>unsigned int</type></template-nontype-parameter> </template><description><para>Instantiations of class template <computeroutput>lagged_fibonacci_01</computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses a lagged Fibonacci algorithm with two lags <computeroutput>p</computeroutput> and <computeroutput>q</computeroutput>, evaluated in floating-point arithmetic: x(i) = x(i-p) + x(i-q) (mod 1) with p > q. See</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para><para> <note><para> The quality of the generator crucially depends on the choice of the parameters. User code should employ one of the sensibly parameterized generators such as <classname alt="boost::random::lagged_fibonacci607">lagged_fibonacci607</classname> instead. </para></note> </para><para>The generator requires considerable amounts of memory for the storage of its state array. For example, <classname alt="boost::random::lagged_fibonacci607">lagged_fibonacci607</classname> requires about 4856 bytes and <classname alt="boost::random::lagged_fibonacci44497">lagged_fibonacci44497</classname> requires about 350 KBytes. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1aaad9ace85f92a7fa0c77b5c2d1b86e65" name="result_type"><type>RealType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1abb6860e53e49994e4eb6d19a12b8a991" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a30bc1c5557df699bb8efb5ad18290d17" name="word_size" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a6f9d7c082dd02a8fc07e3cfedf14fed5" name="long_lag" specifiers="static"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a116712f4ba5882fb8ad40e8c4dbc058b" name="short_lag" specifiers="static"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a5ad0077e8eed44068b86bc8be706a205" name="default_seed" specifiers="static"><type>const boost::uint32_t</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a8d499207383e79363161432249dd493b"><description><para>Constructs a <computeroutput>lagged_fibonacci_01</computeroutput> generator and calls <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a8d78f4687cdd6a14c2e6b76efc1bac37">seed()</link></computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a56409ab17cdff6b274a654d2d5d2b822" specifiers="explicit"><parameter name="value"><paramtype>uint32_t</paramtype></parameter><description><para>Constructs a <computeroutput>lagged_fibonacci_01</computeroutput> generator and calls <computeroutput>seed(value)</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a7ce7f3c5e8a921693eb7443d66bfdf38" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a <computeroutput>lagged_fibonacci_01</computeroutput> generator and calls <computeroutput>seed(gen)</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a5ea267d4479c07980b2a8601714e2aed"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter></constructor> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a8d78f4687cdd6a14c2e6b76efc1bac37" name="seed"><type>void</type><description><para>Calls seed(default_seed). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a6ce9dc30ce927f866bcde1402bc76426" name="seed"><type>void</type><parameter name="value"><paramtype>boost::uint32_t</paramtype></parameter><description><para>Constructs a <classname alt="boost::random::minstd_rand0">minstd_rand0</classname> generator with the constructor parameter value and calls seed with it. Distinct seeds in the range [1, 2147483647) will produce generators with different states. Other seeds will be equivalent to some seed within this range. See <classname alt="boost::random::linear_congruential_engine">linear_congruential_engine</classname> for details. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1aa99d174759973cd1f09f76c6173b541c" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds this <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine">lagged_fibonacci_01_engine</link></computeroutput> using values produced by <computeroutput>seq.generate</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a604d63c6d04a2cf489cf349e5c1a17af" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds this <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine">lagged_fibonacci_01_engine</link></computeroutput> using values from the iterator range [first, last). If there are not enough elements in the range, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a9241ff8593d4a63c0d50d3d97a4ad83f" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1aa6582f23ff792ead5d749b04dc757798" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1aff63cb15e5f1dcedb6e1602609d363d8" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a7550033e605fdb9d5b498619b067109c" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1ac0d14d8e19db88f6f21e4614696a9089" name="max" specifiers="static"><type>result_type</type><description><para>Returns the upper bound of the generators outputs. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a8f7bf5401dfcc900b244992caf65f09e" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1ae09f552a451dff361de1ed981b29e098" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a3e7291a52c117a1089fa303f09612bf4" name="operator=="><type>bool</type><parameter name="x_"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><parameter name="y_"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__01__engine_1a83ca87f7534c4a26806a50ca9a0b6afd" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>lagged_fibonacci_01_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of outputs. </para></description></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine" name="lagged_fibonacci_engine"><template> <template-type-parameter name="UIntType"/> <template-nontype-parameter name="w"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="p"><type>unsigned int</type></template-nontype-parameter> <template-nontype-parameter name="q"><type>unsigned int</type></template-nontype-parameter> </template><description><para>Instantiations of class template <classname alt="boost::random::lagged_fibonacci_engine">lagged_fibonacci_engine</classname> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses a lagged Fibonacci algorithm with two lags <computeroutput>p</computeroutput> and <computeroutput>q:</computeroutput> x(i) = x(i-p) + x(i-q) (mod 2<superscript>w</superscript>) with p > q. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a4f2b2cc336b578dfae5b529fc2593834" name="result_type"><type>UIntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a71f72306254567a67788ef6e40899a5c" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a786e1d56dd2ba99cff4057ee77546bb5" name="word_size" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1ac8dc6ece4c4a716baf9348833e513cbf" name="long_lag" specifiers="static"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a38788f559e9bd27eb3e0dcc6b672a1cd" name="short_lag" specifiers="static"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a78dfc773918eb7bf8404749a99f5fd2b" name="default_seed" specifiers="static"><type>const UIntType</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1aeb6238dc7b95b8b1ca65f3c3f599713c" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1abcfb16d7a8c6536443b5d28cfc373fd6" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a08d4dc9ca4281f6c6dc3823757e49041"><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine">lagged_fibonacci_engine</link></computeroutput> and calls <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a631afad8123b77d4948de04c111f29e2">seed()</link></computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a217014d7d759a8847d89042568d948d2" specifiers="explicit"><parameter name="value"><paramtype>UIntType</paramtype></parameter><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine">lagged_fibonacci_engine</link></computeroutput> and calls <computeroutput>seed(value)</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a175e5c1f12ff8be1b81bf9c51b0c1a77" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine">lagged_fibonacci_engine</link></computeroutput> and calls <computeroutput>seed(seq)</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a1d6ee752e2a765ffac6f218155964e74"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine">lagged_fibonacci_engine</link></computeroutput> and calls <computeroutput>seed(first, last)</computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a631afad8123b77d4948de04c111f29e2" name="seed"><type>void</type><description><para>Calls <computeroutput>seed(default_seed)</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a14bfe6fe27da6a707437477ee2be504c" name="seed"><type>void</type><parameter name="value"><paramtype>UIntType</paramtype></parameter><description><para>Sets the state of the generator to values produced by a <classname alt="boost::random::minstd_rand0">minstd_rand0</classname> generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1ae9289b65d5e4fcc8f0cadf1b9973bd1b" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Sets the state of the generator using values produced by seq. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1adba6871fcfce0df768e17d88aea607ff" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Sets the state of the generator to values from the iterator range [first, last). If there are not enough elements in the range [first, last) throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a819e7657f570a37d904467bcfaed447c" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a05990155eab57fe2146620c91b8f3855" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a62a11cbff391c264e9b9970577386640" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a8dfd1ec3c24ac82be890815fe1e58a50" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1ab2e5945bc5616566ddb03c47c07cf6d4" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1ae65f545a77414d7a60360ddfd10c3456" name="operator=="><type>bool</type><parameter name="x_"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><parameter name="y_"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lagged__fibonacci__engine_1a9d62305f7fdc640e034825b32a28e883" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>lagged_fibonacci_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of outputs. </para></description></method> </method-group> </class><typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a638258aa37c381afde036154b21dd8f7" name="lagged_fibonacci607"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 607, 273 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1aacc9daef963c25f84644d3991c018dc3" name="lagged_fibonacci1279"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 1279, 418 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1ae59d68f77b7c061a6f1f82343f0b9595" name="lagged_fibonacci2281"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 2281, 1252 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a0b3b3d84ccad8aa706be3f8d0d0871eb" name="lagged_fibonacci3217"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 3217, 576 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1acd5d88d8c8ee5742a1c13495b3c8b429" name="lagged_fibonacci4423"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 4423, 2098 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1adf91aa0546157037dfe3b0d989def99f" name="lagged_fibonacci9689"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 9689, 5502 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a71a9b29dc0d63356f371c0f98cd76587" name="lagged_fibonacci19937"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 19937, 9842 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a9bfeb53f8901db50a0c4554c9204c108" name="lagged_fibonacci23209"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 23209, 13470 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a19cae9c64fd97bb1c8e464351cdb3e7a" name="lagged_fibonacci44497"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type><classname>lagged_fibonacci_01_engine</classname>< double, 48, 44497, 21034 ></type></typedef> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1ae816e40f7a4ef0a97bdd2b3ac5b2d19b" name="lagged_fibonacci_engine< UIntType, w, p, q >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1ad5a512e5a17525595627133ffd265650" name="lagged_fibonacci_engine< UIntType, w, p, q >::long_lag"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1a3ec450a1b2cd220f2a16775f441b3300" name="lagged_fibonacci_engine< UIntType, w, p, q >::short_lag"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1a7d72bb2c92854200bd72f465375404b4" name="lagged_fibonacci_engine< UIntType, w, p, q >::default_seed"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1acd430398d94cb7449729037fe3f3329f" name="lagged_fibonacci_01_engine< RealType, w, p, q >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1a93900ab8e18af9d2282c4b947dcbbec9" name="lagged_fibonacci_01_engine< RealType, w, p, q >::long_lag"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1ace868ae872ef4a8970cecdfe8e002711" name="lagged_fibonacci_01_engine< RealType, w, p, q >::short_lag"><type>const unsigned int</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1aa0cf13f99f1be986c49487e43ec5e974" name="lagged_fibonacci_01_engine< RealType, w, p, q >::word_size"><type>const int</type></data-member> <data-member id="doxygen.headers.lagged__fibonacci_8hpp_1a9adf2c3af56e2d31e4f6044ee02547db" name="lagged_fibonacci_01_engine< RealType, w, p, q >::default_seed"><type>const boost::uint32_t</type></data-member> </namespace> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a638258aa37c381afde036154b21dd8f7" name="lagged_fibonacci607"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 607, 273 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1aacc9daef963c25f84644d3991c018dc3" name="lagged_fibonacci1279"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 1279, 418 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1ae59d68f77b7c061a6f1f82343f0b9595" name="lagged_fibonacci2281"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 2281, 1252 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a0b3b3d84ccad8aa706be3f8d0d0871eb" name="lagged_fibonacci3217"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 3217, 576 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1acd5d88d8c8ee5742a1c13495b3c8b429" name="lagged_fibonacci4423"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 4423, 2098 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1adf91aa0546157037dfe3b0d989def99f" name="lagged_fibonacci9689"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 9689, 5502 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a71a9b29dc0d63356f371c0f98cd76587" name="lagged_fibonacci19937"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 19937, 9842 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a9bfeb53f8901db50a0c4554c9204c108" name="lagged_fibonacci23209"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 23209, 13470 ></type></typedef> <typedef id="doxygen.headers.lagged__fibonacci_8hpp_1a19cae9c64fd97bb1c8e464351cdb3e7a" name="lagged_fibonacci44497"><description><para>The specializations lagged_fibonacci607 ... lagged_fibonacci44497 use well tested lags.</para><para>See</para><para> <blockquote><para> "On the Periods of Generalized Fibonacci Recurrences", Richard P. Brent Computer Sciences Laboratory Australian National University, December 1992 </para></blockquote> </para><para>The lags used here can be found in</para><para> <blockquote><para> "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706. </para></blockquote> </para></description><type>lagged_fibonacci_01_engine< double, 48, 44497, 21034 ></type></typedef> </namespace> </header> <header id="doxygen.headers.laplace__distribution_8hpp" name="boost/random/laplace_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1laplace__distribution" name="laplace_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The laplace distribution is a real-valued distribution with two parameters, mean and beta.</para><para>It has <inlineequation><alt>$\displaystyle p(x) = \frac{e^-{\frac{|x-\mu|}{\beta}}}{2\beta}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_28.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{e^-{\frac{|x-\mu|}{\beta}}}{2\beta}$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><class id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1ad60d61c922815fce9620500f213f3689" name="distribution_type"><type><classname>laplace_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1a9e8aac8fa2546d2f6065e3124dd672fb" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="beta"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type">param_type</link></computeroutput> from the "mean" and "beta" parameters of the distribution. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1a43fe6a23570eeff04c109f1a3b23dbf0" name="mean" cv="const"><type>RealType</type><description><para>Returns the "mean" parameter of the distribtuion. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1a3708f3da2b7210096b08225d83f28e31" name="beta" cv="const"><type>RealType</type><description><para>Returns the "beta" parameter of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a6790be27d982914bd41c5ebf5267a26f" name="result_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a312e6b925bcda9a64e7c83eaef476143" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1aa8b3ce69b6afde04ebfd4dfc66d4c8b1" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="beta"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> from its "mean" and "beta" parameters. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1abec013c6a77eb0f3247ed0b6913a8a47" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a677ecc7213cf2a304166c7ac06c59e42" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the laplace distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a474c4575449c4eec094d63cb18b4d367" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed accordint to the laplace distribution with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1ae1d1bfd9fc0ababe50faf1dfa520dccb" name="mean" cv="const"><type>RealType</type><description><para>Returns the "mean" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a83c175617129aac8fda3cee830a90eac" name="beta" cv="const"><type>RealType</type><description><para>Returns the "beta" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1aabc4d8aaf678b81621048857566a38df" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1ac58520ae2659356b5f919433b9d2c047" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a3f1c25c22c2c6313f0323e35bf7ddf41" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a1946489fcd3a8db897b234af4752abcf" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1ab53c6159ab8d80e7c10fc8f11d271f6c" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1aaf51dd7b5b749e977471dd8fe485b07f" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="wd"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><description><para>Writes an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a09305aac6263bb1420df21cb55d69c57" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="wd"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><description><para>Reads an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a9b8849ccb6358b9c855798fee5ca5ad7" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1laplace__distribution_1a3bb5211059b3c832b2e3caaf7a663467" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>laplace_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1laplace__distribution">laplace_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.linear__congruential_8hpp" name="boost/random/linear_congruential.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1rand48" name="rand48"><description><para>Class <computeroutput><link linkend="doxygen.headers.classboost_1_1rand48">rand48</link></computeroutput> models a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses the linear congruential algorithm with the parameters a = 0x5DEECE66D, c = 0xB, m = 2**48. It delivers identical results to the <computeroutput>lrand48()</computeroutput> function available on some systems (assuming lcong48 has not been called).</para><para>It is only available on systems where <computeroutput>uint64_t</computeroutput> is provided as an integral type, so that for example static in-class constants and/or enum definitions with large <computeroutput>uint64_t</computeroutput> numbers work. </para></description><typedef id="doxygen.headers.classboost_1_1rand48_1af9d04118c135517b2a22dad22989b612" name="result_type"><type>boost::uint32_t</type></typedef> <data-member id="doxygen.headers.classboost_1_1rand48_1aaee776c41e268503bdb1a173e2f56edd" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1rand48_1a9d993f16ee35c7ec1bac30172fbb7a65" name="min" specifiers="static"><type>uint32_t</type><description><para>Returns the smallest value that the generator can produce </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1aa73ccc74fddbce60ec84c7d1be4f167e" name="max" specifiers="static"><type>uint32_t</type><description><para>Returns the largest value that the generator can produce </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1rand48_1a77bc2858807fa56d021e1e120e37c70c"><description><para>Seeds the generator with the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1rand48_1a809101f639286bf4477cf8d5b922da62" specifiers="explicit"><parameter name="x0"><paramtype>result_type</paramtype></parameter><description><para>Constructs a <classname alt="boost::random::rand48">rand48</classname> generator with x(0) := (x0 << 16) | 0x330e. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1rand48_1a35cb51917e74deea856e1fea9913892d" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1rand48_1a519aa7adaec3c13ee7a82fbf305b89a0"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </para></description></constructor> <method id="doxygen.headers.classboost_1_1rand48_1ab8326c1b82bb7678321ff1d1086cb0f5" name="seed"><type>void</type><description><para>Seeds the generator with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1a0d2254160d5e4f5cdbe21b65b6cecc8a" name="seed"><type>void</type><parameter name="x0"><paramtype>result_type</paramtype></parameter><description><para>Changes the current value x(n) of the generator to (x0 << 16) | 0x330e. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1ad145008e8045410b45237104379d2858" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1adaead8b7d5001de9b330d4fa9e413346" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1ae48c2737b1b6dfebc1ebaca206d4739e" name="operator()"><type>uint32_t</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1a96d6eb23571f2715ff42f663832db8a4" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1a0ef8390f308476ef2e9723a23b04e6e4" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1rand48_1a71ac944f2f32f913cd4aca445238be6f" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1rand48">rand48</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1a37fac642eb6a57d55be2a8c6806f84dc" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype><classname>rand48</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1rand48">rand48</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1a0e033e22f48e2fd092b4ca7c9bc1de58" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of values. </para></description></method> <method id="doxygen.headers.classboost_1_1rand48_1abde37cb79b96515216380a6a11de7e11" name="operator!="><type>bool</type><parameter name="x"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of values. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine" name="linear_congruential_engine"><template> <template-type-parameter name="IntType"/> <template-nontype-parameter name="a"><type>IntType</type></template-nontype-parameter> <template-nontype-parameter name="c"><type>IntType</type></template-nontype-parameter> <template-nontype-parameter name="m"><type>IntType</type></template-nontype-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . Linear congruential pseudo-random number generators are described in:</para><para> <blockquote><para> "Mathematical methods in large-scale computing units", D. H. Lehmer, Proc. 2nd Symposium on Large-Scale Digital Calculating Machines, Harvard University Press, 1951, pp. 141-146 </para></blockquote> </para><para>Let x(n) denote the sequence of numbers returned by some pseudo-random number generator. Then for the linear congruential generator, x(n+1) := (a * x(n) + c) mod m. Parameters for the generator are x(0), a, c, m. The template parameter IntType shall denote an integral type. It must be large enough to hold values a, c, and m. The template parameters a and c must be smaller than m.</para><para>Note: The quality of the generator crucially depends on the choice of the parameters. User code should use one of the sensibly parameterized generators such as minstd_rand instead. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a4b92a1500931b875d7cff5c6ae42128c" name="result_type"><type>IntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1aa323e86fa3f0c755439f230a9f2553b2" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a9ea7c62433dd4b6e6cadc891582cbbd2" name="multiplier" specifiers="static"><type>const IntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ab1d04e3499df81c8d95a1c013d181946" name="increment" specifiers="static"><type>const IntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a581c6b3a1cb9a9fbb3d54ca37035df23" name="modulus" specifiers="static"><type>const IntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ad81a1e01780a5d2268dd5163216aa3be" name="default_seed" specifiers="static"><type>const IntType</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a7ba1c7ea6051b711530e252d16ece7df"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput>, using the default seed </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ae4bbd4fef372bbde81b9b3bd7e0d5266" specifiers="explicit"><parameter name="x0"><paramtype>IntType</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput>, seeding it with <computeroutput>x0</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a8e30bcb76d3ce33194267e88a4aaeaa5" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput>, seeding it with values produced by a call to <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ac5eabebdfd0eb356820b7592037a9c1a"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> and seeds it with values taken from the itrator range [first, last) and adjusts first to point to the element after the last one used. If there are not enough elements, throws <computeroutput>std::invalid_argument</computeroutput>.</para><para>first and last must be input iterators. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ad93f7a599811bd7a453edabe9673769e" name="seed"><type>void</type><description><para>Calls seed(default_seed) </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1aecf65e4c191295119bacfdf9c40b2169" name="seed"><type>void</type><parameter name="x0_"><paramtype>IntType</paramtype></parameter><description><para>If c mod m is zero and x0 mod m is zero, changes the current value of the generator to 1. Otherwise, changes it to x0 mod m. If c is zero, distinct seeds in the range [1,m) will leave the generator in distinct states. If c is not zero, the range is [0,m). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a78c0a48ec8f717c987281d9c2731fafc" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> using values from a SeedSeq. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a0d3fb46455d7d44e3535655752207dc4" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> with values taken from the itrator range [first, last) and adjusts <computeroutput>first</computeroutput> to point to the element after the last one used. If there are not enough elements, throws <computeroutput>std::invalid_argument</computeroutput>.</para><para><computeroutput>first</computeroutput> and <computeroutput>last</computeroutput> must be input iterators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a966d0d6a8789db29983e98034c6c0282" name="operator()"><type>IntType</type><description><para>Returns the next value of the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1ab0fedc415e34e2fb7985dd8c34733006" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1afe8a858b2d608f6872efcb14d5dd4d5c" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a8e2287fc30588ee4d51fdc2258c49a4a" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a88d9f2dd0ef26f5b36cd9ef09b68471a" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a8187965ca589574f8ca657b41df52faf" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="lcg"><paramtype>const <classname>linear_congruential_engine</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine_1a8f45b74cfb994a8ca359f02175aa451b" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="lcg"><paramtype><classname>linear_congruential_engine</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__congruential__engine">linear_congruential_engine</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1rand48" name="rand48"><description><para>Class <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1rand48">rand48</link></computeroutput> models a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses the linear congruential algorithm with the parameters a = 0x5DEECE66D, c = 0xB, m = 2**48. It delivers identical results to the <computeroutput>lrand48()</computeroutput> function available on some systems (assuming lcong48 has not been called).</para><para>It is only available on systems where <computeroutput>uint64_t</computeroutput> is provided as an integral type, so that for example static in-class constants and/or enum definitions with large <computeroutput>uint64_t</computeroutput> numbers work. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1rand48_1af9d04118c135517b2a22dad22989b612" name="result_type"><type>boost::uint32_t</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1rand48_1aaee776c41e268503bdb1a173e2f56edd" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a9d993f16ee35c7ec1bac30172fbb7a65" name="min" specifiers="static"><type>uint32_t</type><description><para>Returns the smallest value that the generator can produce </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1aa73ccc74fddbce60ec84c7d1be4f167e" name="max" specifiers="static"><type>uint32_t</type><description><para>Returns the largest value that the generator can produce </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1rand48_1a77bc2858807fa56d021e1e120e37c70c"><description><para>Seeds the generator with the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1rand48_1a809101f639286bf4477cf8d5b922da62" specifiers="explicit"><parameter name="x0"><paramtype>result_type</paramtype></parameter><description><para>Constructs a <classname alt="boost::random::rand48">rand48</classname> generator with x(0) := (x0 << 16) | 0x330e. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1rand48_1a35cb51917e74deea856e1fea9913892d" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1rand48_1a519aa7adaec3c13ee7a82fbf305b89a0"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1ab8326c1b82bb7678321ff1d1086cb0f5" name="seed"><type>void</type><description><para>Seeds the generator with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a0d2254160d5e4f5cdbe21b65b6cecc8a" name="seed"><type>void</type><parameter name="x0"><paramtype>result_type</paramtype></parameter><description><para>Changes the current value x(n) of the generator to (x0 << 16) | 0x330e. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1ad145008e8045410b45237104379d2858" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1adaead8b7d5001de9b330d4fa9e413346" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1ae48c2737b1b6dfebc1ebaca206d4739e" name="operator()"><type>uint32_t</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a96d6eb23571f2715ff42f663832db8a4" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a0ef8390f308476ef2e9723a23b04e6e4" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a71ac944f2f32f913cd4aca445238be6f" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1rand48">rand48</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a37fac642eb6a57d55be2a8c6806f84dc" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="r"><paramtype><classname>rand48</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1rand48">rand48</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1a0e033e22f48e2fd092b4ca7c9bc1de58" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1rand48_1abde37cb79b96515216380a6a11de7e11" name="operator!="><type>bool</type><parameter name="x"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>rand48</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of values. </para></description></method> </method-group> </class><typedef id="doxygen.headers.linear__congruential_8hpp_1a6009d4fb4d0382ebf16a5ff5fb58596a" name="minstd_rand0"><description><para>The specialization <classname alt="boost::random::minstd_rand0">minstd_rand0</classname> was originally suggested in</para><para> <blockquote><para> A pseudo-random number generator for the System/360, P.A. Lewis, A.S. Goodman, J.M. Miller, IBM Systems Journal, Vol. 8, No. 2, 1969, pp. 136-146 </para></blockquote> </para><para>It is examined more closely together with <classname alt="boost::random::minstd_rand">minstd_rand</classname> in</para><para> <blockquote><para> "Random Number Generators: Good ones are hard to find", Stephen K. Park and Keith W. Miller, Communications of the ACM, Vol. 31, No. 10, October 1988, pp. 1192-1201 </para></blockquote> </para></description><type><classname>linear_congruential_engine</classname>< uint32_t, 16807, 0, 2147483647 ></type></typedef> <typedef id="doxygen.headers.linear__congruential_8hpp_1a695b4dc833a7eefcae8bd4eaf651af9a" name="minstd_rand"><description><para>The specialization <classname alt="boost::random::minstd_rand">minstd_rand</classname> was suggested in</para><para> <blockquote><para> "Random Number Generators: Good ones are hard to find", Stephen K. Park and Keith W. Miller, Communications of the ACM, Vol. 31, No. 10, October 1988, pp. 1192-1201 </para></blockquote> </para></description><type><classname>linear_congruential_engine</classname>< uint32_t, 48271, 0, 2147483647 ></type></typedef> <data-member id="doxygen.headers.linear__congruential_8hpp_1adad9cd670033290883863579614704da" name="linear_congruential_engine< IntType, a, c, m >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.linear__congruential_8hpp_1a4cdb0857d0f5bf67bc95b14e93b4b2aa" name="linear_congruential_engine< IntType, a, c, m >::multiplier"><type>const IntType</type></data-member> <data-member id="doxygen.headers.linear__congruential_8hpp_1a4908ee011df9e2c0b42bf267f5abeccc" name="linear_congruential_engine< IntType, a, c, m >::increment"><type>const IntType</type></data-member> <data-member id="doxygen.headers.linear__congruential_8hpp_1afa3dbbcc165b5ae65bfa291e108f7836" name="linear_congruential_engine< IntType, a, c, m >::modulus"><type>const IntType</type></data-member> <data-member id="doxygen.headers.linear__congruential_8hpp_1a7291c7744d9d9212814a87aa97249d85" name="linear_congruential_engine< IntType, a, c, m >::default_seed"><type>const IntType</type></data-member> </namespace> <typedef id="doxygen.headers.linear__congruential_8hpp_1a6009d4fb4d0382ebf16a5ff5fb58596a" name="minstd_rand0"><description><para>The specialization <classname alt="boost::random::minstd_rand0">minstd_rand0</classname> was originally suggested in</para><para> <blockquote><para> A pseudo-random number generator for the System/360, P.A. Lewis, A.S. Goodman, J.M. Miller, IBM Systems Journal, Vol. 8, No. 2, 1969, pp. 136-146 </para></blockquote> </para><para>It is examined more closely together with <classname alt="boost::random::minstd_rand">minstd_rand</classname> in</para><para> <blockquote><para> "Random Number Generators: Good ones are hard to find", Stephen K. Park and Keith W. Miller, Communications of the ACM, Vol. 31, No. 10, October 1988, pp. 1192-1201 </para></blockquote> </para></description><type>linear_congruential_engine< uint32_t, 16807, 0, 2147483647 ></type></typedef> <typedef id="doxygen.headers.linear__congruential_8hpp_1a695b4dc833a7eefcae8bd4eaf651af9a" name="minstd_rand"><description><para>The specialization <classname alt="boost::random::minstd_rand">minstd_rand</classname> was suggested in</para><para> <blockquote><para> "Random Number Generators: Good ones are hard to find", Stephen K. Park and Keith W. Miller, Communications of the ACM, Vol. 31, No. 10, October 1988, pp. 1192-1201 </para></blockquote> </para></description><type>linear_congruential_engine< uint32_t, 48271, 0, 2147483647 ></type></typedef> </namespace> </header> <header id="doxygen.headers.linear__feedback__shift_8hpp" name="boost/random/linear_feedback_shift.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine" name="linear_feedback_shift_engine"><template> <template-type-parameter name="UIntType"/> <template-nontype-parameter name="w"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="k"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="q"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="s"><type>int</type></template-nontype-parameter> </template><description><para>Instatiations of <computeroutput>linear_feedback_shift</computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It was originally proposed in</para><para> <blockquote><para> "Random numbers generated by linear recurrence modulo two.", Tausworthe, R. C.(1965), Mathematics of Computation 19, 201-209. </para></blockquote> </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1afad7b967524514c2b514cc0f5dceb151" name="result_type"><type>UIntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a6f968452f035549220535e47f69dc8e6" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a82041816875fbf226ef166d10d45836e" name="word_size" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a7ea661ebc5f1f5ff0d2dbb91078c6f7f" name="exponent1" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a25c7ec516979334d104299a8ff4e79bf" name="exponent2" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a68f636ddd9b89c4bcde6553503bb94a7" name="step_size" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a26a5f669dc0f755343944103810cab60" name="default_seed" specifiers="static"><type>const UIntType</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a429670160d92952a818ebaa0b6339207" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a6d6372d94b67db197a96bc418f0b8d4f" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a3d36430ca157f09b016cae9681762028"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput>, using the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a51f78ec18ec74d6f7303680ddc095d43" specifiers="explicit"><parameter name="s0"><paramtype>UIntType</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput>, seeding it with s0. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a8b38ec4b4ed1d7e5c769765fb3d78c03" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput>, seeding it with seq. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1aa23cf21a834bed24aeabaa20282b57cd"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput>, seeding it with values from the range [first, last). </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1af264f4d0915c2026ecc08e135aa34995" name="seed"><type>void</type><description><para>Seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput> with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a61d47e8c8e6ef54bb5974673e8f9bb6f" name="seed"><type>void</type><parameter name="s0"><paramtype>UIntType</paramtype></parameter><description><para>Seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput> with <computeroutput>s0</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1ad39c95a70e35c7202f74cdb3b3252575" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput> with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1ac1c93a52dfc2001b398ccfa04eaf9c2e" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine">linear_feedback_shift_engine</link></computeroutput> with values from the range [first, last). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1addb26302af646350cdf091b85947d8a4" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a4affb846d5387b6a34eee13a0b8208bf" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1ad6e28f43efad1341ee30c81e1bddfb70" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a59d0defcd3e6aa2e995344e7fa06b7d4" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="x"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1ac07335c02e54cbb984d0fbbd44ca6695" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="x"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1a7d20700fc16990732942cdccb6d9601a" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1linear__feedback__shift__engine_1aa04072b132ec9c46bb2c1ce5c7ac3cbe" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>linear_feedback_shift_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of outputs. </para></description></method> </method-group> </class><data-member id="doxygen.headers.linear__feedback__shift_8hpp_1a3efc960b33b1a92944fadd14d7b9c7ee" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.linear__feedback__shift_8hpp_1af7c351d3b6b081c2c08bda0f031cb849" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::word_size"><type>const int</type></data-member> <data-member id="doxygen.headers.linear__feedback__shift_8hpp_1abbaa76a18f50cae86528cf0aeba571ab" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::exponent1"><type>const int</type></data-member> <data-member id="doxygen.headers.linear__feedback__shift_8hpp_1ac7514af42b2c7b3771e8adf36fece16b" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::exponent2"><type>const int</type></data-member> <data-member id="doxygen.headers.linear__feedback__shift_8hpp_1a81e6e4b7558da648daef2016cff39d6b" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::step_size"><type>const int</type></data-member> <data-member id="doxygen.headers.linear__feedback__shift_8hpp_1af831d8b302cf472734446b65d2803194" name="linear_feedback_shift_engine< UIntType, w, k, q, s >::default_seed"><type>const UIntType</type></data-member> </namespace> </namespace> </header> <header id="doxygen.headers.lognormal__distribution_8hpp" name="boost/random/lognormal_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution" name="lognormal_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1lognormal__distribution">lognormal_distribution</link> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . Such a distribution produces random numbers with <inlineequation><alt>$\displaystyle p(x) = \frac{1}{x s \sqrt{2\pi}} e^{\frac{-\left(\log(x)-m\right)^2}{2s^2}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_29.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{1}{x s \sqrt{2\pi}} e^{\frac{-\left(\log(x)-m\right)^2}{2s^2}}$</phrase></textobject></inlinemediaobject></inlineequation> for x > 0.</para><para> <warning><para> This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::lognormal_distribution. A backwards compatible version is provided in namespace boost. </para></warning> </para></description><class id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1a0bd4a36eadd4a00939daa908d050feee" name="distribution_type"><type><classname>lognormal_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1aa2fbc0f30496d1cbc667bf84b2d6e01b" specifiers="explicit"><parameter name="m"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="s"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1random_1_1lognormal__distribution">lognormal_distribution</link>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1a97df404e832249bb034e1871367d4475" name="m" cv="const"><type>RealType</type><description><para>Returns the "m" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1a33d7531bf2336495dac84a8294fac73d" name="s" cv="const"><type>RealType</type><description><para>Returns the "s" parameter of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a std::ostream. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a std::istream. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a58b6a512521ba0883bedca098005c262" name="input_type"><type><classname>normal_distribution</classname>< RealType >::input_type</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a46e4d6f3cd1350bb024a866723db939a" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a00b68e7b13eb0a895d7cccff9713fbdf" specifiers="explicit"><parameter name="m"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="s"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1lognormal__distribution">lognormal_distribution</link>. <computeroutput>m</computeroutput> and <computeroutput>s</computeroutput> are the parameters of the distribution. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1ae890a2bd090e6153e5ef7b4063d50895" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1lognormal__distribution">lognormal_distribution</link> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a86fb0bd859d3d0084c29541ec458b96d" name="m" cv="const"><type>RealType</type><description><para>Returns the m parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1ab85ba78a06b81b02c51d16945a4e493c" name="s" cv="const"><type>RealType</type><description><para>Returns the s parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a3bf6323b2a8b7412939d17fc8e7231be" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1af8fe6240128969ed916b1c66d6ba0728" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a5b67dec26b76fa5b9d30f1bb82f23603" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1ab56d409fbfc13e014876d56e5f62569d" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1aa0a256259fac9292e594f864f9a777da" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a61af690f5b32b5a81b4bcff4f0daa5ec" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a random variate distributed according to the lognormal distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a29602312b55f7e82e9629d0d4214c446" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the lognormal distribution with parameters specified by param. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a9843fad49fbbcf9a3ad6292bbc747d22" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="ld"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a331123fac809f02a0b6d4fb535c87379" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="ld"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1acb971a2bb5333dc6f396add21d986242" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1lognormal__distribution_1a67397e71ff2e6b2552e75fe24f28de10" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>lognormal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.mersenne__twister_8hpp" name="boost/random/mersenne_twister.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine" name="mersenne_twister_engine"><template> <template-type-parameter name="UIntType"/> <template-nontype-parameter name="w"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="n"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="m"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="r"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="a"><type>UIntType</type></template-nontype-parameter> <template-nontype-parameter name="u"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="d"><type>UIntType</type></template-nontype-parameter> <template-nontype-parameter name="s"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="b"><type>UIntType</type></template-nontype-parameter> <template-nontype-parameter name="t"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="c"><type>UIntType</type></template-nontype-parameter> <template-nontype-parameter name="l"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="f"><type>UIntType</type></template-nontype-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses the algorithm described in</para><para> <blockquote><para> "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudo-random number generator", Makoto Matsumoto and Takuji Nishimura, ACM Transactions on Modeling and Computer Simulation: Special Issue on Uniform Random Number Generation, Vol. 8, No. 1, January 1998, pp. 3-30. </para></blockquote> </para><para> <note><para> The boost variant has been implemented from scratch and does not derive from or use mt19937.c provided on the above WWW site. However, it was verified that both produce identical output. </para></note> </para><para>The seeding from an integer was changed in April 2005 to address a <ulink url="http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html">weakness</ulink>.</para><para>The quality of the generator crucially depends on the choice of the parameters. User code should employ one of the sensibly parameterized generators such as <classname alt="boost::random::mt19937">mt19937</classname> instead.</para><para>The generator requires considerable amounts of memory for the storage of its state array. For example, <classname alt="boost::random::mt11213b">mt11213b</classname> requires about 1408 bytes and <classname alt="boost::random::mt19937">mt19937</classname> requires about 2496 bytes. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad9288f3e43b3a32a0fdc8702c17171c9" name="result_type"><type>UIntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a016e710569abf3f09ae52ecc164c45cf" name="word_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ac5ac4762eb9569e7a87cc2d777e8a008" name="state_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a0568c9db7c8ef8dfddce9f0cfa6c1341" name="shift_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a187c3b239ed3314f611987df2585b9f7" name="mask_bits" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1af57f6279c06546c4292819762398a11a" name="xor_mask" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1aa768c9865f4a1f20167bcd287680f426" name="tempering_u" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a7189a1cdf093d192ff45711318b01431" name="tempering_d" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a5ab282a3ceb344408e71b8b8f11aaf5d" name="tempering_s" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a0f5b3082f4de490fbb6c6fed04ea48ff" name="tempering_b" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a6b5aa02a5e9c7f4cadc23f805f268c72" name="tempering_t" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1acee56fd5519c94d8eaa78b5494f2449e" name="tempering_c" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a77c1e42d8759487c892aee909074f7ec" name="tempering_l" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a983cd1e0aa3bc49c8e3323b53a16264e" name="initialization_multiplier" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a570fffa7edc79617dc278f1f8ed997d8" name="default_seed" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a2ccfd77bee087bb9c4855573e21bd972" name="parameter_a" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a358546d35993f596dc65703821e1ada0" name="output_u" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a5eca7f94212b6776e12a4c61958bda65" name="output_s" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad7eb88374a5180d23feeed5f22ed75e2" name="output_b" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a3d2332c45af5f6355cc32feb977ed4b9" name="output_t" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ab2669d096d8a34be9ec01e03517516e0" name="output_c" specifiers="static"><type>const UIntType</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a58caaedbcb56c24200b83e8ca9807449" name="output_l" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ac2412c2122290d2670edb5eb0ca94c8d" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a7cdb248af95f439f51d4ff9000e00951"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link></computeroutput> and calls <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad23be64fabb51af2cd479674bcdc52ef">seed()</link></computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a59d009ba622a06a884f8918c778c802f" specifiers="explicit"><parameter name="value"><paramtype>UIntType</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link></computeroutput> and calls <computeroutput>seed(value)</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a1c245b2e6226d0cc39311609e6da3a57"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a717a830404920c484e7b40a57636d08a" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link> and calls <computeroutput>seed(gen)</computeroutput>.</para><para> <note><para> The copy constructor will always be preferred over the templated constructor. </para></note> </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad23be64fabb51af2cd479674bcdc52ef" name="seed"><type>void</type><description><para>Calls <computeroutput>seed(default_seed)</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a49fd0c15de055b5e47ce472f95bbd2de" name="seed"><type>void</type><parameter name="value"><paramtype>UIntType</paramtype></parameter><description><para>Sets the state x(0) to v mod 2w. Then, iteratively, sets x(i) to (i + f * (x(i-1) xor (x(i-1) rshift w-2))) mod 2<superscript>w</superscript> for i = 1 .. n-1. x(n) is the first value to be returned by operator(). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1abfe86170bf0006c1b699a6d870e2e80e" name="seed"><type>void</type><template> <template-type-parameter name="SeeqSeq"/> </template><parameter name="seq"><paramtype>SeeqSeq &</paramtype></parameter><description><para>Seeds a <link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link> using values produced by seq.generate(). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad182d02f99aa5a31750fb260ee676757" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Sets the state of the generator using values from an iterator range. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a4110a3caa93c4705cff8f31fd92941ae" name="operator()"><type>result_type</type><description><para>Produces the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a6cfdae85c30f8b298c9b38e506bed615" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a27f967901f14dc73f4db1b13ee8d888a" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput> steps. Equivalent to</para><para><programlisting language="c++">for(unsigned long long i = 0; i < z; ++i) { gen(); } </programlisting> </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a19eb2d3911f13dedb04715396aa9d2e1" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1abd14deba50bc988f6681ec94456dbeb0" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a937365cff39092ea7c192b563b9dff80" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="mt"><paramtype>const <classname>mersenne_twister_engine</classname> &</paramtype></parameter><description><para>Writes a <link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link> to a <computeroutput>std::ostream</computeroutput> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1afeccc06ed48e9db4cc4accccb26ac13b" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="mt"><paramtype><classname>mersenne_twister_engine</classname> &</paramtype></parameter><description><para>Reads a <link linkend="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine">mersenne_twister_engine</link> from a <computeroutput>std::istream</computeroutput> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1ad6eea3d74f66178fbd663b6c95a0b4a8" name="operator=="><type>bool</type><parameter name="x_"><paramtype>const <classname>mersenne_twister_engine</classname> &</paramtype></parameter><parameter name="y_"><paramtype>const <classname>mersenne_twister_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators are in the same state, and will thus produce identical sequences. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mersenne__twister__engine_1a01598bbbed4d5d0ea3f583599ee4ed4b" name="operator!="><type>bool</type><parameter name="x_"><paramtype>const <classname>mersenne_twister_engine</classname> &</paramtype></parameter><parameter name="y_"><paramtype>const <classname>mersenne_twister_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators are in different states. </para></description></method> </method-group> </class><typedef id="doxygen.headers.mersenne__twister_8hpp_1a29ac4e21d84adda27beb1803a0525ca5" name="mt11213b"><description><para>The specializations <classname alt="boost::random::mt11213b">mt11213b</classname> and <classname alt="boost::random::mt19937">mt19937</classname> are from</para><para> <blockquote><para> "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudo-random number generator", Makoto Matsumoto and Takuji Nishimura, ACM Transactions on Modeling and Computer Simulation: Special Issue on Uniform Random Number Generation, Vol. 8, No. 1, January 1998, pp. 3-30. </para></blockquote> </para></description><type><classname>mersenne_twister_engine</classname>< uint32_t, 32, 351, 175, 19, 0xccab8ee7, 11, 0xffffffff, 7, 0x31b6ab00, 15, 0xffe50000, 17, 1812433253 ></type></typedef> <typedef id="doxygen.headers.mersenne__twister_8hpp_1a313d63e0721b6a6bba3a1be507e9e6a2" name="mt19937"><description><para>The specializations <classname alt="boost::random::mt11213b">mt11213b</classname> and <classname alt="boost::random::mt19937">mt19937</classname> are from</para><para> <blockquote><para> "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudo-random number generator", Makoto Matsumoto and Takuji Nishimura, ACM Transactions on Modeling and Computer Simulation: Special Issue on Uniform Random Number Generation, Vol. 8, No. 1, January 1998, pp. 3-30. </para></blockquote> </para></description><type><classname>mersenne_twister_engine</classname>< uint32_t, 32, 624, 397, 31, 0x9908b0df, 11, 0xffffffff, 7, 0x9d2c5680, 15, 0xefc60000, 18, 1812433253 ></type></typedef> <typedef id="doxygen.headers.mersenne__twister_8hpp_1a8e5f4c469e0d6ddf305dcac72157cdd8" name="mt19937_64"><type><classname>mersenne_twister_engine</classname>< uint64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9ull,29, 0x5555555555555555ull,17, 0x71d67fffeda60000ull,37, 0xfff7eee000000000ull,43, 6364136223846793005ull ></type></typedef> </namespace> <typedef id="doxygen.headers.mersenne__twister_8hpp_1a29ac4e21d84adda27beb1803a0525ca5" name="mt11213b"><description><para>The specializations <classname alt="boost::random::mt11213b">mt11213b</classname> and <classname alt="boost::random::mt19937">mt19937</classname> are from</para><para> <blockquote><para> "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudo-random number generator", Makoto Matsumoto and Takuji Nishimura, ACM Transactions on Modeling and Computer Simulation: Special Issue on Uniform Random Number Generation, Vol. 8, No. 1, January 1998, pp. 3-30. </para></blockquote> </para></description><type>mersenne_twister_engine< uint32_t, 32, 351, 175, 19, 0xccab8ee7, 11, 0xffffffff, 7, 0x31b6ab00, 15, 0xffe50000, 17, 1812433253 ></type></typedef> <typedef id="doxygen.headers.mersenne__twister_8hpp_1a313d63e0721b6a6bba3a1be507e9e6a2" name="mt19937"><description><para>The specializations <classname alt="boost::random::mt11213b">mt11213b</classname> and <classname alt="boost::random::mt19937">mt19937</classname> are from</para><para> <blockquote><para> "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudo-random number generator", Makoto Matsumoto and Takuji Nishimura, ACM Transactions on Modeling and Computer Simulation: Special Issue on Uniform Random Number Generation, Vol. 8, No. 1, January 1998, pp. 3-30. </para></blockquote> </para></description><type>mersenne_twister_engine< uint32_t, 32, 624, 397, 31, 0x9908b0df, 11, 0xffffffff, 7, 0x9d2c5680, 15, 0xefc60000, 18, 1812433253 ></type></typedef> <typedef id="doxygen.headers.mersenne__twister_8hpp_1a8e5f4c469e0d6ddf305dcac72157cdd8" name="mt19937_64"><type>mersenne_twister_engine< uint64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9ull, 29, 0x5555555555555555ull, 17, 0x71d67fffeda60000ull, 37, 0xfff7eee000000000ull, 43, 6364136223846793005ull ></type></typedef> </namespace> <macro id="doxygen.headers.mersenne__twister_8hpp_1a63e3fde252955e5618d17c49451ece7e" name="BOOST_RANDOM_MERSENNE_TWISTER_DISCARD_THRESHOLD"/> </header> <header id="doxygen.headers.mixmax_8hpp" name="boost/random/mixmax.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1mixmax__engine" name="mixmax_engine"><template> <template-nontype-parameter name="Ndim"><type>int</type></template-nontype-parameter> <template-nontype-parameter name="SPECIALMUL"><type>unsigned int</type></template-nontype-parameter> <template-nontype-parameter name="SPECIAL"><type>std::int64_t</type></template-nontype-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1mixmax__engine">mixmax_engine</link> model, <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It uses the MIXMAX generator algorithms from:</para><para> <blockquote><para> G.K.Savvidy and N.G.Ter-Arutyunian, On the Monte Carlo simulation of physical systems, J.Comput.Phys. 97, 566 (1991); Preprint EPI-865-16-86, Yerevan, Jan. 1986 <ulink url="http://dx.doi.org/10.1016/0021-9991(91)90015-D">http://dx.doi.org/10.1016/0021-9991(91)90015-D</ulink></para> <para>K.Savvidy The MIXMAX random number generator Comp. Phys. Commun. 196 (2015), pp 161–165 <ulink url="http://dx.doi.org/10.1016/j.cpc.2015.06.003">http://dx.doi.org/10.1016/j.cpc.2015.06.003</ulink></para> <para>K.Savvidy and G.Savvidy Spectrum and Entropy of C-systems. MIXMAX random number generator Chaos, Solitons & Fractals, Volume 91, (2016) pp. 33–38 <ulink url="http://dx.doi.org/10.1016/j.chaos.2016.05.003">http://dx.doi.org/10.1016/j.chaos.2016.05.003</ulink> </para></blockquote> </para><para>The generator crucially depends on the choice of the parameters. The valid sets of parameters are from the published papers above. </para></description><struct id="doxygen.headers.structboost_1_1random_1_1mixmax__engine_1_1rng__state__st" name="rng_state_st"><data-member id="doxygen.headers.structboost_1_1random_1_1mixmax__engine_1_1rng__state__st_1a911bd781055da452e57ef8bebf2b47a8" name="V"><type>std::array< std::uint64_t, Ndim ></type></data-member> <data-member id="doxygen.headers.structboost_1_1random_1_1mixmax__engine_1_1rng__state__st_1a6420aae869e15ef99a8790cc2925ef69" name="sumtot"><type>std::uint64_t</type></data-member> <data-member id="doxygen.headers.structboost_1_1random_1_1mixmax__engine_1_1rng__state__st_1a9694dbf6adf6ca648f724670de746163" name="counter"><type>int</type></data-member> </struct><typedef id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a6e8be1d4375585abd08a3b978426fab8" name="result_type"><type>std::uint64_t</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1acd74e094c8f798f43b82440f13007e91" name="mixmax_min" specifiers="static"><type>const std::uint64_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a79400da286d33f50218f75902f1ecdae" name="mixmax_max" specifiers="static"><type>const std::uint64_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a00ca4caaf8ef3f071b704e7d90285b50" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a099a8031acc2af85bf609626d02c2209" name="N" specifiers="static"><type>const int</type><purpose>The main internal parameter, size of the defining MIXMAX matrix. </purpose></data-member> <method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a17117d3842d01e39ea49f0eca389ef4d" name="min"><type>BOOST_STATIC_CONSTEXPR result_type</type></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1af102702e2681b2f4b578b14aa94308b4" name="max"><type>BOOST_STATIC_CONSTEXPR result_type</type></method> <constructor id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a1c5cbb3649e80a1b608e58458d675165" specifiers="explicit"><purpose>Constructor, unit vector as initial state, acted on by A^2^512. </purpose></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a7b1fba7ad67743d52a9393f63a236784" specifiers="explicit"><parameter name=""><paramtype>std::uint64_t</paramtype></parameter><purpose>Constructor, one 64-bit seed. </purpose><description><para>< constructor, one uint64_t seed, random numbers are statistically independent from any two distinct seeds, e.g. consecutive seeds are ok</para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1ae5295fd3a0399fad5e91e9f90672513f" specifiers="explicit"><parameter name="clusterID"><paramtype>uint32_t</paramtype></parameter><parameter name="machineID"><paramtype>uint32_t</paramtype></parameter><parameter name="runID"><paramtype>uint32_t</paramtype></parameter><parameter name="streamID"><paramtype>uint32_t</paramtype></parameter><purpose>Constructor, four 32-bit seeds for 128-bit seeding flexibility. </purpose></constructor> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a93a9deb37cf7fdeb1c8bb03ac23a45e9" name="seed"><type>void</type><parameter name="seedval"><paramtype>std::uint64_t</paramtype><default>default_seed</default></parameter><purpose>seed with one 64-bit seed </purpose></method> <constructor id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a92aeeb588066438e9ceceee1b653b170"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a1affcd969c03b6a3e1792549bd719a2d" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter></constructor> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1aada84925f03bcd68703a30a67382a9e8" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Sets the state of the generator using values from an iterator range. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1aa34f9ac4f03dec28e9889dcaf8a8040b" name="seed"><type>void</type><template> <template-type-parameter name="SeeqSeq"/> </template><parameter name="seq"><paramtype>SeeqSeq &</paramtype></parameter><description><para>Sets the state of the generator using values from a <link linkend="doxygen.headers.classboost_1_1random_1_1seed__seq">seed_seq</link>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a44dd1848d9aa68f4077fcf85b0698e40" name="operator()"><type>std::uint64_t</type><description><para>return one uint64 between min=0 and max=2^61-1 </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a48cf6412a716754bcfab9d1d305fe0cc" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a577ec807d3c330eefe381d5c0cbc190d" name="discard"><type>void</type><parameter name="nsteps"><paramtype>std::uint64_t</paramtype></parameter><purpose>discard n steps, required in boost::random </purpose></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1ac0d03eb39f51438a6ecb6a1c9c637bf3" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="ost"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="me"><paramtype>const <classname>mixmax_engine</classname> &</paramtype></parameter><description><para>save the state of the RNG to a stream </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a0a6fe4d27b964cc9a5bca662ed1c98a1" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="in"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="me"><paramtype><classname>mixmax_engine</classname> &</paramtype></parameter><description><para>read the state of the RNG from a stream </para></description></method> </method-group> <method-group name="private member functions"> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a96e04555d4f357528a981e40bfba91de" name="MOD_MERSENNE"><type>std::uint64_t</type><parameter name="k"><paramtype>std::uint64_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1adb9e2194a50f239c905a4e960ab9349d" name="MULWU"><type>std::uint64_t</type><parameter name="k"><paramtype>std::uint64_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a0f1632a12a1a8286a10ef0399a18f00b" name="seed_vielbein"><type>void</type><parameter name="X"><paramtype>rng_state_t *</paramtype></parameter><parameter name="i"><paramtype>unsigned int</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1afd327da138ae010708e1eb30915440f0" name="seed_uniquestream"><type>void</type><parameter name="Xin"><paramtype>rng_state_t *</paramtype></parameter><parameter name="clusterID"><paramtype>uint32_t</paramtype></parameter><parameter name="machineID"><paramtype>uint32_t</paramtype></parameter><parameter name="runID"><paramtype>uint32_t</paramtype></parameter><parameter name="streamID"><paramtype>uint32_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a6ae45c463669b31b70b03669165d9c9a" name="iterate_raw_vec"><type>std::uint64_t</type><parameter name="Y"><paramtype>std::uint64_t *</paramtype></parameter><parameter name="sumtotOld"><paramtype>std::uint64_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a90be10825c4c60d03ab9a1ccff0e9d4b" name="apply_bigskip"><type>std::uint64_t</type><parameter name="Vout"><paramtype>std::uint64_t *</paramtype></parameter><parameter name="Vin"><paramtype>std::uint64_t *</paramtype></parameter><parameter name="clusterID"><paramtype>uint32_t</paramtype></parameter><parameter name="machineID"><paramtype>uint32_t</paramtype></parameter><parameter name="runID"><paramtype>uint32_t</paramtype></parameter><parameter name="streamID"><paramtype>uint32_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1ad2f5d73a4a07120d892ee45c2dadc6e7" name="modadd"><type>std::uint64_t</type><parameter name="foo"><paramtype>std::uint64_t</paramtype></parameter><parameter name="bar"><paramtype>std::uint64_t</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1mixmax__engine_1a0aa5442645b4094c4485c01d71c82a94" name="fmodmulM61"><type>std::uint64_t</type><parameter name="cum"><paramtype>std::uint64_t</paramtype></parameter><parameter name="s"><paramtype>std::uint64_t</paramtype></parameter><parameter name="a"><paramtype>std::uint64_t</paramtype></parameter></method> </method-group> </class><typedef id="doxygen.headers.mixmax_8hpp_1a36615ac97c022873de935ce4b1374318" name="mixmax"><description><para>Instantiation with a valid parameter set. </para></description><type><classname>mixmax_engine</classname>< 17, 36, 0 ></type></typedef> </namespace> </namespace> </header> <header id="doxygen.headers.negative__binomial__distribution_8hpp" name="boost/random/negative_binomial_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution" name="negative_binomial_distribution"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The negative binomial distribution is an integer valued distribution with two parameters, <computeroutput>k</computeroutput> and <computeroutput>p</computeroutput>. The distribution produces non-negative values.</para><para>The distribution function is <inlineequation><alt>$\displaystyle P(i) = {k+i-1\choose i}p^k(1-p)^i$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_30.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle P(i) = {k+i-1\choose i}p^k(1-p)^i$</phrase></textobject></inlinemediaobject></inlineequation>.</para><para>This implementation uses a gamma-poisson mixture. </para></description><class id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1ab055bfb9435cce6dc909fd861636f6d5" name="distribution_type"><type><classname>negative_binomial_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1ac872ad60b8cf1a230fde5df6763f45ae" specifiers="explicit"><parameter name="k"><paramtype>IntType</paramtype><default>1</default></parameter><parameter name="p"><paramtype>RealType</paramtype><default>0.5</default></parameter><description><para>Construct a <link linkend="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type">param_type</link> object. <computeroutput>k</computeroutput> and <computeroutput>p</computeroutput> are the parameters of the distribution.</para><para>Requires: k >=0 && 0 <= p <= 1 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1a9bc1c4255cda8feda5feb6a750b25124" name="k" cv="const"><type>IntType</type><description><para>Returns the <computeroutput>k</computeroutput> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1aa517bf4390079645945a7e3274724c34" name="p" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>p</computeroutput> parameter of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1a95ac9818d02462ff9019342dd2f057c8" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype><classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have the same values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have different values. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1aee16641b4f0c6e26726d61cc280875c2" name="result_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a7e6bb6fba7ab59407a29483d805b206e" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a1fc646d03f7550a37db97c1b0719514a" specifiers="explicit"><parameter name="k"><paramtype>IntType</paramtype><default>1</default></parameter><parameter name="p"><paramtype>RealType</paramtype><default>0.5</default></parameter><description><para>Construct a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution">negative_binomial_distribution</link></computeroutput> object. <computeroutput>k</computeroutput> and <computeroutput>p</computeroutput> are the parameters of the distribution.</para><para>Requires: k >=0 && 0 <= p <= 1 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a90a5f70ce07b494fcee201985d437204" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Construct an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution">negative_binomial_distribution</link></computeroutput> object from the parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a577c2c6319577f6c5fba4b111efd747a" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the negative binomial distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1aaf37556aa8c9d63f266d3931e73c5d5d" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the negative binomial distribution with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a41cd7deb2589481376ff8347c8520f2d" name="k" cv="const"><type>IntType</type><description><para>Returns the <computeroutput>k</computeroutput> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a3f810b187bf87d75eca66185816b720c" name="p" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>p</computeroutput> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1af8d471a7ab6bd547c1254b764007bc45" name="min" cv="const"><type>IntType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a156764075e79fa7e4bddd90231d1ba24" name="max" cv="const"><type>IntType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a461c9643f5b23be87859172131a1f8f6" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a2d391db500b107779aea0e8395d72fd2" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a19341617735cc67c531dcd4330ab844d" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1aa4743d9ef9a4fe1e552e63bf591461ee" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="bd"><paramtype>const <classname>negative_binomial_distribution</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1a5d8c4e33f2b4a555de4de373c7eb1c56" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="bd"><paramtype><classname>negative_binomial_distribution</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1aa9a7b93862964879c202d666c6bebe3d" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>negative_binomial_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>negative_binomial_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce the same sequence of values, given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1negative__binomial__distribution_1adefd5eb7bcea7b31a967fa4afbf0949f" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>negative_binomial_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>negative_binomial_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions could produce different sequences of values, given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.niederreiter__base2_8hpp" name="boost/random/niederreiter_base2.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine" name="niederreiter_base2_engine"><template> <template-type-parameter name="UIntType"/> <template-nontype-parameter name="w"><type>unsigned</type></template-nontype-parameter> <template-type-parameter name="Nb2Table"><default>default_niederreiter_base2_table</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine">niederreiter_base2_engine</link> model a <link linkend="boost_random.reference.concepts.quasi_random_number_generator">quasi-random number generator</link> . The <link linkend="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine">niederreiter_base2_engine</link> uses the algorithm described in <blockquote><para> Bratley, Fox, Niederreiter, ACM Trans. Model. Comp. Sim. 2, 195 (1992). </para></blockquote> </para><para><important><para><link linkend="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine">niederreiter_base2_engine</link> skips trivial zeroes at the start of the sequence. For example, the beginning of the 2-dimensional Niederreiter base 2 sequence in <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__01">uniform_01</link></computeroutput> distribution will look like this: <programlisting language="c++">0.5, 0.5, 0.75, 0.25, 0.25, 0.75, 0.375, 0.375, 0.875, 0.875, ... </programlisting></para> </important> In the following documentation <computeroutput>X</computeroutput> denotes the concrete class of the template <link linkend="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine">niederreiter_base2_engine</link> returning objects of type <computeroutput>UIntType</computeroutput>, u and v are the values of <computeroutput>X</computeroutput>.</para><para>Some member functions may throw exceptions of type std::range_error. This happens when the quasi-random domain is exhausted and the generator cannot produce any more values. The length of the low discrepancy sequence is given by <inlineequation><alt>$L=Dimension \times (2^{w} - 1)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_31.png"/></imageobject><textobject role="tex"><phrase>$L=Dimension \times (2^{w} - 1)$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a6f4eeb0cffa3f32a62b652a5857c6a48" name="result_type"><type>UIntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a6c79a07c933f759450fa7b958e4c1e3f" specifiers="explicit"><parameter name="s"><paramtype>std::size_t</paramtype></parameter><description><para>Effects: Constructs the default <computeroutput>s</computeroutput>-dimensional Niederreiter base 2 quasi-random number generator.</para><para>Throws: bad_alloc, invalid_argument, range_error. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a3310360edf228854c1ac6371f880f3aa" name="dimension" cv="const"><type>std::size_t</type><description><para>Returns: The dimension of of the quasi-random domain.</para><para>Throws: nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a6b479ef979b4181da12223380befbd0e" name="seed"><type>void</type><purpose>Throws: nothing. </purpose><description><para>Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a45d5cae7b0363da036cb0a8bcb5761cd" name="seed"><type>void</type><parameter name="init"><paramtype>UIntType</paramtype></parameter><purpose>Throws: range_error. </purpose><description><para>Effects: Effectively sets the quasi-random number generator state to the <computeroutput>init</computeroutput>-th vector in the <computeroutput>s</computeroutput>-dimensional quasi-random domain, where <computeroutput>s</computeroutput> == X::dimension(). <programlisting language="c++">X u, v; for(int i = 0; i < N; ++i) for( std::size_t j = 0; j < u.dimension(); ++j ) u(); v.seed(N); assert(u() == v()); </programlisting> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a8df8fbd99f62a0b63d5d2f3bd4f8ae5a" name="operator()"><type>result_type</type><description><para>Returns: Returns a successive element of an <computeroutput>s</computeroutput>-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent <computeroutput>s</computeroutput>-dimensional vector.</para><para>Throws: range_error. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1af708c083696ae18f74d0d4d8e0147887" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Effects: Advances *this state as if <computeroutput>z</computeroutput> consecutive X::operator() invocations were executed. <programlisting language="c++">X u = v; for(int i = 0; i < N; ++i) u(); v.discard(N); assert(u() == v()); </programlisting></para><para>Throws: range_error. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a1aec46fdbd9ecd199e286fdef7d7ef49" name="min" specifiers="static"><type>result_type</type><description><para>Returns: Tight lower bound on the set of values returned by operator().</para><para>Throws: nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a4fd99203f5284fdd1aee542a1b7e74ee" name="max" specifiers="static"><type>result_type</type><description><para>Returns: Tight upper bound on the set of values returned by operator().</para><para>Throws: nothing. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1a3066d39bb00fc3ca0002cc0557a613ea" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><purpose>Returns true if the two generators will produce identical sequences of outputs. </purpose></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1ac562571ff895da5ea487ce520c869124" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><purpose>Returns true if the two generators will produce different sequences of outputs. </purpose></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1ad4baa823c79a6c16a65b409488ec362e" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><purpose>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </purpose></method> <method id="doxygen.headers.classboost_1_1random_1_1niederreiter__base2__engine_1ad653b089f57c32378dfec2d677ffc7e4" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>niederreiter_base2_engine</classname> &</paramtype></parameter><purpose>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </purpose></method> </method-group> </class><typedef id="doxygen.headers.niederreiter__base2_8hpp_1a3772b4064e1b25e840878144df3951b2" name="niederreiter_base2"><description><para><important><para>This specialization of <classname alt="boost::random::niederreiter_base2_engine">niederreiter_base2_engine</classname> supports up to 4720 dimensions.</para> </important> Binary irreducible polynomials (primes in the ring <computeroutput>GF(2)[X]</computeroutput>, evaluated at <computeroutput>X=2</computeroutput>) were generated while condition <computeroutput>max(prime)</computeroutput> < 2<superscript>16</superscript> was satisfied.</para><para>There are exactly 4720 such primes, which yields a Niederreiter base 2 table for 4720 dimensions.</para><para>However, it is possible to provide your own table to <classname alt="boost::random::niederreiter_base2_engine">niederreiter_base2_engine</classname> should the default one be insufficient. </para></description><type><classname>niederreiter_base2_engine</classname>< boost::uint_least64_t, 64u, default_niederreiter_base2_table ></type></typedef> </namespace> </namespace> </header> <header id="doxygen.headers.non__central__chi__squared__distribution_8hpp" name="boost/random/non_central_chi_squared_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution" name="non_central_chi_squared_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The noncentral chi-squared distribution is a real valued distribution with two parameter, <computeroutput>k</computeroutput> and <computeroutput>lambda</computeroutput>. The distribution produces values > 0.</para><para>This is the distribution of the sum of squares of k Normal distributed variates each with variance one and <inlineequation><alt>$\lambda$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_32.png"/></imageobject><textobject role="tex"><phrase>$\lambda$</phrase></textobject></inlinemediaobject></inlineequation> the sum of squares of the normal means.</para><para>The distribution function is <inlineequation><alt>$\displaystyle P(x) = \frac{1}{2} e^{-(x+\lambda)/2} \left( \frac{x}{\lambda} \right)^{k/4-1/2} I_{k/2-1}( \sqrt{\lambda x} )$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_33.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle P(x) = \frac{1}{2} e^{-(x+\lambda)/2} \left( \frac{x}{\lambda} \right)^{k/4-1/2} I_{k/2-1}( \sqrt{\lambda x} )$</phrase></textobject></inlinemediaobject></inlineequation>. where <inlineequation><alt>$\displaystyle I_\nu(z)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_34.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle I_\nu(z)$</phrase></textobject></inlinemediaobject></inlineequation> is a modified Bessel function of the first kind.</para><para>The algorithm is taken from</para><para> <blockquote><para> "Monte Carlo Methods in Financial Engineering", Paul Glasserman, 2003, XIII, 596 p, Stochastic Modelling and Applied Probability, Vol. 53, ISBN 978-0-387-21617-1, p 124, Fig. 3.5. </para></blockquote> </para></description><class id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1ac03ada3794f47ebb9a7fec63701a1627" name="distribution_type"><type><classname>non_central_chi_squared_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1a2103260b26d8988cbf4a5560a567c539" specifiers="explicit"><parameter name="k"><paramtype>RealType</paramtype><default>1</default></parameter><parameter name="lambda"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution">non_central_chi_squared_distribution</link>. <computeroutput>k</computeroutput> and <computeroutput>lambda</computeroutput> are the parameter of the distribution.</para><para>Requires: k > 0 && lambda > 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1a5cc1055267d957c0b3e603b30e083cf9" name="k" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>k</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1a22281f4b7fdbce22f20376873a36832e" name="lambda" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>lambda</computeroutput> parameter of the distribution </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have the same values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have different values. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a477f6f451720b3a7f59549e276f8df04" name="result_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1aa9884c3879e20f3d5de10e453f9638c3" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a280ff8db3119c3ec7331f129351a2e8f" specifiers="explicit"><parameter name="k"><paramtype>RealType</paramtype><default>1</default></parameter><parameter name="lambda"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Construct a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution">non_central_chi_squared_distribution</link></computeroutput> object. <computeroutput>k</computeroutput> and <computeroutput>lambda</computeroutput> are the parameter of the distribution.</para><para>Requires: k > 0 && lambda > 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a9b212448512b7e2c9e38dcf5b54191fa" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Construct a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution">non_central_chi_squared_distribution</link></computeroutput> object from the parameter. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a373c94cd608f3828e95ccf9045b82ddb" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="eng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the non central chi squared distribution specified by <computeroutput>param</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a209a4d730a214aa769d287619348ae4b" name="operator()"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="eng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the non central chi squared distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a87a9420789d6d56c61734cc54fd89180" name="k" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>k</computeroutput> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a394027ac654aa59ac61a277efebf97df" name="lambda" cv="const"><type>RealType</type><description><para>Returns the <computeroutput>lambda</computeroutput> parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1ab5e5c33b56791305e33881226c7a117b" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a58e5affc1c6659e22414ae0e9e64e648" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a27aa8e5416b696476440aac2dc5997f3" name="reset"><type>void</type><description><para>Resets the distribution, so that subsequent uses does not depend on values already produced by it. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1addfdda7e45ed23f7999d5de4fb08cb9e" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a426339e6cd0a3e81ae0229f95936e18f" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a016706059c2f60eae7e7dcf1b09f9b54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="dist"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1a70ba5bd91f2880f20d5f7497486550cb" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="dist"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><description><para>reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1aa1e0c119e064f187c296af9d8d2be081" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><description><para>Returns true if two distributions have the same parameters and produce the same sequence of random numbers given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1non__central__chi__squared__distribution_1af3556cd746f9356c9d1b64b4969388b9" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>non_central_chi_squared_distribution</classname> &</paramtype></parameter><description><para>Returns true if two distributions have different parameters and/or can produce different sequences of random numbers given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.normal__distribution_8hpp" name="boost/random/normal_distribution.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1normal__distribution" name="normal_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . Such a distribution produces random numbers <computeroutput>x</computeroutput> distributed with probability density function <inlineequation><alt>$\displaystyle p(x) = \frac{1}{\sqrt{2\pi}\sigma} e^{-\frac{(x-\mu)^2}{2\sigma^2}} $</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_35.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{1}{\sqrt{2\pi}\sigma} e^{-\frac{(x-\mu)^2}{2\sigma^2}} $</phrase></textobject></inlinemediaobject></inlineequation>, where mean and sigma are the parameters of the distribution.</para><para>The implementation uses the "ziggurat" algorithm, as described in</para><para> <blockquote><para> "The Ziggurat Method for Generating Random Variables", George Marsaglia and Wai Wan Tsang, Journal of Statistical Software, Volume 5, Number 8 (2000), 1-7. </para></blockquote> </para></description><class id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1a0c94e7583f31a568e3a7fe48eca30a9e" name="distribution_type"><type><classname>normal_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1a386f6badcb802201a7f06c21a0dd039f" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="sigma"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> with a given mean and standard deviation.</para><para>Requires: sigma >= 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1a6175acc747cfe9afcc09be4709348681" name="mean" cv="const"><type>RealType</type><description><para>Returns the mean of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1a6b7d98b4d98e0e2416f7c045e278b562" name="sigma" cv="const"><type>RealType</type><description><para>Returns the standand deviation of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1normal__distribution_1a873708c7963e3d02d6fdcbdb1ffed28d" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1normal__distribution_1a226a4a5fe9e99d5bf3374fc68a0c0227" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1normal__distribution_1ae8dde95d8c3c661a9511d914f7258599" specifiers="explicit"><parameter name="mean"><paramtype>const RealType &</paramtype><default>0.0</default></parameter><parameter name="sigma"><paramtype>const RealType &</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> object. <computeroutput>mean</computeroutput> and <computeroutput>sigma</computeroutput> are the parameters for the distribution.</para><para>Requires: sigma >= 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1normal__distribution_1a051c89cd7d6c1000d7b96d81e65c3671" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> object from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1normal__distribution_1aee3f0262971ed65bbce68443568fce10" name="mean" cv="const"><type>RealType</type><description><para>Returns the mean of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a4a57c163b51490dd4c005c61dfda57a2" name="sigma" cv="const"><type>RealType</type><description><para>Returns the standard deviation of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a08b6fba3199ef6c6bf86b01faa46894b" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1aec5d66645418b7e07c91a53deb0ed3d1" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a6076a29538e0c6e29e29c367193f9fa3" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a3f307a2159176350a02e16036425a60c" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a38c5de288a53aace757338ea67d32309" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1ae0f1c88c204b7f016a7806bd27b1ab45" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a normal variate. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a2674d5b983bacfb46b53338299ad2c35" name="operator()"><type>result_type</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a normal variate with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1normal__distribution_1a7ae8fa24c51bbd91a58864ca8f00d944" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="nd"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a57e5574d0c5801d772e223aa6e8b6edf" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="nd"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a988896e9670b38e564703331f18fa170" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1normal__distribution_1a364d9639aa2fbba730cb19a3d419bda4" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1normal__distribution">normal_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1normal__distribution" name="normal_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . Such a distribution produces random numbers <computeroutput>x</computeroutput> distributed with probability density function <inlineequation><alt>$\displaystyle p(x) = \frac{1}{\sqrt{2\pi}\sigma} e^{-\frac{(x-\mu)^2}{2\sigma^2}} $</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_35.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{1}{\sqrt{2\pi}\sigma} e^{-\frac{(x-\mu)^2}{2\sigma^2}} $</phrase></textobject></inlinemediaobject></inlineequation>, where mean and sigma are the parameters of the distribution.</para><para>The implementation uses the "ziggurat" algorithm, as described in</para><para> <blockquote><para> "The Ziggurat Method for Generating Random Variables", George Marsaglia and Wai Wan Tsang, Journal of Statistical Software, Volume 5, Number 8 (2000), 1-7. </para></blockquote> </para></description><class id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1a0c94e7583f31a568e3a7fe48eca30a9e" name="distribution_type"><type><classname>normal_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1a386f6badcb802201a7f06c21a0dd039f" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="sigma"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> with a given mean and standard deviation.</para><para>Requires: sigma >= 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1a6175acc747cfe9afcc09be4709348681" name="mean" cv="const"><type>RealType</type><description><para>Returns the mean of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1a6b7d98b4d98e0e2416f7c045e278b562" name="sigma" cv="const"><type>RealType</type><description><para>Returns the standand deviation of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a873708c7963e3d02d6fdcbdb1ffed28d" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a226a4a5fe9e99d5bf3374fc68a0c0227" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1ae8dde95d8c3c661a9511d914f7258599" specifiers="explicit"><parameter name="mean"><paramtype>const RealType &</paramtype><default>0.0</default></parameter><parameter name="sigma"><paramtype>const RealType &</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> object. <computeroutput>mean</computeroutput> and <computeroutput>sigma</computeroutput> are the parameters for the distribution.</para><para>Requires: sigma >= 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a051c89cd7d6c1000d7b96d81e65c3671" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> object from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1aee3f0262971ed65bbce68443568fce10" name="mean" cv="const"><type>RealType</type><description><para>Returns the mean of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a4a57c163b51490dd4c005c61dfda57a2" name="sigma" cv="const"><type>RealType</type><description><para>Returns the standard deviation of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a08b6fba3199ef6c6bf86b01faa46894b" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1aec5d66645418b7e07c91a53deb0ed3d1" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a6076a29538e0c6e29e29c367193f9fa3" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a3f307a2159176350a02e16036425a60c" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a38c5de288a53aace757338ea67d32309" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1ae0f1c88c204b7f016a7806bd27b1ab45" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a normal variate. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a2674d5b983bacfb46b53338299ad2c35" name="operator()"><type>result_type</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a normal variate with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a7ae8fa24c51bbd91a58864ca8f00d944" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="nd"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a57e5574d0c5801d772e223aa6e8b6edf" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="nd"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a988896e9670b38e564703331f18fa170" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1normal__distribution_1a364d9639aa2fbba730cb19a3d419bda4" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>normal_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1normal__distribution">normal_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.piecewise__constant__distribution_8hpp" name="boost/random/piecewise_constant_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution" name="piecewise_constant_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> <template-type-parameter name="WeightType"><default>double</default></template-type-parameter> </template><description><para>The class <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link></computeroutput> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . </para></description><class id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1a2a38bd1d193da88337c27a3270b788b7" name="distribution_type"><type><classname>piecewise_constant_distribution</classname></type></typedef> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1a7f85fafd7eb31e9fe8d1fbd81c4461df"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type">param_type</link></computeroutput> object, representing a distribution that produces values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1aff82023c551dd23a00593f024ed83fd3"><template> <template-type-parameter name="IntervalIter"/> <template-type-parameter name="WeightIter"/> </template><parameter name="intervals_first"><paramtype>IntervalIter</paramtype></parameter><parameter name="intervals_last"><paramtype>IntervalIter</paramtype></parameter><parameter name="weight_first"><paramtype>WeightIter</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type">param_type</link></computeroutput> object from two iterator ranges containing the interval boundaries and the interval weights. If there are less than two boundaries, then this is equivalent to the default constructor and creates a single interval, [0, 1).</para><para>The values of the interval boundaries must be strictly increasing, and the number of weights must be one less than the number of interval boundaries. If there are extra weights, they are ignored. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1acbe3ff34f267e57b9cdce8abddf12fd3"><template> <template-type-parameter name="T"/> <template-type-parameter name="F"/> </template><parameter name="il"><paramtype>const std::initializer_list< T > &</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type">param_type</link></computeroutput> object from an initializer_list containing the interval boundaries and a unary function specifying the weights. Each weight is determined by calling the function at the midpoint of the corresponding interval.</para><para>If the initializer_list contains less than two elements, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1a41e91efa9a22a61f97f186340aa3d626"><template> <template-type-parameter name="IntervalRange"/> <template-type-parameter name="WeightRange"/> </template><parameter name="intervals_arg"><paramtype>const IntervalRange &</paramtype></parameter><parameter name="weights_arg"><paramtype>const WeightRange &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type">param_type</link></computeroutput> object from Boost.Range ranges holding the interval boundaries and the weights. If there are less than two interval boundaries, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). The number of weights must be one less than the number of interval boundaries. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1adefe4ad99ec78042dfe301a7e9fe821e"><template> <template-type-parameter name="F"/> </template><parameter name="nw"><paramtype>std::size_t</paramtype></parameter><parameter name="xmin"><paramtype>RealType</paramtype></parameter><parameter name="xmax"><paramtype>RealType</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs the parameters for a distribution that approximates a function. The range of the distribution is [xmin, xmax). This range is divided into nw equally sized intervals and the weights are found by calling the unary function f on the midpoints of the intervals. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1ad3f17f5c5ffb0725c494a453e840b5c3" name="intervals" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the interval boundaries. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1_1param__type_1a17d55affa383872ad7ad0f32245d8f27" name="densities" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the probability densities over all the intervals of the distribution. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1ad203a2270a7157cd352696a5a1fd3695" name="input_type"><type>std::size_t</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a79463a8d4e6b5a4953ca66b974dbffe4" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a76797fda1e5f8ae0f6f833e542a42f71"><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link></computeroutput> with a single interval, [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1acce63ef0ad9d3e70e7e36148990341f5"><template> <template-type-parameter name="IntervalIter"/> <template-type-parameter name="WeightIter"/> </template><parameter name="first_interval"><paramtype>IntervalIter</paramtype></parameter><parameter name="last_interval"><paramtype>IntervalIter</paramtype></parameter><parameter name="first_weight"><paramtype>WeightIter</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link> from two iterator ranges containing the interval boundaries and the interval weights. If there are less than two boundaries, then this is equivalent to the default constructor and creates a single interval, [0, 1).</para><para>The values of the interval boundaries must be strictly increasing, and the number of weights must be one less than the number of interval boundaries. If there are extra weights, they are ignored.</para><para>For example,</para><para><programlisting language="c++">double <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1aedb2f7d9b85b28881b0b2113bd61de6b">intervals</link>[] = { 0.0, 1.0, 4.0 }; double weights[] = { 1.0, 1.0 }; <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a76797fda1e5f8ae0f6f833e542a42f71">piecewise_constant_distribution<></link> dist( &<link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1aedb2f7d9b85b28881b0b2113bd61de6b">intervals</link>[0], &<link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1aedb2f7d9b85b28881b0b2113bd61de6b">intervals</link>[0] + 3, &weights[0]); </programlisting></para><para>The distribution has a 50% chance of producing a value between 0 and 1 and a 50% chance of producing a value between 1 and 4. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1abd80a326c224151118e703771a1c4ade"><template> <template-type-parameter name="T"/> <template-type-parameter name="F"/> </template><parameter name="il"><paramtype>std::initializer_list< T ></paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link> from an initializer_list containing the interval boundaries and a unary function specifying the weights. Each weight is determined by calling the function at the midpoint of the corresponding interval.</para><para>If the initializer_list contains less than two elements, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a396e85c8b1a4887ff778c9818ec8a142"><template> <template-type-parameter name="IntervalsRange"/> <template-type-parameter name="WeightsRange"/> </template><parameter name="intervals_arg"><paramtype>const IntervalsRange &</paramtype></parameter><parameter name="weights_arg"><paramtype>const WeightsRange &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link> from Boost.Range ranges holding the interval boundaries and the weights. If there are less than two interval boundaries, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). The number of weights must be one less than the number of interval boundaries. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a2826da578a5c21fcda4fc1be1303ed93"><template> <template-type-parameter name="F"/> </template><parameter name="nw"><paramtype>std::size_t</paramtype></parameter><parameter name="xmin"><paramtype>RealType</paramtype></parameter><parameter name="xmax"><paramtype>RealType</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link> that approximates a function. The range of the distribution is [xmin, xmax). This range is divided into nw equally sized intervals and the weights are found by calling the unary function f on the midpoints of the intervals. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1aab344568fae8eef4ffe93a9892fa8b74" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution">piecewise_constant_distribution</link> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a7866a8906328f58ad9d91db670574992" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a value distributed according to the parameters of the piecewist_constant_distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a319c979ad3d33667693e16aa4577533d" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a value distributed according to the parameters specified by param. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1afb8bb114a4a3954e91fc5f5508836ee1" name="min" cv="const"><type>result_type</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a1b4d07ae4cf3bde85c32676115f6e9d3" name="max" cv="const"><type>result_type</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a1b462b2f1dbfc7b17b4689ecdfc87297" name="densities" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the probability density over each interval. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1aedb2f7d9b85b28881b0b2113bd61de6b" name="intervals" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the interval boundaries. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1abb6676dc506091682ebd9e9e7ea95322" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a72b9cab43180898bee4df0423a5a7d0f" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a5a327e5c63a2a6b47ce02b59a6b4ff49" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a3789e8b3c98404bbf0c2d3dc1feb4824" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="pcd"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><description><para>Writes a distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a4da5522051781602c861a47f38703072" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="pcd"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><description><para>Reads a distribution from a <computeroutput>std::istream</computeroutput> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a7f18e4078bb511b715fcadfcbbb1e2bd" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will return the same sequence of values, when passed equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__constant__distribution_1a0f1c705c06016aeb3211c717d2a21dea" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>piecewise_constant_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may return different sequences of values, when passed equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.piecewise__linear__distribution_8hpp" name="boost/random/piecewise_linear_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution" name="piecewise_linear_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The class <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link></computeroutput> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . </para></description><class id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a7a9a14f5313cead94f1eb24d3862dc08" name="distribution_type"><type><classname>piecewise_linear_distribution</classname></type></typedef> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a385b662953363197cb367a76ff4319f0"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type">param_type</link></computeroutput> object, representing a distribution that produces values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a6fa4489df03f4455331512a4175eae27"><template> <template-type-parameter name="IntervalIter"/> <template-type-parameter name="WeightIter"/> </template><parameter name="intervals_first"><paramtype>IntervalIter</paramtype></parameter><parameter name="intervals_last"><paramtype>IntervalIter</paramtype></parameter><parameter name="weight_first"><paramtype>WeightIter</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type">param_type</link></computeroutput> object from two iterator ranges containing the interval boundaries and weights at the boundaries. If there are fewer than two boundaries, then this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1).</para><para>The values of the interval boundaries must be strictly increasing, and the number of weights must be the same as the number of interval boundaries. If there are extra weights, they are ignored. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1ac217620c8402c723584fbba512352590"><template> <template-type-parameter name="T"/> <template-type-parameter name="F"/> </template><parameter name="il"><paramtype>const std::initializer_list< T > &</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type">param_type</link></computeroutput> object from an initializer_list containing the interval boundaries and a unary function specifying the weights at the boundaries. Each weight is determined by calling the function at the corresponding point.</para><para>If the initializer_list contains fewer than two elements, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a19a927f92b56eb9c2ff424dc5cef0cf1"><template> <template-type-parameter name="IntervalRange"/> <template-type-parameter name="WeightRange"/> </template><parameter name="intervals_arg"><paramtype>const IntervalRange &</paramtype></parameter><parameter name="weights_arg"><paramtype>const WeightRange &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type">param_type</link></computeroutput> object from Boost.Range ranges holding the interval boundaries and the weights at the boundaries. If there are fewer than two interval boundaries, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). The number of weights must be equal to the number of interval boundaries. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a8613459ad33682256ff73777c477810d"><template> <template-type-parameter name="F"/> </template><parameter name="nw"><paramtype>std::size_t</paramtype></parameter><parameter name="xmin"><paramtype>RealType</paramtype></parameter><parameter name="xmax"><paramtype>RealType</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs the parameters for a distribution that approximates a function. The range of the distribution is [xmin, xmax). This range is divided into nw equally sized intervals and the weights are found by calling the unary function f on the boundaries of the intervals. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a142ade0a481868d2cf96a30cdec02992" name="intervals" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the interval boundaries. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1_1param__type_1a9ba88d98a740c5070c6aa9bb92a7ba28" name="densities" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the probability densities at all the interval boundaries. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1aa7aa14a595ec8276d3477bd1e33a4d12" name="input_type"><type>std::size_t</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a2aee611cd1a88d030894c790a2944ec0" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a5f3854fd20b766ed9e6f2b9e693d0278"><description><para>Creates a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link></computeroutput> that produces values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1af722449823ad30ec26991580847a97c2"><template> <template-type-parameter name="IntervalIter"/> <template-type-parameter name="WeightIter"/> </template><parameter name="first_interval"><paramtype>IntervalIter</paramtype></parameter><parameter name="last_interval"><paramtype>IntervalIter</paramtype></parameter><parameter name="first_weight"><paramtype>WeightIter</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link> from two iterator ranges containing the interval boundaries and the weights at the boundaries. If there are fewer than two boundaries, then this is equivalent to the default constructor and creates a distribution that produces values uniformly distributed in the range [0, 1).</para><para>The values of the interval boundaries must be strictly increasing, and the number of weights must be equal to the number of interval boundaries. If there are extra weights, they are ignored.</para><para>For example,</para><para><programlisting language="c++">double <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a0bf9d9204ea884e3c74a96bd5a2a3a00">intervals</link>[] = { 0.0, 1.0, 2.0 }; double weights[] = { 0.0, 1.0, 0.0 }; piecewise_constant_distribution<> dist( &<link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a0bf9d9204ea884e3c74a96bd5a2a3a00">intervals</link>[0], &<link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a0bf9d9204ea884e3c74a96bd5a2a3a00">intervals</link>[0] + 3, &weights[0]); </programlisting></para><para>produces a triangle distribution. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1af89a2f89fde0b4160c2a77cc19fea2bb"><template> <template-type-parameter name="T"/> <template-type-parameter name="F"/> </template><parameter name="il"><paramtype>std::initializer_list< T ></paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link> from an initializer_list containing the interval boundaries and a unary function specifying the weights. Each weight is determined by calling the function at the corresponding interval boundary.</para><para>If the initializer_list contains fewer than two elements, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a8726942c9aabebf667d712daf2f7ae45"><template> <template-type-parameter name="IntervalsRange"/> <template-type-parameter name="WeightsRange"/> </template><parameter name="intervals_arg"><paramtype>const IntervalsRange &</paramtype></parameter><parameter name="weights_arg"><paramtype>const WeightsRange &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link> from Boost.Range ranges holding the interval boundaries and the weights. If there are fewer than two interval boundaries, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). The number of weights must be equal to the number of interval boundaries. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a8799381f4f79c65d2952623807436c0a"><template> <template-type-parameter name="F"/> </template><parameter name="nw"><paramtype>std::size_t</paramtype></parameter><parameter name="xmin"><paramtype>RealType</paramtype></parameter><parameter name="xmax"><paramtype>RealType</paramtype></parameter><parameter name="f"><paramtype>F</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link> that approximates a function. The range of the distribution is [xmin, xmax). This range is divided into nw equally sized intervals and the weights are found by calling the unary function f on the interval boundaries. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1ab5a30c6052bc6db8275693428665209f" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1aa0c2ae1326a45141afc53a179e2fe98d" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a value distributed according to the parameters of the <link linkend="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution">piecewise_linear_distribution</link>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a1c66980cd4a0aeb88444a0f585be49a6" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a value distributed according to the parameters specified by param. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a3f5e9823b680bbb47892f9bfd3224060" name="min" cv="const"><type>result_type</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a44307d69515101818cad7c71cac74b25" name="max" cv="const"><type>result_type</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a421dd15f5f6a8f92b0d0df03bc2f0477" name="densities" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the probability densities at the interval boundaries. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a0bf9d9204ea884e3c74a96bd5a2a3a00" name="intervals" cv="const"><type>std::vector< RealType ></type><description><para>Returns a vector containing the interval boundaries. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a924c2519f7a10c6530cd8efd1c14007f" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a2a82a1976136debf19a3963fdeabdbec" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a6926c2edcfce4d218b15f6b94eee5b94" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a9b806e7def3f687685b6d4175ce1f43d" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="pld"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><description><para>Writes a distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a81edc57443b46d3eb6631acd9de76c75" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="pld"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><description><para>Reads a distribution from a <computeroutput>std::istream</computeroutput> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1aeb493d840ff6b17a9e6ef65abf29b127" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will return the same sequence of values, when passed equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1piecewise__linear__distribution_1a2e64d2b14939c4c20ad900bf42d1080c" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>piecewise_linear_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may return different sequences of values, when passed equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.poisson__distribution_8hpp" name="boost/random/poisson_distribution.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1poisson__distribution" name="poisson_distribution"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>An instantiation of the class template <computeroutput><link linkend="doxygen.headers.classboost_1_1poisson__distribution">poisson_distribution</link></computeroutput> is a model of <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . The poisson distribution has <inlineequation><alt>$p(i) = \frac{e^{-\lambda}\lambda^i}{i!}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_36.png"/></imageobject><textobject role="tex"><phrase>$p(i) = \frac{e^{-\lambda}\lambda^i}{i!}$</phrase></textobject></inlinemediaobject></inlineequation></para><para>This implementation is based on the PTRD algorithm described</para><para> <blockquote><para> "The transformed rejection method for generating Poisson random variables", Wolfgang Hormann, Insurance: Mathematics and Economics Volume 12, Issue 1, February 1993, Pages 39-45 </para></blockquote> </para></description><class id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1a59fbdfc757c9c0035193e51f6c0624a1" name="distribution_type"><type><classname>poisson_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1a328be17fdcc2d77492ea81e131025637" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Construct a <link linkend="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type">param_type</link> object with the parameter "mean"</para><para>Requires: mean > 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1a05b7404c92986f3b4aa475f7e57d6002" name="mean" cv="const"><type>RealType</type></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1a95ac9818d02462ff9019342dd2f057c8" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype><classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have the same values. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have different values. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1poisson__distribution_1ae1c3c26f3cc95c8366b1f452c2eeb9d7" name="result_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1poisson__distribution_1a1b5ecb5c4c20c9d80f1d826a6f151cb8" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1poisson__distribution_1a487d1926795947e6f282ad6daf5b8dd6" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1poisson__distribution">poisson_distribution</link></computeroutput> with the parameter <computeroutput>mean</computeroutput>.</para><para>Requires: mean > 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1poisson__distribution_1a1cec8a2376e238839c0079cb2a83a187" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Construct an <computeroutput><link linkend="doxygen.headers.classboost_1_1poisson__distribution">poisson_distribution</link></computeroutput> object from the parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1poisson__distribution_1af66f4991bb65202e88e49a817cad2c85" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the poisson distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a144c10747a7d86317cab89a267cec05d" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the poisson distribution with parameters specified by param. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1ac2b1450600ad7cca8452050b6e499c94" name="mean" cv="const"><type>RealType</type><description><para>Returns the "mean" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a7d87b125c34289e99bca12e676139141" name="min" cv="const"><type>IntType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1ae80d605abdc5d6ca13cc07e99f0c394e" name="max" cv="const"><type>IntType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a69ca3c31283a777b48d654f7852dcbc7" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1ad6b293091d197069bffcef0def9934a5" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a8598e7d442dc88997d60cb808ca5aa11" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a7ff9ca74a3bdc8253d210b04669f79f4" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="pd"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1adc098c22a36620f08cb5e1af9cb1cf4e" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="pd"><paramtype><classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a39213acd8b23b961c97addf3eb9c5bc6" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce the same sequence of values, given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1poisson__distribution_1a5c512acc1b0c2eb9e813d0409e7c78c6" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions could produce different sequences of values, given equal generators. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1poisson__distribution" name="poisson_distribution"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>An instantiation of the class template <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1poisson__distribution">poisson_distribution</link></computeroutput> is a model of <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . The poisson distribution has <inlineequation><alt>$p(i) = \frac{e^{-\lambda}\lambda^i}{i!}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_36.png"/></imageobject><textobject role="tex"><phrase>$p(i) = \frac{e^{-\lambda}\lambda^i}{i!}$</phrase></textobject></inlinemediaobject></inlineequation></para><para>This implementation is based on the PTRD algorithm described</para><para> <blockquote><para> "The transformed rejection method for generating Poisson random variables", Wolfgang Hormann, Insurance: Mathematics and Economics Volume 12, Issue 1, February 1993, Pages 39-45 </para></blockquote> </para></description><class id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1a59fbdfc757c9c0035193e51f6c0624a1" name="distribution_type"><type><classname>poisson_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1a328be17fdcc2d77492ea81e131025637" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Construct a <link linkend="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type">param_type</link> object with the parameter "mean"</para><para>Requires: mean > 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1a05b7404c92986f3b4aa475f7e57d6002" name="mean" cv="const"><type>RealType</type></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1a95ac9818d02462ff9019342dd2f057c8" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype><classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have the same values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the parameters have different values. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1ae1c3c26f3cc95c8366b1f452c2eeb9d7" name="result_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a1b5ecb5c4c20c9d80f1d826a6f151cb8" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a487d1926795947e6f282ad6daf5b8dd6" specifiers="explicit"><parameter name="mean"><paramtype>RealType</paramtype><default>1</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1poisson__distribution">poisson_distribution</link></computeroutput> with the parameter <computeroutput>mean</computeroutput>.</para><para>Requires: mean > 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a1cec8a2376e238839c0079cb2a83a187" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Construct an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1poisson__distribution">poisson_distribution</link></computeroutput> object from the parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1af66f4991bb65202e88e49a817cad2c85" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the poisson distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a144c10747a7d86317cab89a267cec05d" name="operator()" cv="const"><type>IntType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the poisson distribution with parameters specified by param. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1ac2b1450600ad7cca8452050b6e499c94" name="mean" cv="const"><type>RealType</type><description><para>Returns the "mean" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a7d87b125c34289e99bca12e676139141" name="min" cv="const"><type>IntType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1ae80d605abdc5d6ca13cc07e99f0c394e" name="max" cv="const"><type>IntType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a69ca3c31283a777b48d654f7852dcbc7" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1ad6b293091d197069bffcef0def9934a5" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a8598e7d442dc88997d60cb808ca5aa11" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a7ff9ca74a3bdc8253d210b04669f79f4" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="pd"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Writes the parameters of the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1adc098c22a36620f08cb5e1af9cb1cf4e" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="pd"><paramtype><classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Reads the parameters of the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a39213acd8b23b961c97addf3eb9c5bc6" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce the same sequence of values, given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1poisson__distribution_1a5c512acc1b0c2eb9e813d0409e7c78c6" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>poisson_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions could produce different sequences of values, given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.random__device_8hpp" name="boost/random/random_device.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1random__device" name="random_device"><inherit access="private">noncopyable</inherit><description><para>Class <classname alt="boost::random::random_device">random_device</classname> models a <link linkend="boost_random.reference.concepts.non_deterministic_uniform_random_number_generator">non-deterministic random number generator</link> . It uses one or more implementation-defined stochastic processes to generate a sequence of uniformly distributed non-deterministic random numbers. For those environments where a non-deterministic random number generator is not available, class <link linkend="doxygen.headers.classboost_1_1random__device">random_device</link> must not be implemented. See</para><para> <blockquote><para> "Randomness Recommendations for Security", D. Eastlake, S. Crocker, J. Schiller, Network Working Group, RFC 1750, December 1994 </para></blockquote> </para><para>for further discussions.</para><para> <note><para> Some operating systems abstract the computer hardware enough to make it difficult to non-intrusively monitor stochastic processes. However, several do provide a special device for exactly this purpose. It seems to be impossible to emulate the functionality using Standard C++ only, so users should be aware that this class may not be available on all platforms. </para></note> </para><para><emphasis role="bold">Implementation Note for Linux</emphasis></para><para>On the Linux operating system, token is interpreted as a filesystem path. It is assumed that this path denotes an operating system pseudo-device which generates a stream of non-deterministic random numbers. The pseudo-device should never signal an error or end-of-file. Otherwise, <computeroutput>std::ios_base::failure</computeroutput> is thrown. By default, <classname alt="boost::random::random_device">random_device</classname> uses the /dev/urandom pseudo-device to retrieve the random numbers. Another option would be to specify the /dev/random pseudo-device, which blocks on reads if the entropy pool has no more random bits available.</para><para><emphasis role="bold">Implementation Note for Windows</emphasis></para><para>On the Windows operating system, token is interpreted as the name of a cryptographic service provider. By default <classname alt="boost::random::random_device">random_device</classname> uses MS_DEF_PROV.</para><para><emphasis role="bold">Performance</emphasis></para><para>The test program <ulink url="../../libs/random/performance/nondet_random_speed.cpp">nondet_random_speed.cpp</ulink> measures the execution times of the <link linkend="doxygen.headers.random__device_8hpp_source">random_device.hpp</link> implementation of the above algorithms in a tight loop. The performance has been evaluated on an Intel(R) Core(TM) i7 CPU Q 840 @ 1.87GHz, 1867 Mhz with Visual C++ 2010, Microsoft Windows 7 Professional and with gcc 4.4.5, Ubuntu Linux 2.6.35-25-generic.</para><para><informaltable><tgroup cols="2"><tbody><row> <entry><emphasis role="bold">Platform</emphasis></entry><entry><emphasis role="bold">time per invocation [microseconds]</emphasis></entry></row> <row> <entry>Windows </entry><entry>2.9</entry></row> <row> <entry>Linux </entry><entry>1.7</entry></row> </tbody></tgroup></informaltable> </para><para>The measurement error is estimated at +/- 1 usec. </para></description><typedef id="doxygen.headers.classboost_1_1random__device_1ae36bf7c5bab7ec8884cb0e20e022b464" name="result_type"><type>unsigned int</type></typedef> <data-member id="doxygen.headers.classboost_1_1random__device_1a27bda859ca4b05f596a6d4f56224e021" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random__device_1a17f637ce9a807f342978802ac7e0afd7" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the <classname alt="boost::random::random_device">random_device</classname> can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random__device_1a3760c3f8c0d9fd9e661656eff5ca72d7" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the <classname alt="boost::random::random_device">random_device</classname> can produce. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random__device_1ae40e31cc9446fbbecc7d63918dfa493c"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random__device">random_device</link></computeroutput>, optionally using the default device. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random__device_1a54dd4c399a3cba50b3784c3fa0e9bf00" specifiers="explicit"><parameter name="token"><paramtype>const std::string &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random__device">random_device</link></computeroutput>, optionally using the given token as an access specification (for example, a URL) to some implementation-defined service for monitoring a stochastic process. </para></description></constructor> <destructor id="doxygen.headers.classboost_1_1random__device_1acfa2ebfa987dab8e3eccb7034a5084fb"/> <method id="doxygen.headers.classboost_1_1random__device_1aac30aed524c1d2958b900f4cbcdca6fc" name="entropy" cv="const"><type>double</type><description><para>Returns: An entropy estimate for the random numbers returned by operator(), in the range <link linkend="doxygen.headers.classboost_1_1random_1_1random__device_1a17f637ce9a807f342978802ac7e0afd7">min()</link> to log2( <link linkend="doxygen.headers.classboost_1_1random_1_1random__device_1a3760c3f8c0d9fd9e661656eff5ca72d7">max()</link>+1). A deterministic random number generator (e.g. a pseudo-random number engine) has entropy 0.</para><para>Throws: Nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random__device_1aa45152ed89b4924b07ec09f6d595cb5e" name="operator()"><type>unsigned int</type><description><para>Returns a random value in the range [min, max]. </para></description></method> <method id="doxygen.headers.classboost_1_1random__device_1a724affff2feee3aa7adf56ddc1336589" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="begin"><paramtype>Iter</paramtype></parameter><parameter name="end"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random 32-bit values. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1random__device" name="random_device"><inherit access="private">noncopyable</inherit><description><para>Class <classname alt="boost::random::random_device">random_device</classname> models a <link linkend="boost_random.reference.concepts.non_deterministic_uniform_random_number_generator">non-deterministic random number generator</link> . It uses one or more implementation-defined stochastic processes to generate a sequence of uniformly distributed non-deterministic random numbers. For those environments where a non-deterministic random number generator is not available, class <link linkend="doxygen.headers.classboost_1_1random_1_1random__device">random_device</link> must not be implemented. See</para><para> <blockquote><para> "Randomness Recommendations for Security", D. Eastlake, S. Crocker, J. Schiller, Network Working Group, RFC 1750, December 1994 </para></blockquote> </para><para>for further discussions.</para><para> <note><para> Some operating systems abstract the computer hardware enough to make it difficult to non-intrusively monitor stochastic processes. However, several do provide a special device for exactly this purpose. It seems to be impossible to emulate the functionality using Standard C++ only, so users should be aware that this class may not be available on all platforms. </para></note> </para><para><emphasis role="bold">Implementation Note for Linux</emphasis></para><para>On the Linux operating system, token is interpreted as a filesystem path. It is assumed that this path denotes an operating system pseudo-device which generates a stream of non-deterministic random numbers. The pseudo-device should never signal an error or end-of-file. Otherwise, <computeroutput>std::ios_base::failure</computeroutput> is thrown. By default, <classname alt="boost::random::random_device">random_device</classname> uses the /dev/urandom pseudo-device to retrieve the random numbers. Another option would be to specify the /dev/random pseudo-device, which blocks on reads if the entropy pool has no more random bits available.</para><para><emphasis role="bold">Implementation Note for Windows</emphasis></para><para>On the Windows operating system, token is interpreted as the name of a cryptographic service provider. By default <classname alt="boost::random::random_device">random_device</classname> uses MS_DEF_PROV.</para><para><emphasis role="bold">Performance</emphasis></para><para>The test program <ulink url="../../libs/random/performance/nondet_random_speed.cpp">nondet_random_speed.cpp</ulink> measures the execution times of the <link linkend="doxygen.headers.random__device_8hpp_source">random_device.hpp</link> implementation of the above algorithms in a tight loop. The performance has been evaluated on an Intel(R) Core(TM) i7 CPU Q 840 @ 1.87GHz, 1867 Mhz with Visual C++ 2010, Microsoft Windows 7 Professional and with gcc 4.4.5, Ubuntu Linux 2.6.35-25-generic.</para><para><informaltable><tgroup cols="2"><tbody><row> <entry><emphasis role="bold">Platform</emphasis></entry><entry><emphasis role="bold">time per invocation [microseconds]</emphasis></entry></row> <row> <entry>Windows </entry><entry>2.9</entry></row> <row> <entry>Linux </entry><entry>1.7</entry></row> </tbody></tgroup></informaltable> </para><para>The measurement error is estimated at +/- 1 usec. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1random__device_1ae36bf7c5bab7ec8884cb0e20e022b464" name="result_type"><type>unsigned int</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1random__device_1a27bda859ca4b05f596a6d4f56224e021" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1random__device_1a17f637ce9a807f342978802ac7e0afd7" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the <classname alt="boost::random::random_device">random_device</classname> can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1random__device_1a3760c3f8c0d9fd9e661656eff5ca72d7" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the <classname alt="boost::random::random_device">random_device</classname> can produce. </para></description></method> </method-group> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1random__device_1ae40e31cc9446fbbecc7d63918dfa493c"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1random__device">random_device</link></computeroutput>, optionally using the default device. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1random__device_1a54dd4c399a3cba50b3784c3fa0e9bf00" specifiers="explicit"><parameter name="token"><paramtype>const std::string &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1random__device">random_device</link></computeroutput>, optionally using the given token as an access specification (for example, a URL) to some implementation-defined service for monitoring a stochastic process. </para></description></constructor> <destructor id="doxygen.headers.classboost_1_1random_1_1random__device_1acfa2ebfa987dab8e3eccb7034a5084fb"/> <method id="doxygen.headers.classboost_1_1random_1_1random__device_1aac30aed524c1d2958b900f4cbcdca6fc" name="entropy" cv="const"><type>double</type><description><para>Returns: An entropy estimate for the random numbers returned by operator(), in the range <link linkend="doxygen.headers.classboost_1_1random_1_1random__device_1a17f637ce9a807f342978802ac7e0afd7">min()</link> to log2( <link linkend="doxygen.headers.classboost_1_1random_1_1random__device_1a3760c3f8c0d9fd9e661656eff5ca72d7">max()</link>+1). A deterministic random number generator (e.g. a pseudo-random number engine) has entropy 0.</para><para>Throws: Nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1random__device_1aa45152ed89b4924b07ec09f6d595cb5e" name="operator()"><type>unsigned int</type><description><para>Returns a random value in the range [min, max]. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1random__device_1a724affff2feee3aa7adf56ddc1336589" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="begin"><paramtype>Iter</paramtype></parameter><parameter name="end"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random 32-bit values. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.random__number__generator_8hpp" name="boost/random/random_number_generator.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1random__number__generator" name="random_number_generator"><template> <template-type-parameter name="URNG"/> <template-type-parameter name="IntType"><default>long</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random__number__generator">random_number_generator</link> model a RandomNumberGenerator (std:25.2.11 [lib.alg.random.shuffle]). On each invocation, it returns a uniformly distributed integer in the range [0..n).</para><para>The template parameter IntType shall denote some integer-like value type. </para></description><typedef id="doxygen.headers.classboost_1_1random__number__generator_1ac650ed5374f74764a38b32aa4a325f6f" name="base_type"><type>URNG</type></typedef> <typedef id="doxygen.headers.classboost_1_1random__number__generator_1ac69c8070a52b0c5a39428f0fe7ef3b8f" name="argument_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random__number__generator_1a4ea8f4d36eb389fe2831fee6e14d82df" name="result_type"><type>IntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random__number__generator_1ab5dfb5482830b949dc9ce0371d754747"><parameter name="rng"><paramtype>base_type &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random__number__generator">random_number_generator</link> functor with the given <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> as the underlying source of random numbers. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random__number__generator_1a6fcb991000ded175d566a0ccb171f7ed" name="operator()"><type>result_type</type><parameter name="n"><paramtype>argument_type</paramtype></parameter><description><para>Returns a value in the range [0, n) </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1random__number__generator" name="random_number_generator"><template> <template-type-parameter name="URNG"/> <template-type-parameter name="IntType"><default>long</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1random__number__generator">random_number_generator</link> model a RandomNumberGenerator (std:25.2.11 [lib.alg.random.shuffle]). On each invocation, it returns a uniformly distributed integer in the range [0..n).</para><para>The template parameter IntType shall denote some integer-like value type. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1random__number__generator_1ac650ed5374f74764a38b32aa4a325f6f" name="base_type"><type>URNG</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1random__number__generator_1ac69c8070a52b0c5a39428f0fe7ef3b8f" name="argument_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1random__number__generator_1a4ea8f4d36eb389fe2831fee6e14d82df" name="result_type"><type>IntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1random__number__generator_1ab5dfb5482830b949dc9ce0371d754747"><parameter name="rng"><paramtype>base_type &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1random__number__generator">random_number_generator</link> functor with the given <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> as the underlying source of random numbers. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1random__number__generator_1a6fcb991000ded175d566a0ccb171f7ed" name="operator()"><type>result_type</type><parameter name="n"><paramtype>argument_type</paramtype></parameter><description><para>Returns a value in the range [0, n) </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.ranlux_8hpp" name="boost/random/ranlux.hpp"> <namespace name="boost"> <namespace name="random"> <typedef id="doxygen.headers.ranlux_8hpp_1a2c9e260e53338d477d03d548117246e1" name="ranlux_base"><type><classname>subtract_with_carry_engine</classname>< uint32_t, 24, 10, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ac9c61777ad758f0d214f2d724bd7c8cd" name="ranlux_base_01"><type><classname>subtract_with_carry_01_engine</classname>< float, 24, 10, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a0577b8811d84912a4c6970b112ee2f01" name="ranlux64_base_01"><type><classname>subtract_with_carry_01_engine</classname>< double, 48, 10, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a87f29fa68674b423a9ce05df92c9c20c" name="ranlux3"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux_base</classname>, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1af5bf2ff89414f1088a9c6e3306219311" name="ranlux4"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux_base</classname>, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a602f4137a9fe7a43e6ef0528fbbad3e0" name="ranlux3_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux_base_01</classname>, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ae3a69861b0a8725b27c3c6f2f09ee723" name="ranlux4_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux_base_01</classname>, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a890de1b9a477ef339a47299ecfe084ae" name="ranlux64_3_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux64_base_01</classname>, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ade866cea457458743800c8ca9f559f93" name="ranlux64_4_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux64_base_01</classname>, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ab61f730cf0d60d8a624825868159af17" name="ranlux64_base"><type><classname>subtract_with_carry_engine</classname>< uint64_t, 48, 10, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a1c822c80254716b260aa63b9f6ea84ee" name="ranlux64_3"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux64_base</classname>, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1abbbf73f032d8bf9ea7f2b1048c6770b0" name="ranlux64_4"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type><classname>discard_block_engine</classname>< <classname>ranlux64_base</classname>, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1addb5a0c141452dcce3a2cd6132b46b5d" name="ranlux24_base"><type><classname>subtract_with_carry_engine</classname>< uint32_t, 24, 10, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a56deaf6c392f77547b993c6591bb0bd2" name="ranlux48_base"><type><classname>subtract_with_carry_engine</classname>< uint64_t, 48, 5, 12 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a9bfef468a89c0dc782dd361d8bf7cd30" name="ranlux24"><type><classname>discard_block_engine</classname>< <classname>ranlux24_base</classname>, 223, 23 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a721855bf6f364d0c4078ae47d46f83b6" name="ranlux48"><type><classname>discard_block_engine</classname>< <classname>ranlux48_base</classname>, 389, 11 ></type></typedef> </namespace> <typedef id="doxygen.headers.ranlux_8hpp_1a87f29fa68674b423a9ce05df92c9c20c" name="ranlux3"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux_base, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1af5bf2ff89414f1088a9c6e3306219311" name="ranlux4"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux_base, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a602f4137a9fe7a43e6ef0528fbbad3e0" name="ranlux3_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux_base_01, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ae3a69861b0a8725b27c3c6f2f09ee723" name="ranlux4_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux_base_01, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a890de1b9a477ef339a47299ecfe084ae" name="ranlux64_3_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux64_base_01, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1ade866cea457458743800c8ca9f559f93" name="ranlux64_4_01"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux64_base_01, 389, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1a1c822c80254716b260aa63b9f6ea84ee" name="ranlux64_3"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux64_base, 223, 24 ></type></typedef> <typedef id="doxygen.headers.ranlux_8hpp_1abbbf73f032d8bf9ea7f2b1048c6770b0" name="ranlux64_4"><description><para>The ranlux family of generators are described in</para><para> <blockquote><para> "A portable high-quality random number generator for lattice field theory calculations", M. Luescher, Computer Physics Communications, 79 (1994) pp 100-110. </para></blockquote> </para><para>The levels are given in</para><para> <blockquote><para> "RANLUX: A Fortran implementation of the high-quality pseudorandom number generator of Luescher", F. James, Computer Physics Communications 79 (1994) 111-114 </para></blockquote> </para></description><type>discard_block_engine< ranlux64_base, 389, 24 ></type></typedef> </namespace> </header> <header id="doxygen.headers.seed__seq_8hpp" name="boost/random/seed_seq.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1seed__seq" name="seed_seq"><description><para>The class <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1seed__seq">seed_seq</link></computeroutput> stores a sequence of 32-bit words for seeding a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . These words will be combined to fill the entire state of the generator. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1seed__seq_1aa2e59117daafb9ea86f6ac5255226cfe" name="result_type"><type>boost::uint_least32_t</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a85db7bcd6180ec1cd4b7a18b3746ca8d"><description><para>Initializes a <link linkend="doxygen.headers.classboost_1_1random_1_1seed__seq">seed_seq</link> to hold an empty sequence. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a0282650ee6ecaeaae9edf5798dae4925"><template> <template-type-parameter name="T"/> </template><parameter name="il"><paramtype>const std::initializer_list< T > &</paramtype></parameter><description><para>Initializes the sequence from an initializer_list. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a035e44acdd4a69ec9509ae89bcde1714"><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Initializes the sequence from an iterator range. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a000a67badcb8c3f197aac1d01fd5baea" specifiers="explicit"><template> <template-type-parameter name="Range"/> </template><parameter name="range"><paramtype>const Range &</paramtype></parameter><description><para>Initializes the sequence from Boost.Range range. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a85e3b3b288412b9b775d26cb8d922d90" name="generate" cv="const"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with 32-bit values based on the stored sequence.</para><para>Requires: Iter must be a Random Access Iterator whose value type is an unsigned integral type at least 32 bits wide. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1seed__seq_1adfcc0943ee6534df56933701a2065ba8" name="size" cv="const"><type>std::size_t</type><description><para>Returns the size of the sequence. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1seed__seq_1a79d88752048f936b0f47b5cb946bc4f4" name="param"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="out"><paramtype>Iter</paramtype></parameter><description><para>Writes the stored sequence to iter. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.shuffle__order_8hpp" name="boost/random/shuffle_order.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine" name="shuffle_order_engine"><template> <template-type-parameter name="UniformRandomNumberGenerator"/> <template-nontype-parameter name="k"><type>std::size_t</type></template-nontype-parameter> </template><description><para>Instatiations of class template <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine">shuffle_order_engine</link></computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . It mixes the output of some (usually <classname alt="boost::random::linear_congruential_engine">linear_congruential_engine</classname>) <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> to get better statistical properties. The algorithm is described in</para><para> <blockquote><para> "Improving a poor random number generator", Carter Bays and S.D. Durham, ACM Transactions on Mathematical Software, Vol 2, No. 1, March 1976, pp. 59-64. <ulink url="http://doi.acm.org/10.1145/355666.355670">http://doi.acm.org/10.1145/355666.355670</ulink> </para></blockquote> </para><para>The output of the base generator is buffered in an array of length k. Every output X(n) has a second role: It gives an index into the array where X(n+1) will be retrieved. Used array elements are replaced with fresh output from the base generator.</para><para>Template parameters are the base generator and the array length k, which should be around 100. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a41ffda2f37144f1b7a13c6a7d2a8a812" name="base_type"><type>UniformRandomNumberGenerator</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a48bdf332e66f5e1ee07c9e38d880f2dd" name="result_type"><type>base_type::result_type</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a81bfe41b9e6ee0c80f26eea19a3dd12c" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a239b9918b081e21c20cfd4a22e3e2f63" name="buffer_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a15d60db32967591e5bb81028bd347e3d" name="table_size" specifiers="static"><type>const std::size_t</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a7bb7aad6db1ef7dc28cf6ef3879803ac"><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine">shuffle_order_engine</link></computeroutput> by invoking the default constructor of the base generator.</para><para>Complexity: Exactly k+1 invocations of the base generator. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1ae09cd5940e51b189dcb93d436d01172d" specifiers="explicit"><parameter name="s"><paramtype>result_type</paramtype></parameter><description><para>Constructs a <computeroutput>shuffle_output_engine</computeroutput> by invoking the one-argument constructor of the base generator with the parameter seed.</para><para>Complexity: Exactly k+1 invocations of the base generator. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a530627b21a4f3eb8a387f57683af3931" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a8bb5bb9a481cbe0583ecaf1f6796f34f" specifiers="explicit"><parameter name="rng"><paramtype>const base_type &</paramtype></parameter><description><para>Constructs a <computeroutput>shuffle_output_engine</computeroutput> by using a copy of the provided generator.</para><para>Precondition: The template argument UniformRandomNumberGenerator shall denote a CopyConstructible type.</para><para>Complexity: Exactly k+1 invocations of the base generator. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a343f98db3bd690c4fe5cb7c2c4dfd0c5" specifiers="explicit"><parameter name="rng"><paramtype>base_type &&</paramtype></parameter></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1aeac297d431d4b9975efedec9a98d2167"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter></constructor> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a19d64b5fa9f8fc718b6fcbdfe2c32dc3" name="seed"><type>void</type></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a29cf0951bc68a088c9e1a44781990fc8" name="seed"><type>void</type><parameter name="seed"><paramtype>result_type</paramtype></parameter><description><para>Invokes the one-argument seed method of the base generator with the parameter seed and re-initializes the internal buffer array.</para><para>Complexity: Exactly k+1 invocations of the base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a68c281b135080cc28d51acb5b88d6ec3" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Invokes the one-argument seed method of the base generator with the parameter seq and re-initializes the internal buffer array.</para><para>Complexity: Exactly k+1 invocations of the base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1ab12c737e88d5f5f077c5fb1344a7fa0b" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a9343f25067b1d80c937a9611e49ef1f2" name="base" cv="const"><type>const base_type &</type></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1acca439403195b123563c6932ae5c6e8f" name="operator()"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a3e5350796e6004c76d5a2177e2603bcd" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the generator by z steps. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a145980099565b40ef3bd3e4ae5ab9e67" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with pseudo-random values. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a901f374bb3fa3386f8bd650310b3e8ba" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1af77122efbe5c9d924ce4b023a2955ce0" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a4ce8ef63f6b9d64141308afc665e8d71" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine">shuffle_order_engine</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a3bcb8d95efa30aa5e1a8ee56c96a557a" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine">shuffle_order_engine</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a483c2e10da56c40b2851f36cdbf82096" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1shuffle__order__engine_1a2f62c6ef935a7e89299a86da7e13d8bd" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>shuffle_order_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences. </para></description></method> </method-group> </class><typedef id="doxygen.headers.shuffle__order_8hpp_1a8970fdb751bec3ae0871c81f6833fd21" name="kreutzer1986"><description><para>According to Harry Erwin (private e-mail), the specialization <computeroutput>kreutzer1986</computeroutput> was suggested in:</para><para> <blockquote><para> "System Simulation: Programming Styles and Languages (International Computer Science Series)", Wolfgang Kreutzer, Addison-Wesley, December 1986. </para></blockquote> </para></description><type><classname>shuffle_order_engine</classname>< <classname>linear_congruential_engine</classname>< uint32_t, 1366, 150889, 714025 >, 97 ></type></typedef> <typedef id="doxygen.headers.shuffle__order_8hpp_1ab372a11e4e91090b178a7643f31e786c" name="knuth_b"><description><para>The specialization <computeroutput>knuth_b</computeroutput> is specified by the C++ standard. It is described in</para><para> <blockquote><para> "The Art of Computer Programming, Second Edition, Volume 2, Seminumerical Algorithms", Donald Knuth, Addison-Wesley, 1981. </para></blockquote> </para></description><type><classname>shuffle_order_engine</classname>< <classname>minstd_rand0</classname>, 256 ></type></typedef> <data-member id="doxygen.headers.shuffle__order_8hpp_1aaaa8ad8c4ba6307d940704208b5ea757" name="shuffle_order_engine< URNG, k >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.shuffle__order_8hpp_1afaaeba9d3723452c3d223f11df0921e2" name="shuffle_order_engine< URNG, k >::table_size"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.shuffle__order_8hpp_1a1cd279686ba1d6e99e0e71733f98f6a3" name="shuffle_order_engine< URNG, k >::buffer_size"><type>const std::size_t</type></data-member> </namespace> <typedef id="doxygen.headers.shuffle__order_8hpp_1a8970fdb751bec3ae0871c81f6833fd21" name="kreutzer1986"><description><para>According to Harry Erwin (private e-mail), the specialization <computeroutput>kreutzer1986</computeroutput> was suggested in:</para><para> <blockquote><para> "System Simulation: Programming Styles and Languages (International Computer Science Series)", Wolfgang Kreutzer, Addison-Wesley, December 1986. </para></blockquote> </para></description><type>shuffle_order_engine< linear_congruential_engine< uint32_t, 1366, 150889, 714025 >, 97 ></type></typedef> </namespace> </header> <header id="doxygen.headers.sobol_8hpp" name="boost/random/sobol.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1sobol__engine" name="sobol_engine"><template> <template-type-parameter name="UIntType"/> <template-nontype-parameter name="w"><type>unsigned</type></template-nontype-parameter> <template-type-parameter name="SobolTables"><default>default_sobol_table</default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1sobol__engine">sobol_engine</link> model a <link linkend="boost_random.reference.concepts.quasi_random_number_generator">quasi-random number generator</link> . The <link linkend="doxygen.headers.classboost_1_1random_1_1sobol__engine">sobol_engine</link> uses the algorithm described in <blockquote><para> [Bratley+Fox, TOMS 14, 88 (1988)] and [Antonov+Saleev, USSR Comput. Maths. Math. Phys. 19, 252 (1980)] </para></blockquote> </para><para><important><para><link linkend="doxygen.headers.classboost_1_1random_1_1sobol__engine">sobol_engine</link> skips trivial zeroes at the start of the sequence. For example, the beginning of the 2-dimensional Sobol sequence in <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__01">uniform_01</link></computeroutput> distribution will look like this: <programlisting language="c++">0.5, 0.5, 0.75, 0.25, 0.25, 0.75, 0.375, 0.375, 0.875, 0.875, ... </programlisting></para> </important> In the following documentation <computeroutput>X</computeroutput> denotes the concrete class of the template <link linkend="doxygen.headers.classboost_1_1random_1_1sobol__engine">sobol_engine</link> returning objects of type <computeroutput>UIntType</computeroutput>, u and v are the values of <computeroutput>X</computeroutput>.</para><para>Some member functions may throw exceptions of type <computeroutput>std::range_error</computeroutput>. This happens when the quasi-random domain is exhausted and the generator cannot produce any more values. The length of the low discrepancy sequence is given by <inlineequation><alt>$L=Dimension \times (2^{w} - 1)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_31.png"/></imageobject><textobject role="tex"><phrase>$L=Dimension \times (2^{w} - 1)$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a236d9d262e57f31dac97dd2264b8b46a" name="result_type"><type>UIntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a4aa297a45f8cbdaf796028a8312062e1" specifiers="explicit"><parameter name="s"><paramtype>std::size_t</paramtype></parameter><description><para>Effects: Constructs the default <computeroutput>s</computeroutput>-dimensional Sobol quasi-random number generator.</para><para>Throws: bad_alloc, invalid_argument, range_error. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1abd4e6f4fdf43ab3927f22871453fe4d8" name="dimension" cv="const"><type>std::size_t</type><description><para>Returns: The dimension of of the quasi-random domain.</para><para>Throws: nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a406504b1534199f17027dbee5ab61159" name="seed"><type>void</type><purpose>Throws: nothing. </purpose><description><para>Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a75e59f25c30646311aa7539647da3358" name="seed"><type>void</type><parameter name="init"><paramtype>UIntType</paramtype></parameter><purpose>Throws: range_error. </purpose><description><para>Effects: Effectively sets the quasi-random number generator state to the <computeroutput>init</computeroutput>-th vector in the <computeroutput>s</computeroutput>-dimensional quasi-random domain, where <computeroutput>s</computeroutput> == X::dimension(). <programlisting language="c++">X u, v; for(int i = 0; i < N; ++i) for( std::size_t j = 0; j < u.dimension(); ++j ) u(); v.seed(N); assert(u() == v()); </programlisting> </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a151b6d12d7e442d621bf1768528b6cbb" name="operator()"><type>result_type</type><description><para>Returns: Returns a successive element of an <computeroutput>s</computeroutput>-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent <computeroutput>s</computeroutput>-dimensional vector.</para><para>Throws: range_error. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a8d1c26492b1684b7aac6021b1fa7785a" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Effects: Advances *this state as if <computeroutput>z</computeroutput> consecutive X::operator() invocations were executed. <programlisting language="c++">X u = v; for(int i = 0; i < N; ++i) u(); v.discard(N); assert(u() == v()); </programlisting></para><para>Throws: range_error. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a5da6318480feef8731117b95e4147152" name="min" specifiers="static"><type>result_type</type><description><para>Returns: Tight lower bound on the set of values returned by operator().</para><para>Throws: nothing. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a21a7168daf4ab1216c1f76189bf9fbfb" name="max" specifiers="static"><type>result_type</type><description><para>Returns: Tight upper bound on the set of values returned by operator().</para><para>Throws: nothing. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a20204569aa9008f208aaa83b8f6b77cb" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a42049da5a30a32947e730c6dd9e08dc3" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of outputs. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1a61c1964bfca95bc3915bc08c1bb961da" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1sobol__engine_1ae51f35edc3a20fcd0c81215623ce6411" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>sobol_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> </method-group> </class><typedef id="doxygen.headers.sobol_8hpp_1aa5b0c5ac9d0b5f30aeec86300f90e403" name="sobol"><description><para><important><para>This specialization of <classname alt="boost::random::sobol_engine">sobol_engine</classname> supports up to 3667 dimensions.</para> </important> Data on the primitive binary polynomials <computeroutput>a</computeroutput> and the corresponding starting values <computeroutput>m</computeroutput> for Sobol sequences in up to 21201 dimensions was taken from</para><para> <blockquote><para> S. Joe and F. Y. Kuo, Constructing Sobol sequences with better two-dimensional projections, SIAM J. Sci. Comput. 30, 2635-2654 (2008). </para></blockquote> </para><para>See the original tables up to dimension 21201: <ulink url="https://web.archive.org/web/20170802022909/http://web.maths.unsw.edu.au/~fkuo/sobol/new-joe-kuo-6.21201">https://web.archive.org/web/20170802022909/http://web.maths.unsw.edu.au/~fkuo/sobol/new-joe-kuo-6.21201</ulink></para><para>For practical reasons the default table uses only the subset of binary polynomials <computeroutput>a</computeroutput> < 2<superscript>16</superscript>.</para><para>However, it is possible to provide your own table to <classname alt="boost::random::sobol_engine">sobol_engine</classname> should the default one be insufficient. </para></description><type><classname>sobol_engine</classname>< boost::uint_least64_t, 64u, default_sobol_table ></type></typedef> </namespace> </namespace> </header> <header id="doxygen.headers.splitmix64_8hpp" name="boost/random/splitmix64.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1splitmix64" name="splitmix64"><description><para>This is a fixed-increment version of Java 8's SplittableRandom generator See <ulink url="http://dx.doi.org/10.1145/2714064.2660195">http://dx.doi.org/10.1145/2714064.2660195</ulink> and <ulink url="http://docs.oracle.com/javase/8/docs/api/java/util/SplittableRandom.html">http://docs.oracle.com/javase/8/docs/api/java/util/SplittableRandom.html</ulink> It is a very fast generator passing BigCrush, and it can be useful if for some reason you absolutely want 64 bits of state; otherwise, we rather suggest to use a xoroshiro128+ (for moderately parallel computations) or xorshift1024* (for massively parallel computations) generator. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a1eb45f2d3b66b0e178dcefd2cfe2e131" name="result_type"><type>std::uint64_t</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a712b93ad826651231292d535931b1991" name="seed_type"><type>std::uint64_t</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1splitmix64_1ae1166371f4bf799e3e4bf95e3fbe3547" name="has_fixed_range" specifiers="static"><type>bool</type></data-member> <method-group name="private member functions"> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a31b5a216b3407fec37f7d152081c5b38" name="concatenate" cv="noexcept"><type>std::uint64_t</type><parameter name="word1"><paramtype>std::uint32_t</paramtype></parameter><parameter name="word2"><paramtype>std::uint32_t</paramtype></parameter></method> </method-group> <method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a5846115125bdcdf816000225b5d6e351" name="seed" cv="noexcept"><type>void</type><parameter name="value"><paramtype>result_type</paramtype><default>0</default></parameter><description><para>Seeds the generator with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1af10b7805fce8c1c4559a77878503c01a" name="seed"><type>void</type><template> <template-type-parameter name="Sseq"/> <template-type-parameter name="std::enable_if<!std::is_convertible< Sseq, std::uint64_t >::value, bool >::type"><default>true</default></template-type-parameter> </template><parameter name="seq"><paramtype>Sseq &</paramtype></parameter><description><para>Seeds the generator with 32-bit values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <constructor id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a00826227091d19b6816abb1c36347038" specifiers="explicit"><template> <template-type-parameter name="Sseq"/> <template-type-parameter name="std::enable_if<!std::is_convertible< Sseq, splitmix64 >::value, bool >::type"><default>true</default></template-type-parameter> </template><parameter name="seq"><paramtype>Sseq &</paramtype></parameter><description><para>Seeds the generator with 64-bit values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1ae0e668c7da113c3cbf68dfce22f5d605" name="seed" cv="noexcept"><type>void</type><template> <template-type-parameter name="T"/> <template-type-parameter name="std::enable_if< std::is_convertible< T, std::uint64_t >::value, bool >::type"><default>true</default></template-type-parameter> </template><parameter name="value"><paramtype>T</paramtype><default>0</default></parameter><description><para>Seeds the generator with a user provided seed. </para></description></method> <constructor id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a6bdefb0876975873ad3524e67eb02f0c" specifiers="explicit" cv="noexcept"><parameter name="state"><paramtype>std::uint64_t</paramtype><default>0</default></parameter><description><para>Seeds the generator with a user provided seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a1f97258e2db25261b6b961c01f96e353" cv="= default"><parameter name="other"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter></constructor> <copy-assignment id="doxygen.headers.classboost_1_1random_1_1splitmix64_1ac5d390fcf2552b9907d0b755570ed9e6" cv="= default"><type><classname>splitmix64</classname> &</type><parameter name="other"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter></copy-assignment> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a9a73b0603f832cd9ec215ea48a57b69f" name="next" cv="noexcept"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a49a3d1bc35523e757dd69c4f4ef60582" name="operator()" cv="noexcept"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1aeb84e128a859b112e4f8087eaf978581" name="discard" cv="noexcept"><type>void</type><parameter name="z"><paramtype>std::uint64_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a5e363ab05442816007fac8e8fcd652eb" name="generate" cv="noexcept"><type>void</type><template> <template-type-parameter name="FIter"/> </template><parameter name="first"><paramtype>FIter</paramtype></parameter><parameter name="last"><paramtype>FIter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a66af19da088d34f41c0c93502f190827" name="operator==" cv="noexcept"><type>bool</type><parameter name="lhs"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a26871a97d5157b480f9a61194a66a408" name="operator!=" cv="noexcept"><type>bool</type><parameter name="lhs"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a7f06145ac0d45a666a33adee9f5195ba" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="ost"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="e"><paramtype>const <classname>splitmix64</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1ac91be3047a919cae8c61a54f2cca9d39" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="ist"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="e"><paramtype><classname>splitmix64</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link></computeroutput> to a <computeroutput>std::istream</computeroutput>. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1ae330673c2fc3528a9bb13c21b6a515f5" name="max" cv="noexcept" specifiers="static"><type>constexpr</type><description><para>Returns the largest value that the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link></computeroutput> can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1splitmix64_1a05d2f7d1a9bc69df50a2c85ac11a4ae2" name="min" cv="noexcept" specifiers="static"><type>constexpr</type><description><para>Returns the smallest value that the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link></computeroutput> can produce. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.student__t__distribution_8hpp" name="boost/random/student_t_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1student__t__distribution" name="student_t_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The Student t distribution is a real valued distribution with one parameter n, the number of degrees of freedom.</para><para>It has <inlineequation><alt>$\displaystyle p(x) = \frac{1}{\sqrt{n\pi}} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)} \left(1+\frac{x^2}{n}\right)^{-(n+1)/2} $</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_37.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{1}{\sqrt{n\pi}} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)} \left(1+\frac{x^2}{n}\right)^{-(n+1)/2} $</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><class id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1a7fd0c9575188836d4796cd40c02e9eac" name="distribution_type"><type><classname>student_t_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1aeeed4c17770db74983bfd324601d6687" specifiers="explicit"><parameter name="n"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type">param_type</link></computeroutput> with "n" degrees of freedom.</para><para>Requires: n > 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1a47b95eb4c99f3113b3f7fd3c6789ed55" name="n" cv="const"><type>RealType</type><description><para>Returns the number of degrees of freedom of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1af08c6295b8da942507afc26096af6546" name="result_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a34e53b64d34b843985dc6b1fef8241f7" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a0dd172c5a126a0a4bd33069b6404bdf0" specifiers="explicit"><parameter name="n"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> with "n" degrees of freedom.</para><para>Requires: n > 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1ae07319bcc4fcfe95bfa8fe8a2e0e90f5" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs an <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1ac198169822f59f03e2178d822f6bec0b" name="operator()"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the Student t distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a235eb3f63fcbe817bd87948ce00ceb6e" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed accordint to the Student t distribution with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a5dc215f85530b64ad7c33205020543b9" name="n" cv="const"><type>RealType</type><description><para>Returns the number of degrees of freedom. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1ac0169a8200b1944eb0270fb07ecd2ad4" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a0d265e4c9f2f5ddd374c88e567647585" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a03511fbbfdcd8f4f55055fe77ed0e2e2" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a998b1188315fa7bcae8ef2f26c28331f" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1ad57d01dc7afee92c98e8bf2cf3a8bf64" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1ad6d8ef01af3c22bd2298c9ef1243e796" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a021ad51df01740bbe7f87f78e5228d22" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1acb8b3f1a299f19e5a0463ef32e8c3489" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1student__t__distribution_1a74016b8b92a91fed898734477f684a5b" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>student_t_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1student__t__distribution">student_t_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.subtract__with__carry_8hpp" name="boost/random/subtract_with_carry.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine" name="subtract_with_carry_01_engine"><template> <template-type-parameter name="RealType"/> <template-nontype-parameter name="w"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="s"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="r"><type>std::size_t</type></template-nontype-parameter> </template><description><para>Instantiations of <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . The algorithm is described in</para><para> <blockquote><para> "A New Class of Random Number Generators", George Marsaglia and Arif Zaman, Annals of Applied Probability, Volume 1, Number 3 (1991), 462-480. </para></blockquote> </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a9fbe3143e299140d66ebfe2e89ae1f16" name="result_type"><type>RealType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a7b4460b38eaf4386e3b480127035f159" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1afdca0e442d5f5381719c78612b7d39a5" name="word_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1ad951aa4339027afaf27ccf8fe287a3aa" name="long_lag" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1aeafcb94e8e2bf24713dea26cd490a84f" name="short_lag" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a2a5d68771b6681cddfba6ec261bfe2fe" name="default_seed" specifiers="static"><type>const boost::uint32_t</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a507f6c3775b0d5de1aad8c4c302b4b9a"><description><para>Creates a new <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> using the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a48ece96bafb84f0aba717bca767501d3" specifiers="explicit"><parameter name="value"><paramtype>boost::uint32_t</paramtype></parameter><description><para>Creates a new <link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine">subtract_with_carry_01_engine</link> and seeds it with value. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a665c8e99abc9fa4e567d003f4f19ae9c" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Creates a new <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> and seeds with values produced by seq.generate(). </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1aebeba3356ec0bb75668e9ad0e30dd9aa"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Creates a new <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> and seeds it with values from a range. Advances first to point one past the last consumed value. If the range does not contain enough elements to fill the entire state, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a29b86433fe11dcf9aa94cc27bc22b5d8" name="seed"><type>void</type><description><para>Seeds the generator with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a0d58e0136b6e916f3310fac675591472" name="seed"><type>void</type><parameter name="value"><paramtype>boost::uint32_t</paramtype></parameter><description><para>Seeds the generator with <computeroutput>value</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a6a7360c923994e11f29250317e676761" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a05121283a6973a5fa632128a2fe2c918" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator with values from a range. Updates first to point one past the last consumed element. If there are not enough elements in the range to fill the entire state, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a329e5ca484bce034b2e8afe497f2621a" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a3818a8e774f8f74a1ab78212e79fd422" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a8e7296f5bcbf884165a8852cd71519ad" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1afcce676c5d01df7e0b8a0e25176cd939" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a240940145bc256d4c600282610952cdc" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a0de54d05f4908fec5eaed38d3fb66376" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><description><para>Writes a <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a0289a3edd045c80b978d614f3a42d86e" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><description><para>Reads a <classname alt="boost::random::subtract_with_carry_01_engine">subtract_with_carry_01_engine</classname> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a43bf43b15d1e7adc909e77ee7eb58d8a" name="operator=="><type>bool</type><parameter name="x_"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__01__engine_1a46af8417accf4d78bc7aceb7437ce5b1" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>subtract_with_carry_01_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences. </para></description></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine" name="subtract_with_carry_engine"><template> <template-type-parameter name="IntType"/> <template-nontype-parameter name="w"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="s"><type>std::size_t</type></template-nontype-parameter> <template-nontype-parameter name="r"><type>std::size_t</type></template-nontype-parameter> </template><description><para>Instantiations of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . The algorithm is described in</para><para> <blockquote><para> "A New Class of Random Number Generators", George Marsaglia and Arif Zaman, Annals of Applied Probability, Volume 1, Number 3 (1991), 462-480. </para></blockquote> </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a2b0e1162754a1c8b3ac68f68ea945d66" name="result_type"><type>IntType</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a829a44e5a725e629984c0ac706839856" name="word_size" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1ab587484eb68b329a573f5f772d65a2de" name="long_lag" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a99d6619a238f5f8749cac7200d4c8bc1" name="short_lag" specifiers="static"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a6a3657dc16a02b23a0e6dcbd943fe7de" name="default_seed" specifiers="static"><type>const uint32_t</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a2be807a0ccc7b952343af3c244ff5253" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a6e9e7c1749b12ff1c7cf46a2c7d43bbe" name="modulus" specifiers="static"><type>const result_type</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1aa3ad25a1f6b26e852f18c31d2518989f"><description><para>Constructs a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> and seeds it with the default seed. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a434322d770d0f55dcf2425ffc84ac138" specifiers="explicit"><parameter name="value"><paramtype>IntType</paramtype></parameter><description><para>Constructs a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> and seeds it with <computeroutput>value</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a5fb7d1f151ae75d90d67176767a343ee" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> and seeds it with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a4b7801797a1294be1a5ae4131d7e4db3"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Constructs a new <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> and seeds it with values from a range. first is updated to point one past the last value consumed. If there are not enough elements in the range to fill the entire state of the generator, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1ab881f26a10563b0d5d24a43c7692bf42" name="seed"><type>void</type><description><para>Seeds the generator with the default seed. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1aa7c2b2669b6d0eb6a458395863540c06" name="seed"><type>void</type><parameter name="value"><paramtype>IntType</paramtype></parameter></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a951d08952165ba06ab631a3836f588da" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Seeds the generator with values produced by <computeroutput>seq.generate()</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1ab281e9a5766713bb89f47723d648016e" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Seeds the generator with values from a range. Updates <computeroutput>first</computeroutput> to point one past the last consumed value. If the range does not contain enough elements to fill the entire state of the generator, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1adef72791818a9e793938057368ce797d" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1ab56fa8d2f053db6a615c1c9769054cab" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a79111ff29f8247a6d94ac5fa3d78cc55" name="generate"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Fills a range with random values. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a7483d8f67402176e487a1fe1e0b2047f" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a6d81a97655169449d6f9f36338e62f93" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1aa54f7c76526fd821d77e99bdaf2638df" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a86acc5a48c5c5ec3eb7192160c5e6cb3" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="f"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine">subtract_with_carry_engine</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1a543513198d3c9c27601331d1ce9e5731" name="operator=="><type>bool</type><parameter name="x_"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences of values. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1subtract__with__carry__engine_1acbb14c47451624e5c687b05635c3a0a2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>subtract_with_carry_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences of values. </para></description></method> </method-group> </class><data-member id="doxygen.headers.subtract__with__carry_8hpp_1aca722eae6ff6ca899fc911b69673ffd4" name="subtract_with_carry_engine< IntType, w, s, r >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a6a5b2af787f9058cf1d6d8b4fc85cd3e" name="subtract_with_carry_engine< IntType, w, s, r >::modulus"><type>const IntType</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1ac7cd3f0e4f6b73fd661b2a96a0c40014" name="subtract_with_carry_engine< IntType, w, s, r >::word_size"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a885659a0cbc26d19f8286b597dc695b1" name="subtract_with_carry_engine< IntType, w, s, r >::long_lag"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a9af8f34ff980afdc10022fc112772923" name="subtract_with_carry_engine< IntType, w, s, r >::short_lag"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a125e0f39ed2a1f45b942ef2d34d45eba" name="subtract_with_carry_engine< IntType, w, s, r >::default_seed"><type>const uint32_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a1d47af78c6f1850ba005a162aecec4d3" name="subtract_with_carry_01_engine< RealType, w, s, r >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1aa58d47bcdcf12098fb0992e086a29b35" name="subtract_with_carry_01_engine< RealType, w, s, r >::word_size"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1af3e0cc31c54d84bc5ebdc6c151b42f4e" name="subtract_with_carry_01_engine< RealType, w, s, r >::long_lag"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a9ac0637fe1d05d0a9f96426d40748527" name="subtract_with_carry_01_engine< RealType, w, s, r >::short_lag"><type>const std::size_t</type></data-member> <data-member id="doxygen.headers.subtract__with__carry_8hpp_1a140ec2b5f0a67c70be693d2ff9c9dcf7" name="subtract_with_carry_01_engine< RealType, w, s, r >::default_seed"><type>const uint32_t</type></data-member> </namespace> </namespace> </header> <header id="doxygen.headers.taus88_8hpp" name="boost/random/taus88.hpp"> <namespace name="boost"> <namespace name="random"> <typedef id="doxygen.headers.taus88_8hpp_1a3822a73532a76cfeca0db9888d676c72" name="taus88"><description><para>The specialization taus88 was suggested in</para><para> <blockquote><para> "Maximally Equidistributed Combined Tausworthe Generators", Pierre L'Ecuyer, Mathematics of Computation, Volume 65, Number 213, January 1996, Pages 203-213 </para></blockquote> </para></description><type><classname>xor_combine_engine</classname>< <classname>xor_combine_engine</classname>< <classname>linear_feedback_shift_engine</classname>< uint32_t, 32, 31, 13, 12 >, 0, <classname>linear_feedback_shift_engine</classname>< uint32_t, 32, 29, 2, 4 >, 0 >, 0, <classname>linear_feedback_shift_engine</classname>< uint32_t, 32, 28, 3, 17 >, 0 ></type></typedef> </namespace> <typedef id="doxygen.headers.taus88_8hpp_1a3822a73532a76cfeca0db9888d676c72" name="taus88"><description><para>The specialization taus88 was suggested in</para><para> <blockquote><para> "Maximally Equidistributed Combined Tausworthe Generators", Pierre L'Ecuyer, Mathematics of Computation, Volume 65, Number 213, January 1996, Pages 203-213 </para></blockquote> </para></description><type>xor_combine_engine< xor_combine_engine< linear_feedback_shift_engine< uint32_t, 32, 31, 13, 12 >, 0, linear_feedback_shift_engine< uint32_t, 32, 29, 2, 4 >, 0 >, 0, linear_feedback_shift_engine< uint32_t, 32, 28, 3, 17 >, 0 ></type></typedef> </namespace> </header> <header id="doxygen.headers.traits_8hpp" name="boost/random/traits.hpp"> <namespace name="boost"> <namespace name="random"> <namespace name="traits"> <struct id="doxygen.headers.structboost_1_1random_1_1traits_1_1is__integral" name="is_integral"><template> <template-type-parameter name="T"/> </template><inherit access="public">integral_constant< bool, boost::is_integral< T >::value||(std::numeric_limits< T >::is_integer)></inherit><purpose>Traits class that indicates whether type T is an integer. </purpose></struct><struct id="doxygen.headers.structboost_1_1random_1_1traits_1_1is__signed" name="is_signed"><template> <template-type-parameter name="T"/> </template><inherit access="public">integral_constant< bool, boost::is_signed< T >::value||(std::numeric_limits< T >::is_specialized &&std::numeric_limits< T >::is_integer &&std::numeric_limits< T >::is_signed)></inherit><purpose>Traits class that indicates whether type T is a signed integer. </purpose></struct><struct id="doxygen.headers.structboost_1_1random_1_1traits_1_1make__unsigned" name="make_unsigned"><template> <template-type-parameter name="T"/> </template><purpose>Converts the argument type T to an unsigned type. </purpose><description><para>This trait has a single member <computeroutput>type</computeroutput> which is the unsigned type corresponding to T. Note that if T is signed, then member <computeroutput>type</computeroutput> <emphasis>should define a type with one more bit precision than T</emphasis>. For built-in types this trait defaults to <computeroutput>boost::make_unsigned<T>::type</computeroutput>. For user defined types it simply asserts that the argument type T is an unsigned integer (using std::numeric_limits). User defined specializations may be provided for other cases. </para></description></struct><struct id="doxygen.headers.structboost_1_1random_1_1traits_1_1make__unsigned__or__unbounded" name="make_unsigned_or_unbounded"><template> <template-type-parameter name="T"/> </template><purpose>Converts the argument type T to either an unsigned type or an unbounded integer type. </purpose><description><para>This trait has a single member <computeroutput>type</computeroutput> which is either the unsigned type corresponding to T or an unbounded integer type. This trait is used to generate types suitable for the calculation of a range: as a result if T is signed, then member <computeroutput>type</computeroutput> <emphasis>should define a type with one more bit precision than T</emphasis>. For built-in types this trait defaults to <computeroutput>boost::make_unsigned<T>::type</computeroutput>. For user defined types it simply asserts that the argument type T is either an unbounded integer, or an unsigned one (using std::numeric_limits). User defined specializations may be provided for other cases. </para></description></struct></namespace> </namespace> </namespace> </header> <header id="doxygen.headers.triangle__distribution_8hpp" name="boost/random/triangle_distribution.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1triangle__distribution" name="triangle_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>Instantiations of <computeroutput><link linkend="doxygen.headers.classboost_1_1triangle__distribution">triangle_distribution</link></computeroutput> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . A <computeroutput><link linkend="doxygen.headers.classboost_1_1triangle__distribution">triangle_distribution</link></computeroutput> has three parameters, <computeroutput>a</computeroutput>, <computeroutput>b</computeroutput>, and <computeroutput>c</computeroutput>, which are the smallest, the most probable and the largest values of the distribution respectively. </para></description><class id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1ae9ccb31b93f5c04ddb41821736e0118f" name="distribution_type"><type><classname>triangle_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1a25f2f6d552a5bf1395a29487833f159e" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>0.5</default></parameter><parameter name="c"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs the parameters of a <computeroutput><link linkend="doxygen.headers.classboost_1_1triangle__distribution">triangle_distribution</link></computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1a1096a916d945eb038b74d05914f66b22" name="a" cv="const"><type>RealType</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1aa43aec8dc7aa448f6b0fa6d425dbb328" name="b" cv="const"><type>RealType</type><description><para>Returns the mode of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1ac50c0042780b94ca5a2d5cd2361174ae" name="c" cv="const"><type>RealType</type><description><para>Returns the maximum value of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1triangle__distribution_1ac19aa9cf4d4b1efb65e3a3ce55c9dd2e" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1triangle__distribution_1afda1c54b24671bbdc64f23c371c0d5f7" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1triangle__distribution_1aeca2cec785c7525aae38043e0379f1e1" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>0.5</default></parameter><parameter name="c"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1triangle__distribution">triangle_distribution</link></computeroutput> with the parameters <computeroutput>a</computeroutput>, <computeroutput>b</computeroutput>, and <computeroutput>c</computeroutput>.</para><para>Preconditions: a <= b <= c. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1triangle__distribution_1aa1e7384d4762382e38c5d76f96a56444" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1triangle__distribution">triangle_distribution</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a10d95f4d325885d17516e9b296eaa30d" name="a" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>a</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a521228030b1be91ee9a69abc2020c126" name="b" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>b</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1adec7e3cfd781903a396b69c181ee8454" name="c" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>c</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a8d6522e99006b1153159c5aa9fd3bdc3" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a7dbd8d81a26fa504f64936fc779c2409" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a81743023519a6d78bfde3ffe7a2a62cc" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1ad9b5814ed04a62fefdd577bbf8e9e504" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1af057581d3de7577e124c08498fae94cd" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a9383862e3b518fff0ac9b4bcbe5f9a55" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a random variate distributed according to the triangle distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a8c00c8cd98a4e53151ceb0593d809693" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the triangle distribution with parameters specified by param. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a50cbcf16f4b4c21684273d3aa01d61c0" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a99c9c75f9de141a88871cd578966d187" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a14d0d0e1853e1c6835d484daee7f375c" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1triangle__distribution_1a4fbaeb2fa429d375600790be3f9c442f" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1triangle__distribution" name="triangle_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>Instantiations of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1triangle__distribution">triangle_distribution</link></computeroutput> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . A <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1triangle__distribution">triangle_distribution</link></computeroutput> has three parameters, <computeroutput>a</computeroutput>, <computeroutput>b</computeroutput>, and <computeroutput>c</computeroutput>, which are the smallest, the most probable and the largest values of the distribution respectively. </para></description><class id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1ae9ccb31b93f5c04ddb41821736e0118f" name="distribution_type"><type><classname>triangle_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1a25f2f6d552a5bf1395a29487833f159e" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>0.5</default></parameter><parameter name="c"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs the parameters of a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1triangle__distribution">triangle_distribution</link></computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1a1096a916d945eb038b74d05914f66b22" name="a" cv="const"><type>RealType</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1aa43aec8dc7aa448f6b0fa6d425dbb328" name="b" cv="const"><type>RealType</type><description><para>Returns the mode of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1ac50c0042780b94ca5a2d5cd2361174ae" name="c" cv="const"><type>RealType</type><description><para>Returns the maximum value of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1ac19aa9cf4d4b1efb65e3a3ce55c9dd2e" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1afda1c54b24671bbdc64f23c371c0d5f7" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1aeca2cec785c7525aae38043e0379f1e1" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>0.5</default></parameter><parameter name="c"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1triangle__distribution">triangle_distribution</link></computeroutput> with the parameters <computeroutput>a</computeroutput>, <computeroutput>b</computeroutput>, and <computeroutput>c</computeroutput>.</para><para>Preconditions: a <= b <= c. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1aa1e7384d4762382e38c5d76f96a56444" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1triangle__distribution">triangle_distribution</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a10d95f4d325885d17516e9b296eaa30d" name="a" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>a</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a521228030b1be91ee9a69abc2020c126" name="b" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>b</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1adec7e3cfd781903a396b69c181ee8454" name="c" cv="const"><type>result_type</type><description><para>Returns the <computeroutput>c</computeroutput> parameter of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a8d6522e99006b1153159c5aa9fd3bdc3" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a7dbd8d81a26fa504f64936fc779c2409" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a81743023519a6d78bfde3ffe7a2a62cc" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1ad9b5814ed04a62fefdd577bbf8e9e504" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1af057581d3de7577e124c08498fae94cd" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a9383862e3b518fff0ac9b4bcbe5f9a55" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a random variate distributed according to the triangle distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a8c00c8cd98a4e53151ceb0593d809693" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed according to the triangle distribution with parameters specified by param. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a50cbcf16f4b4c21684273d3aa01d61c0" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a99c9c75f9de141a88871cd578966d187" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="td"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a14d0d0e1853e1c6835d484daee7f375c" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1triangle__distribution_1a4fbaeb2fa429d375600790be3f9c442f" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>triangle_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.uniform__01_8hpp" name="boost/random/uniform_01.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1uniform__01" name="uniform_01"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The distribution function <link linkend="doxygen.headers.classboost_1_1uniform__01">uniform_01</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random floating-point value uniformly distributed in the range [0..1).</para><para>The template parameter RealType shall denote a float-like value type with support for binary operators +, -, and /.</para><para>Note: The current implementation is buggy, because it may not fill all of the mantissa with random bits. I'm unsure how to fill a (to-be-invented) <computeroutput>boost::bigfloat</computeroutput> class with random bits efficiently. It's probably time for a traits class. </para></description><typedef id="doxygen.headers.classboost_1_1uniform__01_1af88ccc52deb48788502fc8cec88051fe" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1uniform__01_1ac9392be7066997f3a201461052370e0a" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1uniform__01_1a998c9b64d299f0604b770736c8184e5a" name="min" cv="const"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1uniform__01_1ae22cd2ec3f7bd0619088963a1d8b91e0" name="max" cv="const"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1uniform__01_1a5d079dfeb825e64ce72113cc028e4020" name="reset"><type>void</type></method> <method id="doxygen.headers.classboost_1_1uniform__01_1a17fac21f2b280f2824dbe2e4ebc6a252" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1uniform__01" name="uniform_01"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The distribution function <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__01">uniform_01</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random floating-point value uniformly distributed in the range [0..1).</para><para>The template parameter RealType shall denote a float-like value type with support for binary operators +, -, and /.</para><para>Note: The current implementation is buggy, because it may not fill all of the mantissa with random bits. I'm unsure how to fill a (to-be-invented) <computeroutput>boost::bigfloat</computeroutput> class with random bits efficiently. It's probably time for a traits class. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__01_1af88ccc52deb48788502fc8cec88051fe" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1uniform__01_1ac9392be7066997f3a201461052370e0a" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__01_1a998c9b64d299f0604b770736c8184e5a" name="min" cv="const"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__01_1ae22cd2ec3f7bd0619088963a1d8b91e0" name="max" cv="const"><type>result_type</type></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__01_1a5d079dfeb825e64ce72113cc028e4020" name="reset"><type>void</type></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__01_1a17fac21f2b280f2824dbe2e4ebc6a252" name="operator()"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.uniform__int__distribution_8hpp" name="boost/random/uniform_int_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution" name="uniform_int_distribution"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> </template><description><para>The class template <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution">uniform_int_distribution</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random integer value uniformly distributed in the set of integers {min, min+1, min+2, ..., max}.</para><para>The template parameter IntType shall denote an integer-like value type. </para></description><class id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1a68ed044deea521ca4112865f3bcb7712" name="distribution_type"><type><classname>uniform_int_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1a3af971979dff4291176db5875c665c17" specifiers="explicit"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>(std::numeric_limits< IntType >::max)()</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution">uniform_int_distribution</link>.</para><para>Requires min <= max </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1ad845727a9d70528ea6ba59ab9cf69e9e" name="a" cv="const"><type>IntType</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1a1699ba1146701a98f387d555dc17dfe9" name="b" cv="const"><type>IntType</type><description><para>Returns the maximum value of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a2980cf006c5d67354b5c11ff0ef417fb" name="input_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a2ace70d1f90a34915a868e211e8ed27f" name="result_type"><type>IntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a0b718de9fadee1ac1701f26d856c7ff7" specifiers="explicit"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>(std::numeric_limits< IntType >::max)()</default></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution">uniform_int_distribution</link>. <computeroutput>min</computeroutput> and <computeroutput>max</computeroutput> are the parameters of the distribution.</para><para>Requires: min <= max </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a6cf07447bd998872883e437874440f5e" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution">uniform_int_distribution</link> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1ade608fb3f79d75617e1bbfc1e533f5c2" name="min" cv="const"><type>IntType</type><description><para>Returns the minimum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a7b059b8e0d92f51643b115cf76ba836d" name="max" cv="const"><type>IntType</type><description><para>Returns the maximum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1aa9c47ba3a083ddc43dae736bc700f5ba" name="a" cv="const"><type>IntType</type><description><para>Returns the minimum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a27dade5f2de86da163453a45376179a6" name="b" cv="const"><type>IntType</type><description><para>Returns the maximum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a96ae30ddfe3839045be020b9c679a183" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a6087f74b23d22e009218beab4c93e49c" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a92950c72b0233d55526c1997ffd8b52c" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a006bebaf735a92a0b46c8b8f2f1a46ae" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns an integer uniformly distributed in the range [min, max]. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a180edfe0e1120fee7f1fd89d929e063e" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns an integer uniformly distributed in the range [param.a(), param.b()]. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a2fe46416e04f468896abfb79ca425fcd" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1ad21aeb91b4125ef70b4f8c70d4b81771" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a37e6156d159d627880a2b53a94a56869" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__int__distribution_1a39a23f9b11d06e8dcf125ed0bf310fb8" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_int_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.uniform__on__sphere_8hpp" name="boost/random/uniform_on_sphere.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1uniform__on__sphere" name="uniform_on_sphere"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> <template-type-parameter name="Cont"><default>std::vector<RealType></default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1uniform__on__sphere">uniform_on_sphere</link> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . Such a distribution produces random numbers uniformly distributed on the unit sphere of arbitrary dimension <computeroutput>dim</computeroutput>. The <computeroutput>Cont</computeroutput> template parameter must be a STL-like container type with begin and end operations returning non-const ForwardIterators of type <computeroutput>Cont::iterator</computeroutput>. </para></description><class id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1aad2c0a881f80f904c3824d547734e8d4" name="distribution_type"><type><classname>uniform_on_sphere</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1a76608387e211817842e24a5dee89095e" specifiers="explicit"><parameter name="dim"><paramtype>int</paramtype><default>2</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1uniform__on__sphere">uniform_on_sphere</link> distribution, given the dimension of the sphere. </para></description></constructor> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1ac60f50804e338844b44c3071e44ad629" name="dim" cv="const"><type>int</type><description><para>Returns the dimension of the sphere. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1uniform__on__sphere_1acfbe637edfe345bf0dd5c52660695ba7" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1uniform__on__sphere_1a2be1e786cdc5bd391eae99cd186f257c" name="result_type"><type>Cont</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1uniform__on__sphere_1abbcd34dbe2e702244f2cce4c2b4bfe34" specifiers="explicit"><parameter name="dim"><paramtype>int</paramtype><default>2</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__on__sphere">uniform_on_sphere</link></computeroutput> distribution. <computeroutput>dim</computeroutput> is the dimension of the sphere.</para><para>Requires: dim >= 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1uniform__on__sphere_1a95bf3ec53570a281671e0168af5ff9e7" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__on__sphere">uniform_on_sphere</link></computeroutput> distribution from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1afc6657ee6813cc0aabb97f29faea91ce" name="dim" cv="const"><type>int</type><description><para>Returns the dimension of the sphere. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1a085e3b0f59e091e63645a2353dbb7e05" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1af77ca3b07f10297bd728a0c6578ee9dc" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1a535f72c87dbe7c4a8d671979f314e509" name="min" cv="const"><type>result_type</type><description><para>Returns the smallest value that the distribution can produce. Note that this is required to approximate the standard library's requirements. The behavior is defined according to lexicographical comparison so that for a container type of std::vector, dist.min() <= x <= dist.max() where x is any value produced by the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1ac10476fa30d48a4676e1dd8ef5c519ea" name="max" cv="const"><type>result_type</type><description><para>Returns the largest value that the distribution can produce. Note that this is required to approximate the standard library's requirements. The behavior is defined according to lexicographical comparison so that for a container type of std::vector, dist.min() <= x <= dist.max() where x is any value produced by the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1ae3034a9af0b9dfac16af481942253026" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1a1e928e9887af63eb7355875b08cd50e6" name="operator()"><type>const result_type &</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a point uniformly distributed over the surface of a sphere of dimension <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1afc6657ee6813cc0aabb97f29faea91ce">dim()</link>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1aa6dfda6a83cffc49afc8e149dc21c13f" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a point uniformly distributed over the surface of a sphere of dimension param.dim(). </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1aeea5d1a0b327f51369c8fe2557a7ffa0" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="sd"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1a707a0efa9b1ece50bf8a64cdcc8f5cba" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="sd"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1a2d18198f918ec4c11ebb30f934fa5bd5" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values, given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__on__sphere_1ad63d1bd40a14b022b7e5e3171247b51c" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values, given equal generators. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere" name="uniform_on_sphere"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> <template-type-parameter name="Cont"><default>std::vector<RealType></default></template-type-parameter> </template><description><para>Instantiations of class template <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere">uniform_on_sphere</link> model a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . Such a distribution produces random numbers uniformly distributed on the unit sphere of arbitrary dimension <computeroutput>dim</computeroutput>. The <computeroutput>Cont</computeroutput> template parameter must be a STL-like container type with begin and end operations returning non-const ForwardIterators of type <computeroutput>Cont::iterator</computeroutput>. </para></description><class id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1aad2c0a881f80f904c3824d547734e8d4" name="distribution_type"><type><classname>uniform_on_sphere</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1a76608387e211817842e24a5dee89095e" specifiers="explicit"><parameter name="dim"><paramtype>int</paramtype><default>2</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere">uniform_on_sphere</link> distribution, given the dimension of the sphere. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1ac60f50804e338844b44c3071e44ad629" name="dim" cv="const"><type>int</type><description><para>Returns the dimension of the sphere. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1acfbe637edfe345bf0dd5c52660695ba7" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a2be1e786cdc5bd391eae99cd186f257c" name="result_type"><type>Cont</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1abbcd34dbe2e702244f2cce4c2b4bfe34" specifiers="explicit"><parameter name="dim"><paramtype>int</paramtype><default>2</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere">uniform_on_sphere</link></computeroutput> distribution. <computeroutput>dim</computeroutput> is the dimension of the sphere.</para><para>Requires: dim >= 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a95bf3ec53570a281671e0168af5ff9e7" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere">uniform_on_sphere</link></computeroutput> distribution from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1afc6657ee6813cc0aabb97f29faea91ce" name="dim" cv="const"><type>int</type><description><para>Returns the dimension of the sphere. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a085e3b0f59e091e63645a2353dbb7e05" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1af77ca3b07f10297bd728a0c6578ee9dc" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a535f72c87dbe7c4a8d671979f314e509" name="min" cv="const"><type>result_type</type><description><para>Returns the smallest value that the distribution can produce. Note that this is required to approximate the standard library's requirements. The behavior is defined according to lexicographical comparison so that for a container type of std::vector, dist.min() <= x <= dist.max() where x is any value produced by the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1ac10476fa30d48a4676e1dd8ef5c519ea" name="max" cv="const"><type>result_type</type><description><para>Returns the largest value that the distribution can produce. Note that this is required to approximate the standard library's requirements. The behavior is defined according to lexicographical comparison so that for a container type of std::vector, dist.min() <= x <= dist.max() where x is any value produced by the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1ae3034a9af0b9dfac16af481942253026" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a1e928e9887af63eb7355875b08cd50e6" name="operator()"><type>const result_type &</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a point uniformly distributed over the surface of a sphere of dimension <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1afc6657ee6813cc0aabb97f29faea91ce">dim()</link>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1aa6dfda6a83cffc49afc8e149dc21c13f" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a point uniformly distributed over the surface of a sphere of dimension param.dim(). </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1aeea5d1a0b327f51369c8fe2557a7ffa0" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="sd"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a707a0efa9b1ece50bf8a64cdcc8f5cba" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="sd"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1a2d18198f918ec4c11ebb30f934fa5bd5" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values, given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__on__sphere_1ad63d1bd40a14b022b7e5e3171247b51c" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_on_sphere</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values, given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.uniform__real__distribution_8hpp" name="boost/random/uniform_real_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution" name="uniform_real_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The class template <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution">uniform_real_distribution</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random floating-point value uniformly distributed in the range [min..max). </para></description><class id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1a5f29211140596681a7b5e92e9900078e" name="distribution_type"><type><classname>uniform_real_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1a187fb9a969f7a01125f37debd7fa56b1" specifiers="explicit"><parameter name="min"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="max"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs the parameters of a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution">uniform_real_distribution</link>.</para><para>Requires min < max </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1aa28021d91915b81737d5a1d8458a0173" name="a" cv="const"><type>RealType</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1a88b8c9041673813f2fcab1c1d8faf3f7" name="b" cv="const"><type>RealType</type><description><para>Returns the maximum value of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a2c78bb9b9618a80d3b8fe184585f7bc7" name="input_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a1f76a8917abf29ba27f76688504cf33e" name="result_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1abf59bc217a5fa6939ca6f793f84389a5" specifiers="explicit"><parameter name="min"><paramtype>RealType</paramtype><default>0.0</default></parameter><parameter name="max"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution">uniform_real_distribution</link>. <computeroutput>min</computeroutput> and <computeroutput>max</computeroutput> are the parameters of the distribution.</para><para>Requires: min < max </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1ac8f6976d726f9f5487e433463e75222e" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution">uniform_real_distribution</link> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1afdce7df2ee4ed165dfae381bc8d1acfb" name="min" cv="const"><type>RealType</type><description><para>Returns the minimum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a03df027795e489a994b34291a74891a1" name="max" cv="const"><type>RealType</type><description><para>Returns the maximum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a8482c4fffa2c5ccac429a6f15ba8a092" name="a" cv="const"><type>RealType</type><description><para>Returns the minimum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a7302ac6ae51f9ab01109edb8491ce4b0" name="b" cv="const"><type>RealType</type><description><para>Returns the maximum value of the distribution </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a17f1ef585b0649bb7f360d21c146060c" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a2a9fd77de7c8ae1f3565fadbfcefcf65" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1aa8217548c81e813924021e35fb61ef1a" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a383609952eca2852bf5c3df969795732" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [min, max). </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a36b2da50f684e94d4ac8e80e18300c9b" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [param.a(), param.b()). </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1acb83fe73219250fb263a33dd508ca54b" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1add4e53c7a5fe5e1bdb66703d4e63a634" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a5467d0d91c25a0100a98e588615c0f7e" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__real__distribution_1a8f400cd66ef3aa25cb9796e0fb7983b1" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_real_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.uniform__smallint_8hpp" name="boost/random/uniform_smallint.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1uniform__smallint" name="uniform_smallint"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> </template><description><para>The distribution function <link linkend="doxygen.headers.classboost_1_1uniform__smallint">uniform_smallint</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random integer value uniformly distributed in the set of integer numbers {min, min+1, min+2, ..., max}. It assumes that the desired range (max-min+1) is small compared to the range of the underlying source of random numbers and thus makes no attempt to limit quantization errors.</para><para>Let <inlineequation><alt>$r_{\mathtt{out}} = (\mbox{max}-\mbox{min}+1)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_38.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}} = (\mbox{max}-\mbox{min}+1)$</phrase></textobject></inlinemediaobject></inlineequation> the desired range of integer numbers, and let <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> be the range of the underlying source of random numbers. Then, for the uniform distribution, the theoretical probability for any number i in the range <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation> will be <inlineequation><alt>$\displaystyle p_{\mathtt{out}}(i) = \frac{1}{r_{\mathtt{out}}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_41.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out}}(i) = \frac{1}{r_{\mathtt{out}}}$</phrase></textobject></inlinemediaobject></inlineequation>. Likewise, assume a uniform distribution on <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> for the underlying source of random numbers, i.e. <inlineequation><alt>$\displaystyle p_{\mathtt{base}}(i) = \frac{1}{r_{\mathtt{base}}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_42.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{base}}(i) = \frac{1}{r_{\mathtt{base}}}$</phrase></textobject></inlinemediaobject></inlineequation>. Let <inlineequation><alt>$p_{\mathtt{out\_s}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_43.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out\_s}}(i)$</phrase></textobject></inlinemediaobject></inlineequation> denote the random distribution generated by <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__smallint">uniform_smallint</link></computeroutput>. Then the sum over all i in <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation> of <inlineequation><alt>$\displaystyle \left(\frac{p_{\mathtt{out\_s}}(i)}{p_{\mathtt{out}}(i)} - 1\right)^2$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_44.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left(\frac{p_{\mathtt{out\_s}}(i)}{p_{\mathtt{out}}(i)} - 1\right)^2$</phrase></textobject></inlinemediaobject></inlineequation> shall not exceed <inlineequation><alt>$\displaystyle \frac{r_{\mathtt{out}}}{r_{\mathtt{base}}^2} (r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_45.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_{\mathtt{out}}}{r_{\mathtt{base}}^2} (r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation>.</para><para>The template parameter IntType shall denote an integer-like value type.</para><para> <note><para> The property above is the square sum of the relative differences in probabilities between the desired uniform distribution <inlineequation><alt>$p_{\mathtt{out}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_46.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out}}(i)$</phrase></textobject></inlinemediaobject></inlineequation> and the generated distribution <inlineequation><alt>$p_{\mathtt{out\_s}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_43.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out\_s}}(i)$</phrase></textobject></inlinemediaobject></inlineequation>. The property can be fulfilled with the calculation <inlineequation><alt>$(\mbox{base\_rng} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_47.png"/></imageobject><textobject role="tex"><phrase>$(\mbox{base\_rng} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation>, as follows: Let <inlineequation><alt>$r = r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_48.png"/></imageobject><textobject role="tex"><phrase>$r = r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. The base distribution on <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> is folded onto the range <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. The numbers i < r have assigned <inlineequation><alt>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor+1$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_49.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor+1$</phrase></textobject></inlinemediaobject></inlineequation> numbers of the base distribution, the rest has only <inlineequation><alt>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_50.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor$</phrase></textobject></inlinemediaobject></inlineequation>. Therefore, <inlineequation><alt>$\displaystyle p_{\mathtt{out\_s}}(i) = \left(\left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor+1\right) / r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_51.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out\_s}}(i) = \left(\left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor+1\right) / r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> for i < r and <inlineequation><alt>$\displaystyle p_{\mathtt{out\_s}}(i) = \left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor/r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_52.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out\_s}}(i) = \left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor/r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> otherwise. Substituting this in the above sum formula leads to the desired result. </para></note> </para><para>Note: The upper bound for <inlineequation><alt>$(r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_53.png"/></imageobject><textobject role="tex"><phrase>$(r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation> is <inlineequation><alt>$\displaystyle \frac{r_{\mathtt{out}}^2}{4}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_54.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_{\mathtt{out}}^2}{4}$</phrase></textobject></inlinemediaobject></inlineequation>. Regarding the upper bound for the square sum of the relative quantization error of <inlineequation><alt>$\displaystyle \frac{r_\mathtt{out}^3}{4r_{\mathtt{base}}^2}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_55.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_\mathtt{out}^3}{4r_{\mathtt{base}}^2}$</phrase></textobject></inlinemediaobject></inlineequation>, it seems wise to either choose <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> so that <inlineequation><alt>$r_{\mathtt{base}} > 10r_{\mathtt{out}}^2$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_56.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}} > 10r_{\mathtt{out}}^2$</phrase></textobject></inlinemediaobject></inlineequation> or ensure that <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> is divisible by <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><class id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1a7428f02514f684f7de5b24ddbedc5d19" name="distribution_type"><type><classname>uniform_smallint</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1a95f81bea70be57ffd3ac1b1d644f0d83"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>9</default></parameter><description><para>constructs the parameters of a <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__smallint">uniform_smallint</link></computeroutput> distribution. </para></description></constructor> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1a9e93d1eb48476d44c11e9e5fd0ddcaf6" name="a" cv="const"><type>IntType</type><description><para>Returns the minimum value. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1acd7575c48da9fd69087621850178141f" name="b" cv="const"><type>IntType</type><description><para>Returns the maximum value. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1uniform__smallint_1a8badaeb9948a3bb1f19ccaf1cd924a70" name="input_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1uniform__smallint_1a4ee5c4d29311574f6520eff2ba8cb026" name="result_type"><type>IntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1uniform__smallint_1aeee05f2fbb124a53e324f8242bc040ef" specifiers="explicit"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>9</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__smallint">uniform_smallint</link></computeroutput>. <computeroutput>min</computeroutput> and <computeroutput>max</computeroutput> are the lower and upper bounds of the output range, respectively. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1uniform__smallint_1a7d8a5e437c764478cabcbc45b4df9b11" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1uniform__smallint">uniform_smallint</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1uniform__smallint_1aca888905a25eb34f91c8d828870f621c" name="a" cv="const"><type>result_type</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a4748349f2c7af79e989dd3973b585290" name="b" cv="const"><type>result_type</type><description><para>Returns the maximum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11" name="min" cv="const"><type>result_type</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4" name="max" cv="const"><type>result_type</type><description><para>Returns the maximum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1aec0d136cfafc3a3e02824be4e5e7bd3a" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1aad65b1743eec84ebb04a7e313eca20a8" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a9b57696c17992992ede493e6f80f7561" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1af400c824a0bf9e1f297ece1cd345e399" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [<link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11">min()</link>, <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4">max()</link>]. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1aa1786e6e93f44b79b6cd4bddc3ae7fe4" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [param.a(), param.b()]. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1uniform__smallint_1abfedd3cad3924a6ff6306cefe70464b1" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a4472bc2906af87f5911ac36421399d0e" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1ab46d2b89e75259e73342a61b7c70ab4e" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1uniform__smallint_1a95124e9d9e630ec50896ea205602829a" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class><namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1uniform__smallint" name="uniform_smallint"><template> <template-type-parameter name="IntType"><default>int</default></template-type-parameter> </template><description><para>The distribution function <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint">uniform_smallint</link> models a <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . On each invocation, it returns a random integer value uniformly distributed in the set of integer numbers {min, min+1, min+2, ..., max}. It assumes that the desired range (max-min+1) is small compared to the range of the underlying source of random numbers and thus makes no attempt to limit quantization errors.</para><para>Let <inlineequation><alt>$r_{\mathtt{out}} = (\mbox{max}-\mbox{min}+1)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_38.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}} = (\mbox{max}-\mbox{min}+1)$</phrase></textobject></inlinemediaobject></inlineequation> the desired range of integer numbers, and let <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> be the range of the underlying source of random numbers. Then, for the uniform distribution, the theoretical probability for any number i in the range <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation> will be <inlineequation><alt>$\displaystyle p_{\mathtt{out}}(i) = \frac{1}{r_{\mathtt{out}}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_41.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out}}(i) = \frac{1}{r_{\mathtt{out}}}$</phrase></textobject></inlinemediaobject></inlineequation>. Likewise, assume a uniform distribution on <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> for the underlying source of random numbers, i.e. <inlineequation><alt>$\displaystyle p_{\mathtt{base}}(i) = \frac{1}{r_{\mathtt{base}}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_42.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{base}}(i) = \frac{1}{r_{\mathtt{base}}}$</phrase></textobject></inlinemediaobject></inlineequation>. Let <inlineequation><alt>$p_{\mathtt{out\_s}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_43.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out\_s}}(i)$</phrase></textobject></inlinemediaobject></inlineequation> denote the random distribution generated by <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint">uniform_smallint</link></computeroutput>. Then the sum over all i in <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation> of <inlineequation><alt>$\displaystyle \left(\frac{p_{\mathtt{out\_s}}(i)}{p_{\mathtt{out}}(i)} - 1\right)^2$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_44.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left(\frac{p_{\mathtt{out\_s}}(i)}{p_{\mathtt{out}}(i)} - 1\right)^2$</phrase></textobject></inlinemediaobject></inlineequation> shall not exceed <inlineequation><alt>$\displaystyle \frac{r_{\mathtt{out}}}{r_{\mathtt{base}}^2} (r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_45.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_{\mathtt{out}}}{r_{\mathtt{base}}^2} (r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation>.</para><para>The template parameter IntType shall denote an integer-like value type.</para><para> <note><para> The property above is the square sum of the relative differences in probabilities between the desired uniform distribution <inlineequation><alt>$p_{\mathtt{out}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_46.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out}}(i)$</phrase></textobject></inlinemediaobject></inlineequation> and the generated distribution <inlineequation><alt>$p_{\mathtt{out\_s}}(i)$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_43.png"/></imageobject><textobject role="tex"><phrase>$p_{\mathtt{out\_s}}(i)$</phrase></textobject></inlinemediaobject></inlineequation>. The property can be fulfilled with the calculation <inlineequation><alt>$(\mbox{base\_rng} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_47.png"/></imageobject><textobject role="tex"><phrase>$(\mbox{base\_rng} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation>, as follows: Let <inlineequation><alt>$r = r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_48.png"/></imageobject><textobject role="tex"><phrase>$r = r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. The base distribution on <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> is folded onto the range <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. The numbers i < r have assigned <inlineequation><alt>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor+1$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_49.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor+1$</phrase></textobject></inlinemediaobject></inlineequation> numbers of the base distribution, the rest has only <inlineequation><alt>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_50.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor$</phrase></textobject></inlinemediaobject></inlineequation>. Therefore, <inlineequation><alt>$\displaystyle p_{\mathtt{out\_s}}(i) = \left(\left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor+1\right) / r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_51.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out\_s}}(i) = \left(\left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor+1\right) / r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> for i < r and <inlineequation><alt>$\displaystyle p_{\mathtt{out\_s}}(i) = \left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor/r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_52.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p_{\mathtt{out\_s}}(i) = \left\lfloor\frac{r_{\mathtt{base}}} {r_{\mathtt{out}}}\right\rfloor/r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> otherwise. Substituting this in the above sum formula leads to the desired result. </para></note> </para><para>Note: The upper bound for <inlineequation><alt>$(r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_53.png"/></imageobject><textobject role="tex"><phrase>$(r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}) (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})$</phrase></textobject></inlinemediaobject></inlineequation> is <inlineequation><alt>$\displaystyle \frac{r_{\mathtt{out}}^2}{4}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_54.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_{\mathtt{out}}^2}{4}$</phrase></textobject></inlinemediaobject></inlineequation>. Regarding the upper bound for the square sum of the relative quantization error of <inlineequation><alt>$\displaystyle \frac{r_\mathtt{out}^3}{4r_{\mathtt{base}}^2}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_55.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle \frac{r_\mathtt{out}^3}{4r_{\mathtt{base}}^2}$</phrase></textobject></inlinemediaobject></inlineequation>, it seems wise to either choose <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> so that <inlineequation><alt>$r_{\mathtt{base}} > 10r_{\mathtt{out}}^2$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_56.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}} > 10r_{\mathtt{out}}^2$</phrase></textobject></inlinemediaobject></inlineequation> or ensure that <inlineequation><alt>$r_{\mathtt{base}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_39.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{base}}$</phrase></textobject></inlinemediaobject></inlineequation> is divisible by <inlineequation><alt>$r_{\mathtt{out}}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_40.png"/></imageobject><textobject role="tex"><phrase>$r_{\mathtt{out}}$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><class id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a7428f02514f684f7de5b24ddbedc5d19" name="distribution_type"><type><classname>uniform_smallint</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a95f81bea70be57ffd3ac1b1d644f0d83"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>9</default></parameter><description><para>constructs the parameters of a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint">uniform_smallint</link></computeroutput> distribution. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a9e93d1eb48476d44c11e9e5fd0ddcaf6" name="a" cv="const"><type>IntType</type><description><para>Returns the minimum value. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1acd7575c48da9fd69087621850178141f" name="b" cv="const"><type>IntType</type><description><para>Returns the maximum value. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes the parameters to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads the parameters from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are equal. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a8badaeb9948a3bb1f19ccaf1cd924a70" name="input_type"><type>IntType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4ee5c4d29311574f6520eff2ba8cb026" name="result_type"><type>IntType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aeee05f2fbb124a53e324f8242bc040ef" specifiers="explicit"><parameter name="min"><paramtype>IntType</paramtype><default>0</default></parameter><parameter name="max"><paramtype>IntType</paramtype><default>9</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint">uniform_smallint</link></computeroutput>. <computeroutput>min</computeroutput> and <computeroutput>max</computeroutput> are the lower and upper bounds of the output range, respectively. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a7d8a5e437c764478cabcbc45b4df9b11" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint">uniform_smallint</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aca888905a25eb34f91c8d828870f621c" name="a" cv="const"><type>result_type</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4748349f2c7af79e989dd3973b585290" name="b" cv="const"><type>result_type</type><description><para>Returns the maximum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11" name="min" cv="const"><type>result_type</type><description><para>Returns the minimum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4" name="max" cv="const"><type>result_type</type><description><para>Returns the maximum value of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aec0d136cfafc3a3e02824be4e5e7bd3a" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aad65b1743eec84ebb04a7e313eca20a8" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a9b57696c17992992ede493e6f80f7561" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1af400c824a0bf9e1f297ece1cd345e399" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [<link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11">min()</link>, <link linkend="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4">max()</link>]. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aa1786e6e93f44b79b6cd4bddc3ae7fe4" name="operator()" cv="const"><type>result_type</type><template> <template-type-parameter name="Engine"/> </template><parameter name="eng"><paramtype>Engine &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a value uniformly distributed in the range [param.a(), param.b()]. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1abfedd3cad3924a6ff6306cefe70464b1" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Writes the distribution to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4472bc2906af87f5911ac36421399d0e" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="ud"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Reads the distribution from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1ab46d2b89e75259e73342a61b7c70ab4e" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Returns true if the two distributions will produce identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a95124e9d9e630ec50896ea205602829a" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>uniform_smallint</classname> &</paramtype></parameter><description><para>Returns true if the two distributions may produce different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.variate__generator_8hpp" name="boost/random/variate_generator.hpp"> <namespace name="boost"> <class id="doxygen.headers.classboost_1_1variate__generator" name="variate_generator"><template> <template-type-parameter name="Engine"/> <template-type-parameter name="Distribution"/> </template><description><para>A random variate generator is used to join a random number generator together with a random number distribution. Boost.Random provides a vast choice of <link linkend="boost_random.reference.generators">generators</link> as well as <link linkend="boost_random.reference.distributions">distributions</link> .</para><para>The argument for the template parameter Engine shall be of the form U, U&, or U*, where U models a <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> . Then, the member engine_value_type names U (not the pointer or reference to U).</para><para>Specializations of <computeroutput><link linkend="doxygen.headers.classboost_1_1variate__generator">variate_generator</link></computeroutput> satisfy the requirements of CopyConstructible. They also satisfy the requirements of Assignable unless the template parameter Engine is of the form U&.</para><para>The complexity of all functions specified in this section is constant. No function described in this section except the constructor throws an exception. </para></description><typedef id="doxygen.headers.classboost_1_1variate__generator_1a9438fb8e2280287b562f117ea5e55e2e" name="engine_value_type"><type>helper_type::value_type</type></typedef> <typedef id="doxygen.headers.classboost_1_1variate__generator_1af0068ea7a8d6dce5ed6d94843e7facfd" name="engine_type"><type>Engine</type></typedef> <typedef id="doxygen.headers.classboost_1_1variate__generator_1a9fecb3515a93c2b2bd6f2216477745fb" name="distribution_type"><type>Distribution</type></typedef> <typedef id="doxygen.headers.classboost_1_1variate__generator_1ae3687096fa97fcfbe7ed9ecdbecd151c" name="result_type"><type>Distribution::result_type</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1variate__generator_1ae989119e9f10d5186904c764ed297903"><parameter name="e"><paramtype>Engine</paramtype></parameter><parameter name="d"><paramtype>Distribution</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1variate__generator">variate_generator</link></computeroutput> object with the associated <link linkend="boost_random.reference.concepts.uniform_random_number_generator">uniform random number generator</link> eng and the associated <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> d.</para><para>Throws: If and what the copy constructor of Engine or Distribution throws. </para></description></constructor> <method id="doxygen.headers.classboost_1_1variate__generator_1a601b538d41929c2021a779a0b7124100" name="operator()"><type>result_type</type><description><para>Returns: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>(<link linkend="doxygen.headers.classboost_1_1variate__generator_1afc2c6e74e2f47e635a0b8b4821403021">engine()</link>) </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1a2dcbdd2657d0f910f175be679fefc493" name="operator()"><type>result_type</type><template> <template-type-parameter name="T"/> </template><parameter name="value"><paramtype>const T &</paramtype></parameter><description><para>Returns: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>(<link linkend="doxygen.headers.classboost_1_1variate__generator_1afc2c6e74e2f47e635a0b8b4821403021">engine()</link>, value). </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1afc2c6e74e2f47e635a0b8b4821403021" name="engine"><type>engine_value_type &</type><description><para>Returns: A reference to the associated uniform random number generator. </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1a03c74a9f40100182f3f00340cb251a0b" name="engine" cv="const"><type>const engine_value_type &</type><description><para>Returns: A reference to the associated uniform random number generator. </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf" name="distribution"><type>distribution_type &</type><description><para>Returns: A reference to the associated <link linkend="boost_random.reference.concepts.random_distribution">random distribution</link> . </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1a2477c4568e047b59c764d7446b6c962f" name="distribution" cv="const"><type>const distribution_type &</type><description><para>Returns: A reference to the associated random distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1a0d26e21dcffc09d8f119d0dbd5fafcc2" name="min" cv="const"><type>result_type</type><description><para>Precondition: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>.<link linkend="doxygen.headers.classboost_1_1variate__generator_1a0d26e21dcffc09d8f119d0dbd5fafcc2">min()</link> is well-formed</para><para>Returns: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>.<link linkend="doxygen.headers.classboost_1_1variate__generator_1a0d26e21dcffc09d8f119d0dbd5fafcc2">min()</link> </para></description></method> <method id="doxygen.headers.classboost_1_1variate__generator_1a2831fd15756e2e0d0cf1e6b67c14232e" name="max" cv="const"><type>result_type</type><description><para>Precondition: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>.<link linkend="doxygen.headers.classboost_1_1variate__generator_1a2831fd15756e2e0d0cf1e6b67c14232e">max()</link> is well-formed</para><para>Returns: <link linkend="doxygen.headers.classboost_1_1variate__generator_1ac61501712493684e8a1c96caae53e6cf">distribution()</link>.<link linkend="doxygen.headers.classboost_1_1variate__generator_1a2831fd15756e2e0d0cf1e6b67c14232e">max()</link> </para></description></method> </method-group> </class></namespace> </header> <header id="doxygen.headers.weibull__distribution_8hpp" name="boost/random/weibull_distribution.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1weibull__distribution" name="weibull_distribution"><template> <template-type-parameter name="RealType"><default>double</default></template-type-parameter> </template><description><para>The Weibull distribution is a real valued distribution with two parameters a and b, producing values >= 0.</para><para>It has <inlineequation><alt>$\displaystyle p(x) = \frac{a}{b}\left(\frac{x}{b}\right)^{a-1}e^{-\left(\frac{x}{b}\right)^a}$</alt><inlinemediaobject><imageobject role="html"><imagedata format="PNG" fileref="images/random//form_57.png"/></imageobject><textobject role="tex"><phrase>$\displaystyle p(x) = \frac{a}{b}\left(\frac{x}{b}\right)^{a-1}e^{-\left(\frac{x}{b}\right)^a}$</phrase></textobject></inlinemediaobject></inlineequation>. </para></description><class id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type" name="param_type"><typedef id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1a4902dffae2ac08b69421263f6f3ced55" name="distribution_type"><type><classname>weibull_distribution</classname></type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1a181812188809d84335754fdb017ab3fe" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>1.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type">param_type</link></computeroutput> from the "a" and "b" parameters of the distribution.</para><para>Requires: a > 0 && b > 0 </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1ae8f20aac4888052274cc1bcd0ab0edf0" name="a" cv="const"><type>RealType</type><description><para>Returns the "a" parameter of the distribtuion. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1a1726bdb638b3d9e2f2e825c17769172e" name="b" cv="const"><type>RealType</type><description><para>Returns the "b" parameter of the distribution. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type">param_type</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type">param_type</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the same. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns true if the two sets of parameters are the different. </para></description></method> </method-group> </class><typedef id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a5e805b73db2d4df7defadd59c305537d" name="result_type"><type>RealType</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a6d3a098ca558670f1f7c61df74f95656" name="input_type"><type>RealType</type></typedef> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a63866833864e0f75fdef831ba0250dd0" specifiers="explicit"><parameter name="a"><paramtype>RealType</paramtype><default>1.0</default></parameter><parameter name="b"><paramtype>RealType</paramtype><default>1.0</default></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> from its "a" and "b" parameters.</para><para>Requires: a > 0 && b > 0 </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1ab738a93c5963bcf81e60bd634c5b4c48" specifiers="explicit"><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> from its parameters. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a2401dd9ed65cb3143721b892d4edeaaf" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><description><para>Returns a random variate distributed according to the <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1ae3fddb6dd699b614938a283e5a4dfa36" name="operator()" cv="const"><type>RealType</type><template> <template-type-parameter name="URNG"/> </template><parameter name="urng"><paramtype>URNG &</paramtype></parameter><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Returns a random variate distributed accordint to the Weibull distribution with parameters specified by <computeroutput>param</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a156c283072136cb3bdc0235fe2e1e4be" name="a" cv="const"><type>RealType</type><description><para>Returns the "a" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a34f401c27ddff8a633d11c0bcd468341" name="b" cv="const"><type>RealType</type><description><para>Returns the "b" parameter of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1aa4a2d94231dec0157a221e679c4d7384" name="min" cv="const"><type>RealType</type><description><para>Returns the smallest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a9007f40ff92842b3af202220e2ac2622" name="max" cv="const"><type>RealType</type><description><para>Returns the largest value that the distribution can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1acfde02081d5b8e99684110636bb75aa0" name="param" cv="const"><type><classname>param_type</classname></type><description><para>Returns the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a85f7d4348b6b58cc15f00f818f0255ba" name="param"><type>void</type><parameter name="param"><paramtype>const <classname>param_type</classname> &</paramtype></parameter><description><para>Sets the parameters of the distribution. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a8de0f1fd646b94bd5843765bfed21377" name="reset"><type>void</type><description><para>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a7c41f3315f03a528b0eb6bd7960ebe53" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="wd"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><description><para>Writes a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1ac83b98174d20fc6fabdee8017a1e07d8" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="wd"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><description><para>Reads a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1a5a49df5da2fe77bfd91d77b891c5e974" name="operator=="><type>bool</type><parameter name="lhs"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> will return identical sequences of values given equal generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1weibull__distribution_1aa3edb00b623dc37a664b4ff1f1b47709" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>weibull_distribution</classname> &</paramtype></parameter><description><para>Returns true if the two instances of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1weibull__distribution">weibull_distribution</link></computeroutput> will return different sequences of values given equal generators. </para></description></method> </method-group> </class> </namespace> </namespace> </header> <header id="doxygen.headers.xor__combine_8hpp" name="boost/random/xor_combine.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine" name="xor_combine_engine"><template> <template-type-parameter name="URNG1"/> <template-nontype-parameter name="s1"><type>int</type></template-nontype-parameter> <template-type-parameter name="URNG2"/> <template-nontype-parameter name="s2"><type>int</type></template-nontype-parameter> </template><description><para>Instantiations of <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine">xor_combine_engine</link></computeroutput> model a <link linkend="boost_random.reference.concepts.pseudo_random_number_generator">pseudo-random number generator</link> . To produce its output it invokes each of the base generators, shifts their results and xors them together. </para></description><typedef id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a1cb8499be0ada792f518340d9da32669" name="base1_type"><type>URNG1</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a748f67ba7b3f76506efa30e60ca92b04" name="base2_type"><type>URNG2</type></typedef> <typedef id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1aaf6e7d2dd16099aeb86375bf99bb2c7a" name="result_type"><type>base1_type::result_type</type></typedef> <data-member id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a801c52c96c107bcacc7f8a60ff6516bc" name="has_fixed_range" specifiers="static"><type>const bool</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1abbacd3aece8148c7f944a59fe08b6268" name="shift1" specifiers="static"><type>const int</type></data-member> <data-member id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1afded5357a4bb91f180b5c0957bef1bf4" name="shift2" specifiers="static"><type>const int</type></data-member> <method-group name="public member functions"> <constructor id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a232a75e0421409c703eb01d35ac28014"><description><para>Constructors a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine">xor_combine_engine</link></computeroutput> by default constructing both base generators. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a9c445b710d34c7c0c02d0747b7853c49"><parameter name="rng1"><paramtype>const base1_type &</paramtype></parameter><parameter name="rng2"><paramtype>const base2_type &</paramtype></parameter><description><para>Constructs a <computeroutput>xor_combine</computeroutput> by copying two base generators. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1ab58a781f1bdc7b0114dc5a6541c2def0" specifiers="explicit"><parameter name="v"><paramtype>result_type</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine">xor_combine_engine</link></computeroutput>, seeding both base generators with <computeroutput>v</computeroutput>.</para><para> <warning><para> The exact algorithm used by this function may change in the future. </para></warning> </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a5ec519c4596ae79a00bdc7e1b57225fa" specifiers="explicit"><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine">xor_combine_engine</link></computeroutput>, seeding both base generators with values produced by <computeroutput>seq</computeroutput>. </para></description></constructor> <constructor id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a22c526781278815cb39da35c646aef33"><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>Constructs a <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine">xor_combine_engine</link></computeroutput>, seeding both base generators with values from the iterator range [first, last) and changes first to point to the element after the last one used. If there are not enough elements in the range to seed both generators, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></constructor> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a2dc3eec3e24edb7c23316109bb707939" name="seed"><type>void</type><description><para>Calls <computeroutput><link linkend="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a2dc3eec3e24edb7c23316109bb707939">seed()</link></computeroutput> for both base generators. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a39e1cc9033a92f0eef3932e6925cf0bd" name="seed"><type>void</type><parameter name="v"><paramtype>result_type</paramtype></parameter><description><para><computeroutput>seeds</computeroutput> both base generators with <computeroutput>v</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1ae54f3bfdb7e3e14bc7c5cee77daa676d" name="seed"><type>void</type><template> <template-type-parameter name="SeedSeq"/> </template><parameter name="seq"><paramtype>SeedSeq &</paramtype></parameter><description><para><computeroutput>seeds</computeroutput> both base generators with values produced by <computeroutput>seq</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a8922e08e2f9a1f799c922e04185ccf29" name="seed"><type>void</type><template> <template-type-parameter name="It"/> </template><parameter name="first"><paramtype>It &</paramtype></parameter><parameter name="last"><paramtype>It</paramtype></parameter><description><para>seeds both base generators with values from the iterator range [first, last) and changes first to point to the element after the last one used. If there are not enough elements in the range to seed both generators, throws <computeroutput>std::invalid_argument</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a8cc649b937a06d7cd8dba2a2f6e26973" name="base1" cv="const"><type>const base1_type &</type><description><para>Returns the first base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1ad534cfcf8f645b52ff0242a68cf22bc5" name="base2" cv="const"><type>const base2_type &</type><description><para>Returns the second base generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1aa45f4c3724b1b2729c79d6abdfe19588" name="operator()"><type>result_type</type><description><para>Returns the next value of the generator. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a8ac457fe45dcfbc79b27ed2c9cccc9b9" name="generate"><type>void</type><template> <template-type-parameter name="Iter"/> </template><parameter name="first"><paramtype>Iter</paramtype></parameter><parameter name="last"><paramtype>Iter</paramtype></parameter><description><para>Fills a range with random values </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a07391b1d14bf1b84fd7f8e65d91305ae" name="discard"><type>void</type><parameter name="z"><paramtype>boost::uintmax_t</paramtype></parameter><description><para>Advances the state of the generator by <computeroutput>z</computeroutput>. </para></description></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a92b0444937f4b7da6a55990921eef2d4" name="min" specifiers="static"><type>result_type</type><description><para>Returns the smallest value that the generator can produce. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a48b2dd3f07bd166e652692cf43889d48" name="max" specifiers="static"><type>result_type</type><description><para>Returns the largest value that the generator can produce. </para></description></method> </method-group> <method-group name="friend functions"> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a1b60c93a68df64770943ccc05a7eb807" name="operator<<"><type>std::basic_ostream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="os"><paramtype>std::basic_ostream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><description><para>Writes the textual representation of the generator to a <computeroutput>std::ostream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a58284e8ba6c1cba568f8a4e11a107069" name="operator>>"><type>std::basic_istream< CharT, Traits > &</type><template> <template-type-parameter name="CharT"/> <template-type-parameter name="Traits"/> </template><parameter name="is"><paramtype>std::basic_istream< CharT, Traits > &</paramtype></parameter><parameter name="s"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><description><para>Reads the textual representation of the generator from a <computeroutput>std::istream</computeroutput>. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1ad58401fa52edf6491d7cd77908438073" name="operator=="><type>bool</type><parameter name="x"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><parameter name="y"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce identical sequences. </para></description></method> <method id="doxygen.headers.classboost_1_1random_1_1xor__combine__engine_1a8d4451e1a95ff5ee168013e832bc6cac" name="operator!="><type>bool</type><parameter name="lhs"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>xor_combine_engine</classname> &</paramtype></parameter><description><para>Returns true if the two generators will produce different sequences. </para></description></method> </method-group> </class><data-member id="doxygen.headers.xor__combine_8hpp_1a829269f8c86f36ffd4819e9f8ce1b633" name="xor_combine_engine< URNG1, s1, URNG2, s2 >::has_fixed_range"><type>const bool</type></data-member> <data-member id="doxygen.headers.xor__combine_8hpp_1a1332a499c22739aae9305a7063d52159" name="xor_combine_engine< URNG1, s1, URNG2, s2 >::shift1"><type>const int</type></data-member> <data-member id="doxygen.headers.xor__combine_8hpp_1aa8c51cdb8dd0adb2481dd723fdf8d4bb" name="xor_combine_engine< URNG1, s1, URNG2, s2 >::shift2"><type>const int</type></data-member> </namespace> </namespace> </header> <header id="doxygen.headers.xoshiro_8hpp" name="boost/random/xoshiro.hpp"> <namespace name="boost"> <namespace name="random"> <class id="doxygen.headers.classboost_1_1random_1_1xoshiro128f" name="xoshiro128f"><description><para>This is xoshiro128+ 1.0, our best and fastest 32-bit generator for 32-bit floating-point numbers. We suggest to use its upper bits for floating-point generation, as it is slightly faster than xoshiro128**. It passes all tests we are aware of except for linearity tests, as the lowest four bits have low linear complexity, so if low linear complexity is not considered an issue (as it is usually the case) it can be used to generate 32-bit outputs, too.</para><para>We suggest to use a sign test to extract a random Boolean value, and right shifts to extract subsets of bits.</para><para>The state must be seeded so that it is not everywhere zero. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128f_1abcbef37343958cdc3e2c6dc24090e05d" name="next_int" cv="noexcept"><type>std::uint32_t</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128f_1ae1f47741cbfb4f322e9c523a498e0dab" name="next" cv="noexcept"><type>result_type</type></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128f_1a66003b28c9f20f444754c150db7b204c" name="min" cv="noexcept" specifiers="static"><type>constexpr</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128f_1aa192b341b057a7ca9455217c336c8b71" name="max" cv="noexcept" specifiers="static"><type>constexpr</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro128mm" name="xoshiro128mm"><description><para>This is xoshiro128** 1.1, one of our 32-bit all-purpose, rock-solid generators. It has excellent speed, a state size (128 bits) that is large enough for mild parallelism, and it passes all tests we are aware of.</para><para>Note that version 1.0 had mistakenly state_[0] instead of state_[1] as state word passed to the scrambler.</para><para>For generating just single-precision (i.e., 32-bit) floating-point numbers, xoshiro128+ is even faster.</para><para>The state must be seeded so that it is not everywhere zero. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128mm_1a47da88e5ec9510ccda803c4b6927899c" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro128pp" name="xoshiro128pp"><description><para>This is xoshiro128++ 1.0, one of our 32-bit all-purpose, rock-solid generators. It has excellent speed, a state size (128 bits) that is large enough for mild parallelism, and it passes all tests we are aware of.</para><para>For generating just single-precision (i.e., 32-bit) floating-point numbers, xoshiro128+ is even faster.</para><para>The state must be seeded so that it is not everywhere zero. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro128pp_1a70ef17451232ca2177aaf380d87871c5" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro256d" name="xoshiro256d"><description><para>This is xoshiro256+ 1.0, our best and fastest generator for floating-point numbers. We suggest to use its upper bits for floating-point generation, as it is slightly faster than xoshiro256++/xoshiro256**. It passes all tests we are aware of except for the lowest three bits, which might fail linearity tests (and just those), so if low linear complexity is not considered an issue (as it is usually the case) it can be used to generate 64-bit outputs, too. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256d_1af87f80dab76fe2ba62fba98d74263322" name="next_int" cv="noexcept"><type>std::uint64_t</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256d_1a4ac72c89ca55bdf929aa1b7482f463b3" name="next" cv="noexcept"><type>result_type</type></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256d_1a12e2c65cbbfdf6668f2631123612f909" name="min" cv="noexcept" specifiers="static"><type>constexpr</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256d_1ac404877bc04f45d40da2d5afbf81dcf2" name="max" cv="noexcept" specifiers="static"><type>constexpr</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro256mm" name="xoshiro256mm"><description><para>This is xoshiro256** 1.0, one of our all-purpose, rock-solid generators. It has excellent (sub-ns) speed, a state (256 bits) that is large enough for any parallel application, and it passes all tests we are aware of.</para><para>For generating just floating-point numbers, xoshiro256+ is even faster. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256mm_1a4f0a8afa406da3caf936007018cb5c56" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro256pp" name="xoshiro256pp"><description><para>This is xoshiro256++ 1.0, one of our all-purpose, rock-solid generators. It has excellent (sub-ns) speed, a state (256 bits) that is large enough for any parallel application, and it passes all tests we are aware of.</para><para>For generating just floating-point numbers, xoshiro256+ is even faster. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro256pp_1a710b6f30a84434d4019be3463441a35b" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro512d" name="xoshiro512d"><description><para>This is xoshiro512+ 1.0, our generator for floating-point numbers with increased state size. We suggest to use its upper bits for floating-point generation, as it is slightly faster than xoshiro512**. It passes all tests we are aware of except for the lowest three bits, which might fail linearity tests (and just those), so if low linear complexity is not considered an issue (as it is usually the case) it can be used to generate 64-bit outputs, too.</para><para>We suggest to use a sign test to extract a random Boolean value, and right shifts to extract subsets of bits.</para><para>The state must be seeded so that it is not everywhere zero. If you have a 64-bit seed, we suggest to seed a <link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link> generator and use its output to fill s. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512d_1a71a87ad220cb5b53e1cbd17414cf7f45" name="next_int" cv="noexcept"><type>std::uint64_t</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512d_1af56eb4dfc4413b4d33a35eb35e705562" name="next" cv="noexcept"><type>result_type</type></method> </method-group> <method-group name="public static functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512d_1a641caa4e7e6c79525400d8b6a5c485a7" name="min" cv="noexcept" specifiers="static"><type>constexpr</type></method> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512d_1af55d1fbfbcc2de19cb20a95e5ea27c75" name="max" cv="noexcept" specifiers="static"><type>constexpr</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro512mm" name="xoshiro512mm"><description><para>This is xoshiro512** 1.0, one of our all-purpose, rock-solid generators with increased state size. It has excellent (about 1ns) speed, a state (512 bits) that is large enough for any parallel application, and it passes all tests we are aware of.</para><para>For generating just floating-point numbers, xoshiro512+ is even faster.</para><para>The state must be seeded so that it is not everywhere zero. If you have a 64-bit seed, we suggest to seed a <link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link> generator and use its output to fill s. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512mm_1ac07e5fe0cb5ba73ddf6e6b8a4f7cf909" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class><class id="doxygen.headers.classboost_1_1random_1_1xoshiro512pp" name="xoshiro512pp"><description><para>This is xoshiro512++ 1.0, one of our all-purpose, rock-solid generators. It has excellent (about 1ns) speed, a state (512 bits) that is large enough for any parallel application, and it passes all tests we are aware of.</para><para>For generating just floating-point numbers, xoshiro512+ is even faster.</para><para>The state must be seeded so that it is not everywhere zero. If you have a 64-bit seed, we suggest to seed a <link linkend="doxygen.headers.classboost_1_1random_1_1splitmix64">splitmix64</link> generator and use its output to fill s. </para></description><method-group name="public member functions"> <method id="doxygen.headers.classboost_1_1random_1_1xoshiro512pp_1a95cc9b2e66caedde06fd8855af48e571" name="next" cv="noexcept"><type>result_type</type></method> </method-group> </class> </namespace> </namespace> </header> </library-reference>