| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template wrapping_int2</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../../date_time/doxy.html#header.boost.date_time.wrapping_int_hpp" title="Header <boost/date_time/wrapping_int.hpp>"> |
| <link rel="prev" href="wrapping_int.html" title="Class template wrapping_int"> |
| <link rel="next" href="year_month_day_base.html" title="Struct template year_month_day_base"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="wrapping_int.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.wrapping_int_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="year_month_day_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.date_time.wrapping_int2"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template wrapping_int2</span></h2> |
| <p>boost::date_time::wrapping_int2 — A wrapping integer used to wrap around at the top (WARNING: only instantiate with a signed type) </p> |
| </div> |
| <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
| <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.wrapping_int_hpp" title="Header <boost/date_time/wrapping_int.hpp>">boost/date_time/wrapping_int.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> int_type_<span class="special">,</span> <span class="identifier">int_type_</span> wrap_min<span class="special">,</span> <span class="identifier">int_type_</span> wrap_max<span class="special">></span> |
| <span class="keyword">class</span> <a class="link" href="wrapping_int2.html" title="Class template wrapping_int2">wrapping_int2</a> <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="comment">// types</span> |
| <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> |
| |
| <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#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#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="special">}</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="idp193465120"></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="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> |
| <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> |
| <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> |
| </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> |
| <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> |
| <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> |
| </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> |
| </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> |
| </div> |
| </div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file |
| <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="wrapping_int.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.wrapping_int_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="year_month_day_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |