| <?xml version="1.0" encoding="utf-8" ?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> |
| <title>The MPL Reference Manual: integral_c</title> |
| <link rel="stylesheet" href="../style.css" type="text/css" /> |
| </head> |
| <body class="docframe refmanual"> |
| <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./size-t.html" class="navigation-link">Prev</a> <a href="./char.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./size-t.html" class="navigation-link">Back</a> <a href="./char.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./numeric.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> |
| <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./data-types.html" class="navigation-link">Data Types</a> / <a href="./numeric.html" class="navigation-link">Numeric</a> / <a href="./integral-c.html" class="navigation-link">integral_c</a></td> |
| </tr></table><div class="header-separator"></div> |
| <div class="section" id="integral-c"> |
| <h1><a class="toc-backref" href="./numeric.html#id1580">integral_c</a></h1> |
| <div class="section" id="id1254"> |
| <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> |
| <pre class="literal-block"> |
| template< |
| typename T, T N |
| > |
| struct <a href="./integral-c.html" class="identifier">integral_c</a> |
| { |
| // <em>unspecified</em> |
| // ... |
| }; |
| </pre> |
| </div> |
| <div class="section" id="id1255"> |
| <h3><a class="subsection-title" href="#description" name="description">Description</a></h3> |
| <p>A generic <a class="reference internal" href="./integral-constant.html">Integral Constant</a> wrapper.</p> |
| </div> |
| <div class="section" id="id1256"> |
| <h3><a class="subsection-title" href="#header" name="header">Header</a></h3> |
| <pre class="literal-block"> |
| #include <<a href="../../../../boost/mpl/integral_c.hpp" class="header">boost/mpl/integral_c.hpp</a>> |
| </pre> |
| </div> |
| <div class="section" id="id1257"> |
| <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> |
| <p><a class="reference internal" href="./integral-constant.html">Integral Constant</a></p> |
| </div> |
| <div class="section" id="id1258"> |
| <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> |
| <table border="1" class="docutils table"> |
| <colgroup> |
| <col width="21%" /> |
| <col width="42%" /> |
| <col width="37%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr><th class="head">Parameter</th> |
| <th class="head">Requirement</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr><td><tt class="literal"><span class="pre">T</span></tt></td> |
| <td>An integral type</td> |
| <td>Wrapper's value type.</td> |
| </tr> |
| <tr><td><tt class="literal"><span class="pre">N</span></tt></td> |
| <td>An integral constant</td> |
| <td>A value to wrap.</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="id1259"> |
| <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> |
| <p>The semantics of an expression are defined only |
| where they differ from, or are not defined in <a class="reference internal" href="./integral-constant.html">Integral Constant</a>.</p> |
| <p>For arbitrary integral type <tt class="literal"><span class="pre">t</span></tt> and integral constant <tt class="literal"><span class="pre">n</span></tt>:</p> |
| <table border="1" class="docutils table"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="72%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr><th class="head">Expression</th> |
| <th class="head">Semantics</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr><td><tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a><t,c></span></tt></td> |
| <td>An <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">x</span></tt> such that <tt class="literal"><span class="pre">x::value</span> <span class="pre">==</span> <span class="pre">c</span></tt> |
| and <tt class="literal"><span class="pre">x::<a href="./value-type.html" class="identifier">value_type</a></span></tt> is identical to <tt class="literal"><span class="pre">t</span></tt>.</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="id1260"> |
| <h3><a class="subsection-title" href="#example" name="example">Example</a></h3> |
| <pre class="literal-block"> |
| typedef <a href="./integral-c.html" class="identifier">integral_c</a><short,8> eight; |
| |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< eight::<a href="./value-type.html" class="identifier">value_type</a>, short > )); |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< eight::type, eight > )); |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./next.html" class="identifier">next</a>< eight >::type, <a href="./integral-c.html" class="identifier">integral_c</a><short,9> > )); |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./prior.html" class="identifier">prior</a>< eight >::type, <a href="./integral-c.html" class="identifier">integral_c</a><short,7> > )); |
| <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (eight::value), ==, 8 ); |
| assert( eight() == 8 ); |
| </pre> |
| </div> |
| <div class="section" id="id1261"> |
| <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> |
| <p><a class="reference internal" href="./data-types.html">Data Types</a>, <a class="reference internal" href="./integral-constant.html">Integral Constant</a>, <a class="reference internal" href="./bool.html">bool_</a>, <a class="reference internal" href="./int.html">int_</a>, <a class="reference internal" href="./long.html">long_</a>, <a class="reference internal" href="./size-t.html">size_t</a></p> |
| <!-- Data Types/Numeric//char_ |60 --> |
| </div> |
| </div> |
| |
| <div class="footer-separator"></div> |
| <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./size-t.html" class="navigation-link">Prev</a> <a href="./char.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./size-t.html" class="navigation-link">Back</a> <a href="./char.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./numeric.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> |
| <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body> |
| </html> |
