diff options
Diffstat (limited to 'doc/html/boost/date_time/wrapping_int.html')
| -rw-r--r-- | doc/html/boost/date_time/wrapping_int.html | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/doc/html/boost/date_time/wrapping_int.html b/doc/html/boost/date_time/wrapping_int.html index f0de82d362..207218c122 100644 --- a/doc/html/boost/date_time/wrapping_int.html +++ b/doc/html/boost/date_time/wrapping_int.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -38,57 +39,57 @@ <span class="keyword">typedef</span> <span class="identifier">int_type_</span> <a name="boost.date_time.wrapping_int.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="wrapping_int.html#boost.date_time.wrapping_intconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="wrapping_int.html#idp98732016-bb"><span class="identifier">wrapping_int</span></a><span class="special">(</span><span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="wrapping_int.html#idp115031056-bb"><span class="identifier">wrapping_int</span></a><span class="special">(</span><span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="wrapping_int.html#idp87416000-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#idp87416560-bb"><span class="identifier">wrap_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="wrapping_int.html#idp94818592-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#idp94819152-bb"><span class="identifier">wrap_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="wrapping_int.html#idp87417840-bb">public member functions</a></span> - <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#idp63041376-bb"><span class="identifier">as_int</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="wrapping_int.html#idp63042800-bb"><span class="keyword">operator</span> <span class="identifier">int_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp63043920-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp92602192-bb"><span class="identifier">subtract</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="wrapping_int.html#idp94820432-bb">public member functions</a></span> + <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#idp94820992-bb"><span class="identifier">as_int</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="wrapping_int.html#idp94822416-bb"><span class="keyword">operator</span> <span class="identifier">int_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp115024192-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp115027536-bb"><span class="identifier">subtract</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="wrapping_int.html#idp98733296-bb">private member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp98733872-bb"><span class="identifier">calculate_wrap</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="wrapping_int.html#idp116421168-bb">private member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int.html#idp116421744-bb"><span class="identifier">calculate_wrap</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp193343552"></a><h2>Description</h2> +<a name="idp201253456"></a><h2>Description</h2> <p>In composite date and time types this type is used to wrap at the day boundary. Ex: A wrapping_int<short, 10> will roll over after nine, and roll under below zero. This gives a range of [0,9]</p> <p>NOTE: it is strongly recommended that <a class="link" href="wrapping_int2.html" title="Class template wrapping_int2">wrapping_int2</a> be used instead of <a class="link" href="wrapping_int.html" title="Class template wrapping_int">wrapping_int</a> as <a class="link" href="wrapping_int.html" title="Class template wrapping_int">wrapping_int</a> is to be depricated at some point soon.</p> <p>Also Note that warnings will occur if instantiated with an unsigned type. Only a signed type should be used! </p> <div class="refsect2"> -<a name="idp193347792"></a><h3> +<a name="idp201256816"></a><h3> <a name="boost.date_time.wrapping_intconstruct-copy-destruct"></a><code class="computeroutput">wrapping_int</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp98732016-bb"></a><span class="identifier">wrapping_int</span><span class="special">(</span><span class="identifier">int_type</span> v<span class="special">)</span><span class="special">;</span></pre>Add, return true if wrapped. </li></ol></div> +<pre class="literallayout"><a name="idp115031056-bb"></a><span class="identifier">wrapping_int</span><span class="special">(</span><span class="identifier">int_type</span> v<span class="special">)</span><span class="special">;</span></pre>Add, return true if wrapped. </li></ol></div> </div> <div class="refsect2"> -<a name="idp193354544"></a><h3> -<a name="idp87416000-bb"></a><code class="computeroutput">wrapping_int</code> public static functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">int_type</span> <a name="idp87416560-bb"></a><span class="identifier">wrap_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<a name="idp201262640"></a><h3> +<a name="idp94818592-bb"></a><code class="computeroutput">wrapping_int</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">int_type</span> <a name="idp94819152-bb"></a><span class="identifier">wrap_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp193361776"></a><h3> -<a name="idp87417840-bb"></a><code class="computeroutput">wrapping_int</code> public member functions</h3> +<a name="idp201268960"></a><h3> +<a name="idp94820432-bb"></a><code class="computeroutput">wrapping_int</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp63041376-bb"></a><span class="identifier">as_int</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explicit converion method. </li> -<li class="listitem"><pre class="literallayout"><a name="idp63042800-bb"></a><span class="keyword">operator</span> <span class="identifier">int_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp94820992-bb"></a><span class="identifier">as_int</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explicit converion method. </li> +<li class="listitem"><pre class="literallayout"><a name="idp94822416-bb"></a><span class="keyword">operator</span> <span class="identifier">int_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp63043920-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">IntT</span> v<span class="special">)</span><span class="special">;</span></pre>Add, return number of wraps performed. <p>The sign of the returned value will indicate which direction the wraps went. Ex: add a negative number and wrapping under could occur, this would be indicated by a negative return value. If wrapping over took place, a positive value would be returned </p> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp115024192-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">IntT</span> v<span class="special">)</span><span class="special">;</span></pre>Add, return number of wraps performed. <p>The sign of the returned value will indicate which direction the wraps went. Ex: add a negative number and wrapping under could occur, this would be indicated by a negative return value. If wrapping over took place, a positive value would be returned </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp92602192-bb"></a><span class="identifier">subtract</span><span class="special">(</span><span class="identifier">IntT</span> v<span class="special">)</span><span class="special">;</span></pre>Subtract will return '+d' if wrapping under took place ('d' is the number of wraps) <p>The sign of the returned value will indicate which direction the wraps went (positive indicates wrap under, negative indicates wrap over). Ex: subtract a negative number and wrapping over could occur, this would be indicated by a negative return value. If wrapping under took place, a positive value would be returned. </p> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp115027536-bb"></a><span class="identifier">subtract</span><span class="special">(</span><span class="identifier">IntT</span> v<span class="special">)</span><span class="special">;</span></pre>Subtract will return '+d' if wrapping under took place ('d' is the number of wraps) <p>The sign of the returned value will indicate which direction the wraps went (positive indicates wrap under, negative indicates wrap over). Ex: subtract a negative number and wrapping over could occur, this would be indicated by a negative return value. If wrapping under took place, a positive value would be returned. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp193390752"></a><h3> -<a name="idp98733296-bb"></a><code class="computeroutput">wrapping_int</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp98733872-bb"></a><span class="identifier">calculate_wrap</span><span class="special">(</span><span class="identifier">IntT</span> wrap<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<a name="idp201294752"></a><h3> +<a name="idp116421168-bb"></a><code class="computeroutput">wrapping_int</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">IntT</span> <a name="idp116421744-bb"></a><span class="identifier">calculate_wrap</span><span class="special">(</span><span class="identifier">IntT</span> wrap<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> |