diff options
Diffstat (limited to 'doc/html/boost/date_time/wrapping_int2.html')
| -rw-r--r-- | doc/html/boost/date_time/wrapping_int2.html | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/doc/html/boost/date_time/wrapping_int2.html b/doc/html/boost/date_time/wrapping_int2.html index d8aaa93757..d501fb1156 100644 --- a/doc/html/boost/date_time/wrapping_int2.html +++ b/doc/html/boost/date_time/wrapping_int2.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,61 +39,61 @@ <span class="keyword">typedef</span> <span class="identifier">int_type_</span> <a name="boost.date_time.wrapping_int2.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="wrapping_int2.html#boost.date_time.wrapping_int2construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="wrapping_int2.html#idp34707680-bb"><span class="identifier">wrapping_int2</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_int2.html#idp38679040-bb"><span class="identifier">wrapping_int2</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_int2.html#idp84932752-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp84933312-bb"><span class="identifier">wrap_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp84934432-bb"><span class="identifier">min_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="wrapping_int2.html#idp112746528-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp112747088-bb"><span class="identifier">wrap_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp112748208-bb"><span class="identifier">min_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="wrapping_int2.html#idp97258624-bb">public member functions</a></span> - <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp97259184-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_int2.html#idp97260608-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_int2.html#idp29586576-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_int2.html#idp100908192-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_int2.html#idp112749488-bb">public member functions</a></span> + <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#idp112750048-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_int2.html#idp112751472-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_int2.html#idp112752592-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_int2.html#idp38675584-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_int2.html#idp34709168-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_int2.html#idp34709744-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_int2.html#idp38680528-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_int2.html#idp38681104-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="idp193465120"></a><h2>Description</h2> +<a name="idp201358656"></a><h2>Description</h2> <p>Bad name, quick impl to fix a bug <span style="color: red"><ndash></ndash></span> fix later!! This allows the wrap to restart at a value other than 0. </p> <div class="refsect2"> -<a name="idp193466176"></a><h3> +<a name="idp201359632"></a><h3> <a name="boost.date_time.wrapping_int2construct-copy-destruct"></a><code class="computeroutput">wrapping_int2</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp34707680-bb"></a><span class="identifier">wrapping_int2</span><span class="special">(</span><span class="identifier">int_type</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp38679040-bb"></a><span class="identifier">wrapping_int2</span><span class="special">(</span><span class="identifier">int_type</span> v<span class="special">)</span><span class="special">;</span></pre> <p>If initializing value is out of range of [wrap_min, wrap_max], value will be initialized to closest of min or max </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp193473184"></a><h3> -<a name="idp84932752-bb"></a><code class="computeroutput">wrapping_int2</code> public static functions</h3> +<a name="idp201365712"></a><h3> +<a name="idp112746528-bb"></a><code class="computeroutput">wrapping_int2</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="idp84933312-bb"></a><span class="identifier">wrap_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">int_type</span> <a name="idp84934432-bb"></a><span class="identifier">min_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">int_type</span> <a name="idp112747088-bb"></a><span class="identifier">wrap_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">int_type</span> <a name="idp112748208-bb"></a><span class="identifier">min_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp193485424"></a><h3> -<a name="idp97258624-bb"></a><code class="computeroutput">wrapping_int2</code> public member functions</h3> +<a name="idp201376496"></a><h3> +<a name="idp112749488-bb"></a><code class="computeroutput">wrapping_int2</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="idp97259184-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="idp97260608-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="idp112750048-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="idp112751472-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="idp29586576-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="idp112752592-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="idp100908192-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. Ex: subtract a negative number and wrapping over could occur, this would be indicated by a positive return value. If wrapping under took place, a negative 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="idp38675584-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. Ex: subtract a negative number and wrapping over could occur, this would be indicated by a positive return value. If wrapping under took place, a negative value would be returned </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp193514336"></a><h3> -<a name="idp34709168-bb"></a><code class="computeroutput">wrapping_int2</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="idp34709744-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="idp201402224"></a><h3> +<a name="idp38680528-bb"></a><code class="computeroutput">wrapping_int2</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="idp38681104-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> |