Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/wrapping_int2.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 6.4 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template wrapping_int2</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="date_time/doxy.html#id2462849" title="Header &lt;boost/date_time/wrapping_int.hpp&gt;">
9<link rel="prev" href="wrapping_int.html" title="Class template wrapping_int">
10<link rel="next" href="year_month_day_base.html" title="Struct template year_month_day_base">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="wrapping_int.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2462849"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="year_month_day_base.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="wrapping_int2"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template wrapping_int2</span></h2>
29<p>boost::date_time::wrapping_int2 &#8212; A wrapping integer used to wrap around at the top. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> int_type_, int_type_ wrap_min, int_type_ wrap_max&gt; 
33<span class="bold"><strong>class</strong></span> wrapping_int2 {
34<span class="bold"><strong>public</strong></span>:
35  <span class="emphasis"><em>// types</em></span>
36  <span class="bold"><strong>typedef</strong></span> int_type_ int_type;
37
38  <span class="emphasis"><em>// <a href="wrapping_int2.html#wrapping_int2construct-copy-destruct">construct/copy/destruct</a></em></span>
39  <a href="wrapping_int2.html#id2453812-bb">wrapping_int2</a>(int_type);
40
41  <span class="emphasis"><em>// <a href="wrapping_int2.html#id2453724-bb">public member functions</a></em></span>
42  <span class="type">int_type</span> <a href="wrapping_int2.html#id2453728-bb">as_int</a>() <span class="bold"><strong>const</strong></span>;
43  <a href="wrapping_int2.html#id2453744-bb"><span class="bold"><strong>operator</strong></span> int_type</a>() <span class="bold"><strong>const</strong></span>;
44  <span class="type">int_type</span> <a href="wrapping_int2.html#id2453757-bb">add</a>(int_type) ;
45  <span class="type">int_type</span> <a href="wrapping_int2.html#id2453783-bb">subtract</a>(int_type) ;
46
47  <span class="emphasis"><em>// <a href="wrapping_int2.html#id2453835-bb">public static functions</a></em></span>
48  <span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>long</strong></span></span> <a href="wrapping_int2.html#id2453840-bb">wrap_value</a>() ;
49  <span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>long</strong></span></span> <a href="wrapping_int2.html#id2453852-bb">min_value</a>() ;
50};</pre></div>
51<div class="refsect1" lang="en">
52<a name="id2667122"></a><h2>Description</h2>
53<p>Bad name, quick impl to fix a bug -- fix later!! This allows the wrap to restart at a value other than 0. Currently this only works if wrap_min == 1 </p>
54<div class="refsect2" lang="en">
55<a name="id2667130"></a><h3>
56<a name="wrapping_int2construct-copy-destruct"></a><code class="computeroutput">wrapping_int2</code> construct/copy/destruct</h3>
57<div class="orderedlist"><ol type="1"><li>
58<pre class="literallayout"><a name="id2453812-bb"></a>wrapping_int2(int_type v);</pre>
59<p>If initializing value is out of range of [wrap_min, wrap_max], value will be initialized to closest of min or max </p>
60</li></ol></div>
61</div>
62<div class="refsect2" lang="en">
63<a name="id2667169"></a><h3>
64<a name="id2453724-bb"></a><code class="computeroutput">wrapping_int2</code> public member functions</h3>
65<div class="orderedlist"><ol type="1">
66<li><pre class="literallayout"><span class="type">int_type</span> <a name="id2453728-bb"></a>as_int() <span class="bold"><strong>const</strong></span>;</pre></li>
67<li><pre class="literallayout"><a name="id2453744-bb"></a><span class="bold"><strong>operator</strong></span> int_type() <span class="bold"><strong>const</strong></span>;</pre></li>
68<li><pre class="literallayout"><span class="type">int_type</span> <a name="id2453757-bb"></a>add(int_type v) ;</pre></li>
69<li><pre class="literallayout"><span class="type">int_type</span> <a name="id2453783-bb"></a>subtract(int_type v) ;</pre></li>
70</ol></div>
71</div>
72<div class="refsect2" lang="en">
73<a name="id2667270"></a><h3>
74<a name="id2453835-bb"></a><code class="computeroutput">wrapping_int2</code> public static functions</h3>
75<div class="orderedlist"><ol type="1">
76<li><pre class="literallayout"><span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>long</strong></span></span> <a name="id2453840-bb"></a>wrap_value() ;</pre></li>
77<li><pre class="literallayout"><span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>long</strong></span></span> <a name="id2453852-bb"></a>min_value() ;</pre></li>
78</ol></div>
79</div>
80</div>
81</div>
82<table width="100%"><tr>
83<td align="left"></td>
84<td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
85</tr></table>
86<hr>
87<div class="spirit-nav">
88<a accesskey="p" href="wrapping_int.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2462849"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="year_month_day_base.html"><img src="images/next.png" alt="Next"></a>
89</div>
90</body>
91</html>
Note: See TracBrowser for help on using the repository browser.