diff options
Diffstat (limited to 'doc/html/boost/date_time/wrapping_int.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost/date_time/wrapping_int.html | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/html/boost/date_time/wrapping_int.html b/doc/html/boost/date_time/wrapping_int.html index 37d08bb960..b7a37ac19a 100755..100644 --- a/doc/html/boost/date_time/wrapping_int.html +++ b/doc/html/boost/date_time/wrapping_int.html @@ -38,57 +38,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#id721613-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#id395838-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#id695421-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#id695424-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#id678160-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#id678164-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#id695432-bb">public member functions</a></span> - <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#id695435-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#id695446-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#id346552-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#id667972-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#id679277-bb">public member functions</a></span> + <span class="identifier">int_type</span> <a class="link" href="wrapping_int.html#id679281-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#id383737-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#id383745-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#id679381-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#id387802-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#id387805-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#id363740-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#id697196-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="id1467556"></a><h2>Description</h2> +<a name="id1483895"></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="id1467595"></a><h3> +<a name="id1483935"></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="id721613-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="id395838-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="id1467651"></a><h3> -<a name="id695421-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="id695424-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="id1483991"></a><h3> +<a name="id678160-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="id678164-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="id1467710"></a><h3> -<a name="id695432-bb"></a><code class="computeroutput">wrapping_int</code> public member functions</h3> +<a name="id1484049"></a><h3> +<a name="id679277-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="id695435-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="id695446-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="id679281-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="id383737-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="id346552-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="id383745-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="id667972-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="id679381-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="id1468221"></a><h3> -<a name="id387802-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="id387805-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="id1484290"></a><h3> +<a name="id363740-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="id697196-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> |