Class template subtract_with_carry

Class template subtract_with_carry_engine

boost::random::subtract_with_carry_engine

Synopsis

// In header: <boost/random/subtract_with_carry.hpp>

template<typename IntType,  w,  s,  r> 
class subtract_with_carry_engine {
public:
  // types
  typedef  ;

  // construct/copy/destruct
  ();
  ();
  template<typename SeedSeq> ();
  template<typename It> (, );

  // public member functions
   ();
   ();
  template<typename SeedSeq>  ();
  template<typename It>  (, );
   ();
   ();
  template<typename It>  (, );

  // public static functions
   ();
   ();

  // friend functions
  template<typename CharT, typename Traits> 
     
    (, 
               );
  template<typename CharT, typename Traits> 
     
    (, 
               );
   (, 
                  );
   (, 
                  );

  // public data members
  static  word_size;
  static  long_lag;
  static  short_lag;
  static  default_seed;
  static  has_fixed_range;
  static  modulus;
};

Description

Instantiations of subtract_with_carry_engine model a pseudo-random number generator . The algorithm is described in

"A New Class of Random Number Generators", George Marsaglia and Arif Zaman, Annals of Applied Probability, Volume 1, Number 3 (1991), 462-480.

`subtract_with_carry_engine` public construct/copy/destruct

```
();
```
Constructs a new subtract_with_carry_engine and seeds it with the default seed.
```
( value);
```
Constructs a new subtract_with_carry_engine and seeds it with value.
```
template<typename SeedSeq> ( seq);
```
Constructs a new subtract_with_carry_engine and seeds it with values produced by seq.generate().
```
template<typename It> ( first,  last);
```
Constructs a new subtract_with_carry_engine 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 std::invalid_argument.

`subtract_with_carry_engine` public member functions

```
 ();
```
Seeds the generator with the default seed.
```
 ( value);
```
```
template<typename SeedSeq>  ( seq);
```
Seeds the generator with values produced by seq.generate().
```
template<typename It>  ( first,  last);
```
Seeds the generator with values from a range. Updates first 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 std::invalid_argument.
```
 ();
```
Returns the next value of the generator.
```
 ( z);
```
Advances the state of the generator by z.
```
template<typename It>  ( first,  last);
```
Fills a range with random values.

`subtract_with_carry_engine` public static functions

```
 ();
```
Returns the smallest value that the generator can produce.
```
 ();
```
Returns the largest value that the generator can produce.

`subtract_with_carry_engine` friend functions

template<typename CharT, typename Traits> 
   
  ( os, 
              f);

Writes a subtract_with_carry_engine to a std::ostream.

template<typename CharT, typename Traits> 
   
  ( is, 
              f);

Reads a subtract_with_carry_engine from a std::istream.

```
 ( x, 
                 y);
```
Returns true if the two generators will produce identical sequences of values.
```
 ( lhs, 
                 rhs);
```
Returns true if the two generators will produce different sequences of values.

Class template subtract_with_carry_engine

Synopsis

Description

subtract_with_carry_engine public construct/copy/destruct

subtract_with_carry_engine public member functions

subtract_with_carry_engine public static functions

subtract_with_carry_engine friend functions

`subtract_with_carry_engine` public construct/copy/destruct

`subtract_with_carry_engine` public member functions

`subtract_with_carry_engine` public static functions

`subtract_with_carry_engine` friend functions