1<?xml version="1.0" encoding="utf-8" ?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 4<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> 7<title>The MPL Reference Manual: integral_c</title> 8<link rel="stylesheet" href="../style.css" type="text/css" /> 9</head> 10<body class="docframe refmanual"> 11<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> 12<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> 13</tr></table><div class="header-separator"></div> 14<div class="section" id="integral-c"> 15<h1><a class="toc-backref" href="./numeric.html#id1580">integral_c</a></h1> 16<div class="section" id="id1254"> 17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> 18<pre class="literal-block"> 19template< 20 typename T, T N 21 > 22struct <a href="./integral-c.html" class="identifier">integral_c</a> 23{ 24 // <em>unspecified</em> 25 // ... 26}; 27</pre> 28</div> 29<div class="section" id="id1255"> 30<h3><a class="subsection-title" href="#description" name="description">Description</a></h3> 31<p>A generic <a class="reference internal" href="./integral-constant.html">Integral Constant</a> wrapper.</p> 32</div> 33<div class="section" id="id1256"> 34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3> 35<pre class="literal-block"> 36#include <<a href="../../../../boost/mpl/integral_c.hpp" class="header">boost/mpl/integral_c.hpp</a>> 37</pre> 38</div> 39<div class="section" id="id1257"> 40<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> 41<p><a class="reference internal" href="./integral-constant.html">Integral Constant</a></p> 42</div> 43<div class="section" id="id1258"> 44<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> 45<table border="1" class="docutils table"> 46<colgroup> 47<col width="21%" /> 48<col width="42%" /> 49<col width="37%" /> 50</colgroup> 51<thead valign="bottom"> 52<tr><th class="head">Parameter</th> 53<th class="head">Requirement</th> 54<th class="head">Description</th> 55</tr> 56</thead> 57<tbody valign="top"> 58<tr><td><tt class="literal"><span class="pre">T</span></tt></td> 59<td>An integral type</td> 60<td>Wrapper's value type.</td> 61</tr> 62<tr><td><tt class="literal"><span class="pre">N</span></tt></td> 63<td>An integral constant</td> 64<td>A value to wrap.</td> 65</tr> 66</tbody> 67</table> 68</div> 69<div class="section" id="id1259"> 70<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> 71<p>The semantics of an expression are defined only 72where they differ from, or are not defined in <a class="reference internal" href="./integral-constant.html">Integral Constant</a>.</p> 73<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> 74<table border="1" class="docutils table"> 75<colgroup> 76<col width="28%" /> 77<col width="72%" /> 78</colgroup> 79<thead valign="bottom"> 80<tr><th class="head">Expression</th> 81<th class="head">Semantics</th> 82</tr> 83</thead> 84<tbody valign="top"> 85<tr><td><tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a><t,c></span></tt></td> 86<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> 87and <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> 88</tr> 89</tbody> 90</table> 91</div> 92<div class="section" id="id1260"> 93<h3><a class="subsection-title" href="#example" name="example">Example</a></h3> 94<pre class="literal-block"> 95typedef <a href="./integral-c.html" class="identifier">integral_c</a><short,8> eight; 96 97<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< eight::<a href="./value-type.html" class="identifier">value_type</a>, short > )); 98<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< eight::type, eight > )); 99<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> > )); 100<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> > )); 101<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (eight::value), ==, 8 ); 102assert( eight() == 8 ); 103</pre> 104</div> 105<div class="section" id="id1261"> 106<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> 107<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> 108<!-- Data Types/Numeric//char_ |60 --> 109</div> 110</div> 111 112<div class="footer-separator"></div> 113<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> 114<td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> 115Distributed under the Boost Software License, Version 1.0. (See accompanying 116file 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> 117</html> 118