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: negate</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="./modulus.html" class="navigation-link">Prev</a> <a href="./comparisons.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Back</a> Along</span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./arithmetic-operations.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="./metafunctions.html" class="navigation-link">Metafunctions</a> / <a href="./arithmetic-operations.html" class="navigation-link">Arithmetic Operations</a> / <a href="./negate.html" class="navigation-link">negate</a></td> |
---|
13 | </tr></table><div class="header-separator"></div> |
---|
14 | <div class="section" id="negate"> |
---|
15 | <h1><a class="toc-backref" href="./arithmetic-operations.html#id467" name="negate">negate</a></h1> |
---|
16 | <div class="section" id="negate-synopsis"> |
---|
17 | <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> |
---|
18 | <pre class="literal-block"> |
---|
19 | template< |
---|
20 | typename T |
---|
21 | > |
---|
22 | struct <a href="./negate.html" class="identifier">negate</a> |
---|
23 | { |
---|
24 | typedef <em>unspecified</em> type; |
---|
25 | }; |
---|
26 | </pre> |
---|
27 | </div> |
---|
28 | <div class="section" id="negate-description"> |
---|
29 | <h3><a class="subsection-title" href="#description" name="description">Description</a></h3> |
---|
30 | <p>Returns the negative (additive inverse) of its argument.</p> |
---|
31 | </div> |
---|
32 | <div class="section" id="negate-header"> |
---|
33 | <h3><a class="subsection-title" href="#header" name="header">Header</a></h3> |
---|
34 | <pre class="literal-block"> |
---|
35 | #include <<a href="../../../../boost/mpl/negate.hpp" class="header">boost/mpl/negate.hpp</a>> |
---|
36 | #include <<a href="../../../../boost/mpl/arithmetic.hpp" class="header">boost/mpl/arithmetic.hpp</a>> |
---|
37 | </pre> |
---|
38 | </div> |
---|
39 | <div class="section" id="negate-model-of"> |
---|
40 | <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> |
---|
41 | <p><a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a></p> |
---|
42 | </div> |
---|
43 | <div class="section" id="negate-parameters"> |
---|
44 | <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> |
---|
45 | <table border="1" class="table"> |
---|
46 | <colgroup> |
---|
47 | <col width="17%" /> |
---|
48 | <col width="30%" /> |
---|
49 | <col width="53%" /> |
---|
50 | </colgroup> |
---|
51 | <thead valign="bottom"> |
---|
52 | <tr><th>Parameter</th> |
---|
53 | <th>Requirement</th> |
---|
54 | <th>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><a class="reference" href="./integral-constant.html">Integral Constant</a></td> |
---|
60 | <td>Operation's argument.</td> |
---|
61 | </tr> |
---|
62 | </tbody> |
---|
63 | </table> |
---|
64 | <p>[<em>Note:</em> The requirements listed in this specification |
---|
65 | are the ones imposed by the default implementation. See <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a> concept |
---|
66 | for the details on how to provide an implementation for a user-defined numeric type |
---|
67 | that does not satisfy the <a class="reference" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p> |
---|
68 | </div> |
---|
69 | <div class="section" id="negate-expression-semantics"> |
---|
70 | <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> |
---|
71 | <p>For any <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt>:</p> |
---|
72 | <pre class="literal-block"> |
---|
73 | typedef <a href="./negate.html" class="identifier">negate</a><c>::type r; |
---|
74 | </pre> |
---|
75 | <table class="field-list" frame="void" rules="none"> |
---|
76 | <col class="field-name" /> |
---|
77 | <col class="field-body" /> |
---|
78 | <tbody valign="top"> |
---|
79 | <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./integral-constant.html">Integral Constant</a>.</td> |
---|
80 | </tr> |
---|
81 | <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p> |
---|
82 | <pre class="last literal-block"> |
---|
83 | typedef <a href="./integral-c.html" class="identifier">integral_c</a>< c::<a href="./value-type.html" class="identifier">value_type</a>, ( -c::value ) > r; |
---|
84 | </pre> |
---|
85 | </td> |
---|
86 | </tr> |
---|
87 | </tbody> |
---|
88 | </table> |
---|
89 | <!-- .......................................................................... --> |
---|
90 | <pre class="literal-block"> |
---|
91 | typedef <a href="./negate.html" class="identifier">negate</a><c> r; |
---|
92 | </pre> |
---|
93 | <table class="field-list" frame="void" rules="none"> |
---|
94 | <col class="field-name" /> |
---|
95 | <col class="field-body" /> |
---|
96 | <tbody valign="top"> |
---|
97 | <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./integral-constant.html">Integral Constant</a>.</td> |
---|
98 | </tr> |
---|
99 | <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p> |
---|
100 | <pre class="last literal-block"> |
---|
101 | struct r : <a href="./negate.html" class="identifier">negate</a><c>::type {}; |
---|
102 | </pre> |
---|
103 | </td> |
---|
104 | </tr> |
---|
105 | </tbody> |
---|
106 | </table> |
---|
107 | </div> |
---|
108 | <div class="section" id="negate-complexity"> |
---|
109 | <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3> |
---|
110 | <p>Amortized constant time.</p> |
---|
111 | </div> |
---|
112 | <div class="section" id="negate-example"> |
---|
113 | <h3><a class="subsection-title" href="#example" name="example">Example</a></h3> |
---|
114 | <pre class="literal-block"> |
---|
115 | typedef <a href="./negate.html" class="identifier">negate</a>< <a href="./int.html" class="identifier">int_</a><-10> >::type r; |
---|
116 | <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, 10 ); |
---|
117 | <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< r::<a href="./value-type.html" class="identifier">value_type</a>, int > )); |
---|
118 | </pre> |
---|
119 | </div> |
---|
120 | <div class="section" id="negate-see-also"> |
---|
121 | <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> |
---|
122 | <p><a class="reference" href="./arithmetic-operations.html">Arithmetic Operations</a>, <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a>, <a class="refentry reference" href="./numeric-cast.html"><tt class="refentry literal"><span class="pre">numeric_cast</span></tt></a>, <a class="refentry reference" href="./plus.html"><tt class="refentry literal"><span class="pre">plus</span></tt></a>, <a class="refentry reference" href="./minus.html"><tt class="refentry literal"><span class="pre">minus</span></tt></a>, <a class="refentry reference" href="./times.html"><tt class="refentry literal"><span class="pre">times</span></tt></a></p> |
---|
123 | <!-- modtime: November 10, 2004 05:04:19 +0000 --> |
---|
124 | </div> |
---|
125 | </div> |
---|
126 | |
---|
127 | <div class="footer-separator"></div> |
---|
128 | <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Prev</a> <a href="./comparisons.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Back</a> Along</span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./arithmetic-operations.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> |
---|
129 | </tr></table></body> |
---|
130 | </html> |
---|