Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/shift-right.html @ 12

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

added boost
File size: 9.5 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: shift_right</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="./shift-left.html" class="navigation-link">Prev</a>&nbsp;<a href="./trivial.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./shift-left.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./bitwise-operations.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="./metafunctions.html" class="navigation-link">Metafunctions</a> / <a href="./bitwise-operations.html" class="navigation-link">Bitwise Operations</a> / <a href="./shift-right.html" class="navigation-link">shift_right</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="shift-right">
15<h1><a class="toc-backref" href="./bitwise-operations.html#id484" name="shift-right">shift_right</a></h1>
16<div class="section" id="bitwise-shift-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt; 
20      typename T
21    , typename Shift
22    &gt;
23struct <a href="./shift-right.html" class="identifier">shift_right</a>
24{
25    typedef <em>unspecified</em> type;
26};
27</pre>
28</div>
29<div class="section" id="bitwise-shift-description">
30<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
31<p>Returns the result of bitwise <em>shift right</em> (<tt class="literal"><span class="pre">&gt;&gt;</span></tt>) operation on <tt class="literal"><span class="pre">T</span></tt>.</p>
32</div>
33<div class="section" id="bitwise-shift-header">
34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
35<pre class="literal-block">
36#include &lt;<a href="../../../../boost/mpl/shift_right.hpp" class="header">boost/mpl/shift_right.hpp</a>&gt;
37#include &lt;<a href="../../../../boost/mpl/bitwise.hpp" class="header">boost/mpl/bitwise.hpp</a>&gt;
38</pre>
39</div>
40<div class="section" id="bitwise-shift-model-of">
41<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
42<p><a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
43</div>
44<div class="section" id="bitwise-shift-parameters">
45<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
46<table border="1" class="table">
47<colgroup>
48<col width="21%" />
49<col width="42%" />
50<col width="37%" />
51</colgroup>
52<thead valign="bottom">
53<tr><th>Parameter</th>
54<th>Requirement</th>
55<th>Description</th>
56</tr>
57</thead>
58<tbody valign="top">
59<tr><td><tt class="literal"><span class="pre">T</span></tt></td>
60<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
61<td>A value to shift.</td>
62</tr>
63<tr><td><tt class="literal"><span class="pre">Shift</span></tt></td>
64<td>Unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a></td>
65<td>A shift distance.</td>
66</tr>
67</tbody>
68</table>
69<p>[<em>Note:</em> The requirements listed in this specification
70are the ones imposed by the default implementation. See <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
71for the details on how to provide an implementation for a user-defined numeric type
72that does not satisfy the <a class="reference" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
73</div>
74<div class="section" id="bitwise-shift-expression-semantics">
75<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
76<p>For arbitrary <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> and unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">shift</span></tt>:</p>
77<pre class="literal-block">
78typedef <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt;::type r;
79</pre>
80<table class="field-list" frame="void" rules="none">
81<col class="field-name" />
82<col class="field-body" />
83<tbody valign="top">
84<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>
85</tr>
86<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
87<pre class="last literal-block">
88typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;
89      c::<a href="./value-type.html" class="identifier">value_type</a>
90    , ( c::value &gt;&gt; shift::value )
91    &gt; r;
92</pre>
93</td>
94</tr>
95</tbody>
96</table>
97<!-- .......................................................................... -->
98<pre class="literal-block">
99typedef <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt; r;
100</pre>
101<table class="field-list" frame="void" rules="none">
102<col class="field-name" />
103<col class="field-body" />
104<tbody valign="top">
105<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>
106</tr>
107<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
108<pre class="last literal-block">
109struct r : <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt;::type {};
110</pre>
111</td>
112</tr>
113</tbody>
114</table>
115</div>
116<div class="section" id="bitwise-shift-complexity">
117<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
118<p>Amortized constant time.</p>
119</div>
120<div class="section" id="bitwise-shift-example">
121<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
122<pre class="literal-block">
123typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,0&gt; u0;
124typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,1&gt; u1;
125typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,2&gt; u2;
126typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,8&gt; u8;
127
128<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (<a href="./shift-right.html" class="identifier">shift_right</a>&lt;u0,u0&gt;::value), ==, 0 );
129<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (<a href="./shift-right.html" class="identifier">shift_right</a>&lt;u1,u0&gt;::value), ==, 1 );
130<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (<a href="./shift-right.html" class="identifier">shift_right</a>&lt;u1,u1&gt;::value), ==, 0 );
131<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (<a href="./shift-right.html" class="identifier">shift_right</a>&lt;u2,u1&gt;::value), ==, 1 );
132<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( (<a href="./shift-right.html" class="identifier">shift_right</a>&lt;u8,u1&gt;::value), ==, 4 );
133</pre>
134</div>
135<div class="section" id="bitwise-shift-see-also">
136<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
137<p><a class="reference" href="./bitwise-operations.html">Bitwise 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="./shift-left.html"><tt class="refentry literal"><span class="pre">shift_left</span></tt></a>, <a class="refentry reference" href="./bitand.html"><tt class="refentry literal"><span class="pre">bitand_</span></tt></a></p>
138<!-- modtime: November 10, 2004 04:31:51 +0000 -->
139</div>
140</div>
141
142<div class="footer-separator"></div>
143<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./shift-left.html" class="navigation-link">Prev</a>&nbsp;<a href="./trivial.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./shift-left.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./bitwise-operations.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>
144</tr></table></body>
145</html>
Note: See TracBrowser for help on using the repository browser.