doc/html/boost/random/inversive_con_idp709574400.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class template inversive_congruential_engine</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../boost_random/reference.html#header.boost.random.inversive_congruential_hpp" title="Header &lt;boost/random/inversive_congruential.hpp&gt;">
  10 <link rel="prev" href="independent_bits_engine.html" title="Class template independent_bits_engine">
  11 <link rel="next" href="hellekalek1995.html" title="Type definition hellekalek1995">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="independent_bits_engine.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.inversive_congruential_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="hellekalek1995.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.random.inversive_con_idp709574400"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template inversive_congruential_engine</span></h2>
  30 <p>boost::random::inversive_congruential_engine</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#header.boost.random.inversive_congruential_hpp" title="Header &lt;boost/random/inversive_congruential.hpp&gt;">boost/random/inversive_congruential.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IntType<span class="special">,</span> <span class="identifier">IntType</span> a<span class="special">,</span> <span class="identifier">IntType</span> b<span class="special">,</span> <span class="identifier">IntType</span> p<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="boost.random.inversive_con_idp709574400.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="inversive_con_idp709574400.html#boost.random.inversive_con_idp709574400construct-copy-destruct">construct/copy/destruct</a></span>
  42   <a class="link" href="inversive_con_idp709574400.html#idp709615440-bb"><span class="identifier">inversive_congruential_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">explicit</span> <a class="link" href="inversive_con_idp709574400.html#idp709617056-bb"><span class="identifier">inversive_congruential_engine</span></a><span class="special">(</span><span class="identifier">IntType</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="inversive_con_idp709574400.html#idp709620064-bb"><span class="identifier">inversive_congruential_engine</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a class="link" href="inversive_con_idp709574400.html#idp709623952-bb"><span class="identifier">inversive_congruential_engine</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="inversive_con_idp709574400.html#idp709590912-bb">public static functions</a></span>
  48   <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="inversive_con_idp709574400.html#idp709591472-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="inversive_con_idp709574400.html#idp709592592-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="inversive_con_idp709574400.html#idp709593872-bb">public member functions</a></span>
  52   <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709594432-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709595712-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">IntType</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709597904-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709601616-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
  56   <span class="identifier">IntType</span> <a class="link" href="inversive_con_idp709574400.html#idp709608064-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iter<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709609360-bb"><span class="identifier">generate</span></a><span class="special">(</span><span class="identifier">Iter</span><span class="special">,</span> <span class="identifier">Iter</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">void</span> <a class="link" href="inversive_con_idp709574400.html#idp709612864-bb"><span class="identifier">discard</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">)</span><span class="special">;</span>
  59
  60   <span class="comment">// <a class="link" href="inversive_con_idp709574400.html#idp709628704-bb">friend functions</a></span>
  61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  62     <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  63     <a class="link" href="inversive_con_idp709574400.html#idp709629264-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
  64                <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  66     <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  67     <a class="link" href="inversive_con_idp709574400.html#idp709634320-bb"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
  68                <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  69   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="inversive_con_idp709574400.html#idp709639376-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">,</span>
  70                          <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="inversive_con_idp709574400.html#idp709643008-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">,</span>
  72                          <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  73
  74   <span class="comment">// public data members</span>
  75   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_fixed_range</span><span class="special">;</span>
  76   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">result_type</span> <span class="identifier">multiplier</span><span class="special">;</span>
  77   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">result_type</span> <span class="identifier">increment</span><span class="special">;</span>
  78   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">result_type</span> <span class="identifier">modulus</span><span class="special">;</span>
  79   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">IntType</span> <span class="identifier">default_seed</span><span class="special">;</span>
  80 <span class="special">}</span><span class="special">;</span></pre></div>
  81 <div class="refsect1">
  82 <a name="idp498023168"></a><h2>Description</h2>
  83 <p>Instantiations of class template <code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code> model a  <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.pseudo_random_number_generator" title="Pseudo-Random Number Generator">pseudo-random number generator</a> . It uses the inversive congruential algorithm (ICG) described in</p>
  84 <p> </p>
  85 <div class="blockquote"><blockquote class="blockquote"><p>  "Inversive pseudorandom number generators: concepts, results and links", Peter Hellekalek, In: "Proceedings of the 1995 Winter Simulation
  86  Conference", C. Alexopoulos, K. Kang, W.R. Lilegdon, and D. Goldsman (editors), 1995, pp. 255-262. <a href="ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps" target="_top">ftp://random.mat.sbg.ac.at/pub/data/wsc95.ps</a>  </p></blockquote></div>
  87 <p> </p>
  88 <p>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.</p>
  89 <p>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.</p>
  90 <p> </p>
  91 <div class="note"><table border="0" summary="Note">
  92 <tr>
  93 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  94 <th align="left">Note</th>
  95 </tr>
  96 <tr><td align="left" valign="top"><p>  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.  </p></td></tr>
  97 </table></div>
  98 <p>  </p>
  99 <div class="refsect2">
 100 <a name="idp498030096"></a><h3>
 101 <a name="boost.random.inversive_con_idp709574400construct-copy-destruct"></a><code class="computeroutput">inversive_congruential_engine</code>
 102         public
 103        construct/copy/destruct</h3>
 104 <div class="orderedlist"><ol class="orderedlist" type="1">
 105 <li class="listitem">
 106 <pre class="literallayout"><a name="idp709615440-bb"></a><span class="identifier">inversive_congruential_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 107 <p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code>, seeding it with the default seed. </p>
 108 </li>
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp709617056-bb"></a><span class="identifier">inversive_congruential_engine</span><span class="special">(</span><span class="identifier">IntType</span> x0<span class="special">)</span><span class="special">;</span></pre>
 111 <p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code>, seeding it with <code class="computeroutput">x0</code>. </p>
 112 </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span>
 115   <span class="keyword">explicit</span> <a name="idp709620064-bb"></a><span class="identifier">inversive_congruential_engine</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span> seq<span class="special">)</span><span class="special">;</span></pre>
 116 <p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code>, seeding it with values produced by a call to <code class="computeroutput">seq.generate()</code>. </p>
 117 </li>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a name="idp709623952-bb"></a><span class="identifier">inversive_congruential_engine</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
 120 <p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code>, 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 <code class="computeroutput">std::invalid_argument</code>.</p>
 121 <p>first and last must be input iterators. </p>
 122 </li>
 123 </ol></div>
 124 </div>
 125 <div class="refsect2">
 126 <a name="idp498068736"></a><h3>
 127 <a name="idp709590912-bb"></a><code class="computeroutput">inversive_congruential_engine</code> public static functions</h3>
 128 <div class="orderedlist"><ol class="orderedlist" type="1">
 129 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="idp709591472-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 130 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="idp709592592-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 131 </ol></div>
 132 </div>
 133 <div class="refsect2">
 134 <a name="idp498080800"></a><h3>
 135 <a name="idp709593872-bb"></a><code class="computeroutput">inversive_congruential_engine</code> public member functions</h3>
 136 <div class="orderedlist"><ol class="orderedlist" type="1">
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="keyword">void</span> <a name="idp709594432-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 139 <p>Calls seed(default_seed) </p>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="keyword">void</span> <a name="idp709595712-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">IntType</span> x0<span class="special">)</span><span class="special">;</span></pre>
 143 <p>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). </p>
 144 </li>
 145 <li class="listitem">
 146 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp709597904-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span> seq<span class="special">)</span><span class="special">;</span></pre>
 147 <p>Seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code> using values from a SeedSeq. </p>
 148 </li>
 149 <li class="listitem">
 150 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp709601616-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
 151 <p>seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a></code></code> with values taken from the itrator range [first, last) and adjusts <code class="computeroutput">first</code> to point to the element after the last one used. If there are not enough elements, throws <code class="computeroutput">std::invalid_argument</code>.</p>
 152 <p><code class="computeroutput">first</code> and <code class="computeroutput">last</code> must be input iterators. </p>
 153 </li>
 154 <li class="listitem">
 155 <pre class="literallayout"><span class="identifier">IntType</span> <a name="idp709608064-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 156 <p>Returns the next output of the generator. </p>
 157 </li>
 158 <li class="listitem">
 159 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iter<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp709609360-bb"></a><span class="identifier">generate</span><span class="special">(</span><span class="identifier">Iter</span> first<span class="special">,</span> <span class="identifier">Iter</span> last<span class="special">)</span><span class="special">;</span></pre>
 160 <p>Fills a range with random values </p>
 161 </li>
 162 <li class="listitem">
 163 <pre class="literallayout"><span class="keyword">void</span> <a name="idp709612864-bb"></a><span class="identifier">discard</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span> z<span class="special">)</span><span class="special">;</span></pre>
 164 <p>Advances the state of the generator by <code class="computeroutput">z</code>. </p>
 165 </li>
 166 </ol></div>
 167 </div>
 168 <div class="refsect2">
 169 <a name="idp498139936"></a><h3>
 170 <a name="idp709628704-bb"></a><code class="computeroutput">inversive_congruential_engine</code> friend functions</h3>
 171 <div class="orderedlist"><ol class="orderedlist" type="1">
 172 <li class="listitem">
 173 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
 174   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 175   <a name="idp709629264-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span>
 176              <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre>
 177 <p>Writes the textual representation of the generator to a <code class="computeroutput">std::ostream</code>. </p>
 178 </li>
 179 <li class="listitem">
 180 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
 181   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 182   <a name="idp709634320-bb"></a><span class="keyword">operator</span><span class="special">&gt;&gt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> is<span class="special">,</span>
 183              <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre>
 184 <p>Reads the textual representation of the generator from a <code class="computeroutput">std::istream</code>. </p>
 185 </li>
 186 <li class="listitem">
 187 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp709639376-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> x<span class="special">,</span>
 188                        <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> y<span class="special">)</span><span class="special">;</span></pre>
 189 <p>Returns true if the two generators will produce identical sequences of outputs. </p>
 190 </li>
 191 <li class="listitem">
 192 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp709643008-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
 193                        <span class="keyword">const</span> <a class="link" href="inversive_con_idp709574400.html" title="Class template inversive_congruential_engine">inversive_congruential_engine</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 194 <p>Returns true if the two generators will produce different sequences of outputs. </p>
 195 </li>
 196 </ol></div>
 197 </div>
 198 </div>
 199 </div>
 200 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 201 <td align="left"></td>
 202 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2005 Jens Maurer<br>Copyright &#169; 2009, 2010 Steven Watanabe<p>
 203         Distributed under the Boost Software License, Version 1.0. (See accompanying
 204         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 205       </p>
 206 </div></td>
 207 </tr></table>
 208 <hr>
 209 <div class="spirit-nav">
 210 <a accesskey="p" href="independent_bits_engine.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.inversive_congruential_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="hellekalek1995.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 211 </div>
 212 </body>
 213 </html>