Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/integral-constant.html @ 13

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

added boost
File size: 8.7 KB
Line 
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.3.6: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: Integral Constant</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="./data-concepts.html" class="navigation-link">Prev</a>&nbsp;<a href="./numeric.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./data-concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</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="./data-concepts.html" class="navigation-link">Concepts</a> / <a href="./integral-constant.html" class="navigation-link">Integral Constant</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="integral-constant">
15<h1><a class="toc-backref" href="./data-concepts.html#id498" name="integral-constant">Integral Constant</a></h1>
16<div class="section" id="data-integral-description">
17<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
18<p>An <a class="reference" href="./integral-constant.html">Integral Constant</a> is a holder class for a compile-time value of an
19integral type. Every <a class="reference" href="./integral-constant.html">Integral Constant</a> is also a nullary <a class="reference" href="./metafunction.html">Metafunction</a>,
20returning itself. An integral constant <em>object</em> is implicitly convertible to the
21corresponding run-time value of the wrapped integral type.</p>
22</div>
23<div class="section" id="data-integral-expression-requirements">
24<h3><a class="subsection-title" href="#expression-requirements" name="expression-requirements">Expression requirements</a></h3>
25<p>In the following table and subsequent specifications, <tt class="literal"><span class="pre">n</span></tt> is a model of <a class="reference" href="./integral-constant.html">Integral Constant</a>.</p>
26<table border="1" class="table">
27<colgroup>
28<col width="35%" />
29<col width="39%" />
30<col width="27%" />
31</colgroup>
32<thead valign="bottom">
33<tr><th>Expression</th>
34<th>Type</th>
35<th>Complexity</th>
36</tr>
37</thead>
38<tbody valign="top">
39<tr><td><tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span></tt></td>
40<td>An integral type</td>
41<td>Constant time.</td>
42</tr>
43<tr><td><tt class="literal"><span class="pre">n::value</span></tt></td>
44<td>An integral constant expression</td>
45<td>Constant time.</td>
46</tr>
47<tr><td><tt class="literal"><span class="pre">n::type</span></tt></td>
48<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
49<td>Constant time.</td>
50</tr>
51<tr><td><tt class="literal"><span class="pre"><a href="./next.html" class="identifier">next</a>&lt;n&gt;::type</span></tt></td>
52<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
53<td>Constant time.</td>
54</tr>
55<tr><td><tt class="literal"><span class="pre"><a href="./prior.html" class="identifier">prior</a>&lt;n&gt;::type</span></tt></td>
56<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
57<td>Constant time.</td>
58</tr>
59<tr><td><tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span> <span class="pre">const</span> <span class="pre">c</span> <span class="pre">=</span> <span class="pre">n()</span></tt></td>
60<td>&nbsp;</td>
61<td>Constant time.</td>
62</tr>
63</tbody>
64</table>
65</div>
66<div class="section" id="data-integral-expression-semantics">
67<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
68<table border="1" class="table">
69<colgroup>
70<col width="40%" />
71<col width="60%" />
72</colgroup>
73<thead valign="bottom">
74<tr><th>Expression</th>
75<th>Semantics</th>
76</tr>
77</thead>
78<tbody valign="top">
79<tr><td><tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span></tt></td>
80<td>A cv-unqualified type of <tt class="literal"><span class="pre">n::value</span></tt>.</td>
81</tr>
82<tr><td><tt class="literal"><span class="pre">n::value</span></tt></td>
83<td>The value of the wrapped integral constant.</td>
84</tr>
85<tr><td><tt class="literal"><span class="pre">n::type</span></tt></td>
86<td><tt class="literal"><span class="pre">is_same&lt;n::type,n&gt;::value</span> <span class="pre">==</span> <span class="pre">true</span></tt>.</td>
87</tr>
88<tr><td><tt class="literal"><span class="pre"><a href="./next.html" class="identifier">next</a>&lt;n&gt;::type</span></tt></td>
89<td>An <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> of type <tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span></tt>
90such that <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">n::value</span> <span class="pre">+</span> <span class="pre">1</span></tt>.</td>
91</tr>
92<tr><td><tt class="literal"><span class="pre"><a href="./prior.html" class="identifier">prior</a>&lt;n&gt;::type</span></tt></td>
93<td>An <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> of type <tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span></tt>
94such that <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">n::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>.</td>
95</tr>
96<tr><td><tt class="literal"><span class="pre">n::<a href="./value-type.html" class="identifier">value_type</a></span> <span class="pre">const</span> <span class="pre">c</span> <span class="pre">=</span> <span class="pre">n()</span></tt></td>
97<td><tt class="literal"><span class="pre">c</span> <span class="pre">==</span> <span class="pre">n::value</span></tt>.</td>
98</tr>
99</tbody>
100</table>
101</div>
102<div class="section" id="data-integral-models">
103<h3><a class="subsection-title" href="#models" name="models">Models</a></h3>
104<ul class="simple">
105<li><a class="refentry reference" href="./bool.html"><tt class="refentry literal"><span class="pre">bool_</span></tt></a></li>
106<li><a class="refentry reference" href="./int.html"><tt class="refentry literal"><span class="pre">int_</span></tt></a></li>
107<li><a class="refentry reference" href="./long.html"><tt class="refentry literal"><span class="pre">long_</span></tt></a></li>
108<li><a class="refentry reference" href="./integral-c.html"><tt class="refentry literal"><span class="pre">integral_c</span></tt></a></li>
109</ul>
110</div>
111<div class="section" id="data-integral-see-also">
112<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
113<p><a class="reference" href="./data-types.html">Data Types</a>, <a class="reference" href="./integral-sequence-wrapper.html">Integral Sequence Wrapper</a>, <a class="refentry reference" href="./integral-c.html"><tt class="refentry literal"><span class="pre">integral_c</span></tt></a></p>
114<!-- modtime: November 13, 2004 01:43:06 +0000 -->
115</div>
116</div>
117
118<div class="footer-separator"></div>
119<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./data-concepts.html" class="navigation-link">Prev</a>&nbsp;<a href="./numeric.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./data-concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
120</tr></table></body>
121</html>
Note: See TracBrowser for help on using the repository browser.