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 wrapping_int2</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="../../date_time/doxy.html#header.boost.date_time.wrapping_int_hpp" title="Header <boost/date_time/wrapping_int.hpp>"> 10<link rel="prev" href="wrapping_int.html" title="Class template wrapping_int"> 11<link rel="next" href="year_month_day_base.html" title="Struct template year_month_day_base"> 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="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> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.wrapping_int2"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template wrapping_int2</span></h2> 30<p>boost::date_time::wrapping_int2 — A wrapping integer used to wrap around at the top (WARNING: only instantiate with a signed type) </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: <<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>> 34 35</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> 36<span class="keyword">class</span> <a class="link" href="wrapping_int2.html" title="Class template wrapping_int2">wrapping_int2</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">int_type_</span> <a name="boost.date_time.wrapping_int2.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="wrapping_int2.html#boost.date_time.wrapping_int2construct-copy-destruct">construct/copy/destruct</a></span> 42 <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_7-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> 43 44 <span class="comment">// <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_5-bb">public static functions</a></span> 45 <span class="keyword">static</span> <span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_5_1-bb"><span class="identifier">wrap_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">static</span> <span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_5_2-bb"><span class="identifier">min_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 47 48 <span class="comment">// <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_6-bb">public member functions</a></span> 49 <span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_6_1-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> 50 <span class="identifier">BOOST_CONSTEXPR</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_6_2-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> 51 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_6_3-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> 52 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_6_4-bb"><span class="identifier">subtract</span></a><span class="special">(</span><span class="identifier">IntT</span><span class="special">)</span><span class="special">;</span> 53 54 <span class="comment">// <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_8-bb">private member functions</a></span> 55 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntT<span class="special">></span> <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a class="link" href="wrapping_int2.html#id-1_3_14_15_3_59_1_1_2_8_1-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> 56<span class="special">}</span><span class="special">;</span></pre></div> 57<div class="refsect1"> 58<a name="id-1.3.14.15.3.58.4.4"></a><h2>Description</h2> 59<p>Bad name, quick impl to fix a bug – fix later!! This allows the wrap to restart at a value other than 0. </p> 60<div class="refsect2"> 61<a name="id-1.3.14.15.3.58.4.4.3"></a><h3> 62<a name="boost.date_time.wrapping_int2construct-copy-destruct"></a><code class="computeroutput">wrapping_int2</code> 63 public 64 construct/copy/destruct</h3> 65<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 66<pre class="literallayout"><a name="id-1_3_14_15_3_59_1_1_2_7-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> 67<p>If initializing value is out of range of [wrap_min, wrap_max], value will be initialized to closest of min or max </p> 68</li></ol></div> 69</div> 70<div class="refsect2"> 71<a name="id-1.3.14.15.3.58.4.4.4"></a><h3> 72<a name="id-1_3_14_15_3_59_1_1_2_5-bb"></a><code class="computeroutput">wrapping_int2</code> public static functions</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"> 74<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a name="id-1_3_14_15_3_59_1_1_2_5_1-bb"></a><span class="identifier">wrap_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 75<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a name="id-1_3_14_15_3_59_1_1_2_5_2-bb"></a><span class="identifier">min_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 76</ol></div> 77</div> 78<div class="refsect2"> 79<a name="id-1.3.14.15.3.58.4.4.5"></a><h3> 80<a name="id-1_3_14_15_3_59_1_1_2_6-bb"></a><code class="computeroutput">wrapping_int2</code> public member functions</h3> 81<div class="orderedlist"><ol class="orderedlist" type="1"> 82<li class="listitem"> 83<pre class="literallayout"><span class="identifier">BOOST_CONSTEXPR</span> <span class="identifier">int_type</span> <a name="id-1_3_14_15_3_59_1_1_2_6_1-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> 84<li class="listitem"><pre class="literallayout"><span class="identifier">BOOST_CONSTEXPR</span> <a name="id-1_3_14_15_3_59_1_1_2_6_2-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> 85<li class="listitem"> 86<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">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a name="id-1_3_14_15_3_59_1_1_2_6_3-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> 87</li> 88<li class="listitem"> 89<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">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a name="id-1_3_14_15_3_59_1_1_2_6_4-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> 90</li> 91</ol></div> 92</div> 93<div class="refsect2"> 94<a name="id-1.3.14.15.3.58.4.4.6"></a><h3> 95<a name="id-1_3_14_15_3_59_1_1_2_8-bb"></a><code class="computeroutput">wrapping_int2</code> private member functions</h3> 96<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">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">IntT</span> <a name="id-1_3_14_15_3_59_1_1_2_8_1-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> 97</div> 98</div> 99</div> 100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 101<td align="left"></td> 102<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 103 <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> 104</div></td> 105</tr></table> 106<hr> 107<div class="spirit-nav"> 108<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> 109</div> 110</body> 111</html> 112
