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: bool_</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="./numeric.html" class="navigation-link">Prev</a> <a href="./int.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group">Back <a href="./int.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="./bool.html" class="navigation-link">bool_</a></td> |
---|
13 | </tr></table><div class="header-separator"></div> |
---|
14 | <div class="section" id="bool"> |
---|
15 | <h1><a class="toc-backref" href="./numeric.html#id500" name="bool">bool_</a></h1> |
---|
16 | <div class="section" id="bool-synopsis"> |
---|
17 | <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> |
---|
18 | <pre class="literal-block"> |
---|
19 | template< |
---|
20 | bool C |
---|
21 | > |
---|
22 | struct <a href="./bool.html" class="identifier">bool_</a> |
---|
23 | { |
---|
24 | // <em>unspecified</em> |
---|
25 | // ... |
---|
26 | }; |
---|
27 | |
---|
28 | typedef <a href="./bool.html" class="identifier">bool_</a><true> true_; |
---|
29 | typedef <a href="./bool.html" class="identifier">bool_</a><false> false_; |
---|
30 | </pre> |
---|
31 | </div> |
---|
32 | <div class="section" id="bool-description"> |
---|
33 | <h3><a class="subsection-title" href="#description" name="description">Description</a></h3> |
---|
34 | <p>A boolean <a class="reference" href="./integral-constant.html">Integral Constant</a> wrapper.</p> |
---|
35 | </div> |
---|
36 | <div class="section" id="bool-header"> |
---|
37 | <h3><a class="subsection-title" href="#header" name="header">Header</a></h3> |
---|
38 | <pre class="literal-block"> |
---|
39 | #include <<a href="../../../../boost/mpl/bool.hpp" class="header">boost/mpl/bool.hpp</a>> |
---|
40 | </pre> |
---|
41 | </div> |
---|
42 | <div class="section" id="bool-model-of"> |
---|
43 | <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> |
---|
44 | <p><a class="reference" href="./integral-constant.html">Integral Constant</a></p> |
---|
45 | </div> |
---|
46 | <div class="section" id="bool-parameters"> |
---|
47 | <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> |
---|
48 | <table border="1" class="table"> |
---|
49 | <colgroup> |
---|
50 | <col width="21%" /> |
---|
51 | <col width="42%" /> |
---|
52 | <col width="37%" /> |
---|
53 | </colgroup> |
---|
54 | <thead valign="bottom"> |
---|
55 | <tr><th>Parameter</th> |
---|
56 | <th>Requirement</th> |
---|
57 | <th>Description</th> |
---|
58 | </tr> |
---|
59 | </thead> |
---|
60 | <tbody valign="top"> |
---|
61 | <tr><td><tt class="literal"><span class="pre">C</span></tt></td> |
---|
62 | <td>A boolean integral constant</td> |
---|
63 | <td>A value to wrap.</td> |
---|
64 | </tr> |
---|
65 | </tbody> |
---|
66 | </table> |
---|
67 | </div> |
---|
68 | <div class="section" id="bool-expression-semantics"> |
---|
69 | <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> |
---|
70 | <p>The semantics of an expression are defined only |
---|
71 | where they differ from, or are not defined in <a class="reference" href="./integral-constant.html">Integral Constant</a>.</p> |
---|
72 | <p>For arbitrary integral constant <tt class="literal"><span class="pre">c</span></tt>:</p> |
---|
73 | <table border="1" class="table"> |
---|
74 | <colgroup> |
---|
75 | <col width="24%" /> |
---|
76 | <col width="76%" /> |
---|
77 | </colgroup> |
---|
78 | <thead valign="bottom"> |
---|
79 | <tr><th>Expression</th> |
---|
80 | <th>Semantics</th> |
---|
81 | </tr> |
---|
82 | </thead> |
---|
83 | <tbody valign="top"> |
---|
84 | <tr><td><tt class="literal"><span class="pre"><a href="./bool.html" class="identifier">bool_</a><c></span></tt></td> |
---|
85 | <td>An <a class="reference" 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> |
---|
86 | 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">bool</span></tt>.</td> |
---|
87 | </tr> |
---|
88 | </tbody> |
---|
89 | </table> |
---|
90 | </div> |
---|
91 | <div class="section" id="bool-example"> |
---|
92 | <h3><a class="subsection-title" href="#example" name="example">Example</a></h3> |
---|
93 | <pre class="literal-block"> |
---|
94 | <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./bool.html" class="identifier">bool_</a><true>::<a href="./value-type.html" class="identifier">value_type</a>, bool > )); |
---|
95 | <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./bool.html" class="identifier">bool_</a><true>, <a class="reference" href="./bool.html"><tt class="literal"><span class="pre">true_</span></tt></a> > )); } |
---|
96 | <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./bool.html" class="identifier">bool_</a><true>::type, <a href="./bool.html" class="identifier">bool_</a><true> > )); |
---|
97 | <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./bool.html" class="identifier">bool_</a><true>::value, ==, true ); |
---|
98 | assert( <a href="./bool.html" class="identifier">bool_</a><true>() == true ); |
---|
99 | </pre> |
---|
100 | </div> |
---|
101 | <div class="section" id="bool-see-also"> |
---|
102 | <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> |
---|
103 | <p><a class="reference" href="./data-types.html">Data Types</a>, <a class="reference" href="./integral-constant.html">Integral Constant</a>, <a class="refentry reference" href="./int.html"><tt class="refentry literal"><span class="pre">int_</span></tt></a>, <a class="refentry reference" href="./long.html"><tt class="refentry literal"><span class="pre">long_</span></tt></a>, <a class="refentry reference" href="./integral-c.html"><tt class="refentry literal"><span class="pre">integral_c</span></tt></a></p> |
---|
104 | <!-- modtime: November 10, 2004 04:44:19 +0000 --> |
---|
105 | <!-- Data Types/Numeric//int_ |20 --> |
---|
106 | </div> |
---|
107 | </div> |
---|
108 | |
---|
109 | <div class="footer-separator"></div> |
---|
110 | <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./numeric.html" class="navigation-link">Prev</a> <a href="./int.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group">Back <a href="./int.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> |
---|
111 | </tr></table></body> |
---|
112 | </html> |
---|