boost-react-native-bundle

Version:

Boost library as in https://sourceforge.net/projects/boost/files/boost/1.57.0/

107 lines (101 loc) • 12.2 kB

HTML

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template wrapping_int</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="tz_db_base.html" title="Class template tz_db_base"> <link rel="next" href="wrapping_int2.html" title="Class template wrapping_int2"> </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="tz_db_base.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="wrapping_int2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.date_time.wrapping_int"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template wrapping_int</h2> boost::date_time::wrapping_int — A wrapping integer used to support time durations (WARNING: only instantiate with a signed type) </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">// 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>> template<typename int_type_, int_type_ wrap_val> class <a class="link" href="wrapping_int.html" title="Class template wrapping_int">wrapping_int</a> { public: // types typedef int_type_ <a name="boost.date_time.wrapping_int.int_type"></a>int_type; // <a class="link" href="wrapping_int.html#boost.date_time.wrapping_intconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="wrapping_int.html#idp96667072-bb">wrapping_int</a>(int_type); // <a class="link" href="wrapping_int.html#idp76205664-bb">public static functions</a> static int_type <a class="link" href="wrapping_int.html#idp76206224-bb">wrap_value</a>(); // <a class="link" href="wrapping_int.html#idp76207504-bb">public member functions</a> int_type <a class="link" href="wrapping_int.html#idp76208064-bb">as_int</a>() const; <a class="link" href="wrapping_int.html#idp110994032-bb">operator int_type</a>() const; template<typename IntT> IntT <a class="link" href="wrapping_int.html#idp110995152-bb">add</a>(IntT); template<typename IntT> IntT <a class="link" href="wrapping_int.html#idp102664896-bb">subtract</a>(IntT); // <a class="link" href="wrapping_int.html#idp70857872-bb">private member functions</a> template<typename IntT> IntT <a class="link" href="wrapping_int.html#idp70858448-bb">calculate_wrap</a>(IntT); };</pre></div> <div class="refsect1"> <a name="idp199675248"></a><h2>Description</h2> 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] 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. Also Note that warnings will occur if instantiated with an unsigned type. Only a signed type should be used! <div class="refsect2"> <a name="idp199679488"></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="idp96667072-bb"></a>wrapping_int(int_type v);</pre>Add, return true if wrapped. </li></ol></div> </div> <div class="refsect2"> <a name="idp199686176"></a><h3> <a name="idp76205664-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">static int_type <a name="idp76206224-bb"></a>wrap_value();</pre></li></ol></div> </div> <div class="refsect2"> <a name="idp199693408"></a><h3> <a name="idp76207504-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">int_type <a name="idp76208064-bb"></a>as_int() const;</pre>Explicit converion method. </li> <li class="listitem"><pre class="literallayout"><a name="idp110994032-bb"></a>operator int_type() const;</pre></li> <li class="listitem"> <pre class="literallayout">template<typename IntT> IntT <a name="idp110995152-bb"></a>add(IntT v);</pre>Add, return number of wraps performed. 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 </li> <li class="listitem"> <pre class="literallayout">template<typename IntT> IntT <a name="idp102664896-bb"></a>subtract(IntT v);</pre>Subtract will return '+d' if wrapping under took place ('d' is the number of wraps) 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. </li> </ol></div> </div> <div class="refsect2"> <a name="idp199722384"></a><h3> <a name="idp70857872-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">template<typename IntT> IntT <a name="idp70858448-bb"></a>calculate_wrap(IntT wrap);</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, IncSubject 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>) </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="tz_db_base.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="wrapping_int2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>