• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=UTF-8">
5<title>Class template subtract_with_carry_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.subtract_with_carry_hpp" title="Header &lt;boost/random/subtract_with_carry.hpp&gt;">
10<link rel="prev" href="subtra_1_3_34_5_6_41_1_1_1.html" title="Class template subtract_with_carry_01_engine">
11<link rel="next" href="taus88.html" title="Type definition taus88">
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="subtra_1_3_34_5_6_41_1_1_1.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.subtract_with_carry_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="taus88.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.random.subtract_with_carry_engine"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template subtract_with_carry_engine</span></h2>
30<p>boost::random::subtract_with_carry_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.subtract_with_carry_hpp" title="Header &lt;boost/random/subtract_with_carry.hpp&gt;">boost/random/subtract_with_carry.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">std</span><span class="special">::</span><span class="identifier">size_t</span> w<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> s<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> r<span class="special">&gt;</span>
36<span class="keyword">class</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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.subtract_with_carry_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
40
41  <span class="comment">// <a class="link" href="subtract_with_carry_engine.html#boost.random.subtract_with_carry_engineconstruct-copy-destruct">construct/copy/destruct</a></span>
42  <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_11-bb"><span class="identifier">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_12-bb"><span class="identifier">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_13-bb"><span class="identifier">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_14-bb"><span class="identifier">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10-bb">public member functions</a></span>
48  <span class="keyword">void</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_1-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
49  <span class="keyword">void</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_2-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">IntType</span><span class="special">)</span><span class="special">;</span>
50  <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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_3-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>
51  <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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_4-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>
52  <span class="identifier">result_type</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_5-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>
53  <span class="keyword">void</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_6-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>
54  <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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_10_7-bb"><span class="identifier">generate</span></a><span class="special">(</span><span class="identifier">It</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
55
56  <span class="comment">// <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_15-bb">public static functions</a></span>
57  <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_15_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
58  <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_15_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
59
60  <span class="comment">// <a class="link" href="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_16-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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_16_1-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="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_16_2-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="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_16_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span><span class="special">,</span>
70                         <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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="subtract_with_carry_engine.html#id-1_3_34_5_6_41_1_1_2_16_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span><span class="special">,</span>
72                         <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">word_size</span><span class="special">;</span>
76  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">long_lag</span><span class="special">;</span>
77  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">short_lag</span><span class="special">;</span>
78  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">uint32_t</span> <span class="identifier">default_seed</span><span class="special">;</span>
79  <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>
80  <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>
81<span class="special">}</span><span class="special">;</span></pre></div>
82<div class="refsect1">
83<a name="id-1.3.34.5.6.40.4.4"></a><h2>Description</h2>
84<p>Instantiations of <code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_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> . The algorithm is described in</p>
85<p> </p>
86<div class="blockquote"><blockquote class="blockquote"><p>  "A New Class of Random Number Generators", George Marsaglia and Arif Zaman, Annals of Applied Probability, Volume 1, Number 3 (1991), 462-480.  </p></blockquote></div>
87<p>  </p>
88<div class="refsect2">
89<a name="id-1.3.34.5.6.40.4.4.4"></a><h3>
90<a name="boost.random.subtract_with_carry_engineconstruct-copy-destruct"></a><code class="computeroutput">subtract_with_carry_engine</code>
91        public
92       construct/copy/destruct</h3>
93<div class="orderedlist"><ol class="orderedlist" type="1">
94<li class="listitem">
95<pre class="literallayout"><a name="id-1_3_34_5_6_41_1_1_2_11-bb"></a><span class="identifier">subtract_with_carry_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
96<p>Constructs a new <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> and seeds it with the default seed. </p>
97</li>
98<li class="listitem">
99<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_41_1_1_2_12-bb"></a><span class="identifier">subtract_with_carry_engine</span><span class="special">(</span><span class="identifier">IntType</span> value<span class="special">)</span><span class="special">;</span></pre>
100<p>Constructs a new <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> and seeds it with <code class="computeroutput">value</code>. </p>
101</li>
102<li class="listitem">
103<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">explicit</span> <a name="id-1_3_34_5_6_41_1_1_2_13-bb"></a><span class="identifier">subtract_with_carry_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>
104<p>Constructs a new <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> and seeds it with values produced by <code class="computeroutput">seq.generate()</code>. </p>
105</li>
106<li class="listitem">
107<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="id-1_3_34_5_6_41_1_1_2_14-bb"></a><span class="identifier">subtract_with_carry_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>
108<p>Constructs a new <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> 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 <code class="computeroutput">std::invalid_argument</code>. </p>
109</li>
110</ol></div>
111</div>
112<div class="refsect2">
113<a name="id-1.3.34.5.6.40.4.4.5"></a><h3>
114<a name="id-1_3_34_5_6_41_1_1_2_10-bb"></a><code class="computeroutput">subtract_with_carry_engine</code> public member functions</h3>
115<div class="orderedlist"><ol class="orderedlist" type="1">
116<li class="listitem">
117<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_41_1_1_2_10_1-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
118<p>Seeds the generator with the default seed. </p>
119</li>
120<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_41_1_1_2_10_2-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">IntType</span> value<span class="special">)</span><span class="special">;</span></pre></li>
121<li class="listitem">
122<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="id-1_3_34_5_6_41_1_1_2_10_3-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>
123<p>Seeds the generator with values produced by <code class="computeroutput">seq.generate()</code>. </p>
124</li>
125<li class="listitem">
126<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="id-1_3_34_5_6_41_1_1_2_10_4-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>
127<p>Seeds the generator with values from a range. Updates <code class="computeroutput">first</code> 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 <code class="computeroutput">std::invalid_argument</code>. </p>
128</li>
129<li class="listitem">
130<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_41_1_1_2_10_5-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>
131<p>Returns the next value of the generator. </p>
132</li>
133<li class="listitem">
134<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_41_1_1_2_10_6-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>
135<p>Advances the state of the generator by <code class="computeroutput">z</code>. </p>
136</li>
137<li class="listitem">
138<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="id-1_3_34_5_6_41_1_1_2_10_7-bb"></a><span class="identifier">generate</span><span class="special">(</span><span class="identifier">It</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
139<p>Fills a range with random values. </p>
140</li>
141</ol></div>
142</div>
143<div class="refsect2">
144<a name="id-1.3.34.5.6.40.4.4.6"></a><h3>
145<a name="id-1_3_34_5_6_41_1_1_2_15-bb"></a><code class="computeroutput">subtract_with_carry_engine</code> public static functions</h3>
146<div class="orderedlist"><ol class="orderedlist" type="1">
147<li class="listitem">
148<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_41_1_1_2_15_1-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
149<p>Returns the smallest value that the generator can produce. </p>
150</li>
151<li class="listitem">
152<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_41_1_1_2_15_2-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
153<p>Returns the largest value that the generator can produce. </p>
154</li>
155</ol></div>
156</div>
157<div class="refsect2">
158<a name="id-1.3.34.5.6.40.4.4.7"></a><h3>
159<a name="id-1_3_34_5_6_41_1_1_2_16-bb"></a><code class="computeroutput">subtract_with_carry_engine</code> friend functions</h3>
160<div class="orderedlist"><ol class="orderedlist" type="1">
161<li class="listitem">
162<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>
163  <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>
164  <a name="id-1_3_34_5_6_41_1_1_2_16_1-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>
165             <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>
166<p>Writes a <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> to a <code class="computeroutput">std::ostream</code>. </p>
167</li>
168<li class="listitem">
169<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>
170  <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>
171  <a name="id-1_3_34_5_6_41_1_1_2_16_2-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>
172             <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>
173<p>Reads a <code class="computeroutput"><code class="computeroutput"><a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a></code></code> from a <code class="computeroutput">std::istream</code>. </p>
174</li>
175<li class="listitem">
176<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_41_1_1_2_16_3-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> x<span class="special">,</span>
177                       <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> y<span class="special">)</span><span class="special">;</span></pre>
178<p>Returns true if the two generators will produce identical sequences of values. </p>
179</li>
180<li class="listitem">
181<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_41_1_1_2_16_4-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
182                       <span class="keyword">const</span> <a class="link" href="subtract_with_carry_engine.html" title="Class template subtract_with_carry_engine">subtract_with_carry_engine</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
183<p>Returns true if the two generators will produce different sequences of values. </p>
184</li>
185</ol></div>
186</div>
187</div>
188</div>
189<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
190<td align="left"></td>
191<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
192        Distributed under the Boost Software License, Version 1.0. (See accompanying
193        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>)
194      </p>
195</div></td>
196</tr></table>
197<hr>
198<div class="spirit-nav">
199<a accesskey="p" href="subtra_1_3_34_5_6_41_1_1_1.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.subtract_with_carry_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="taus88.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
200</div>
201</body>
202</html>
203