Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/shift-right.html @ 29

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

updated boost from 1_33_1 to 1_34_1
File size: 9.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<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: shift_right</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<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>
15<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>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="shift-right">
18<h1><a class="toc-backref" href="./bitwise-operations.html#id484" name="shift-right">shift_right</a></h1>
19<div class="section" id="bitwise-shift-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt; 
23      typename T
24    , typename Shift
25    &gt;
26struct <a href="./shift-right.html" class="identifier">shift_right</a>
27{
28    typedef <em>unspecified</em> type;
29};
30</pre>
31</div>
32<div class="section" id="bitwise-shift-description">
33<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
34<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>
35</div>
36<div class="section" id="bitwise-shift-header">
37<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
38<pre class="literal-block">
39#include &lt;<a href="../../../../boost/mpl/shift_right.hpp" class="header">boost/mpl/shift_right.hpp</a>&gt;
40#include &lt;<a href="../../../../boost/mpl/bitwise.hpp" class="header">boost/mpl/bitwise.hpp</a>&gt;
41</pre>
42</div>
43<div class="section" id="bitwise-shift-model-of">
44<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
45<p><a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
46</div>
47<div class="section" id="bitwise-shift-parameters">
48<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
49<table border="1" class="table">
50<colgroup>
51<col width="21%" />
52<col width="42%" />
53<col width="37%" />
54</colgroup>
55<thead valign="bottom">
56<tr><th>Parameter</th>
57<th>Requirement</th>
58<th>Description</th>
59</tr>
60</thead>
61<tbody valign="top">
62<tr><td><tt class="literal"><span class="pre">T</span></tt></td>
63<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
64<td>A value to shift.</td>
65</tr>
66<tr><td><tt class="literal"><span class="pre">Shift</span></tt></td>
67<td>Unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a></td>
68<td>A shift distance.</td>
69</tr>
70</tbody>
71</table>
72<p>[<em>Note:</em> The requirements listed in this specification
73are the ones imposed by the default implementation. See <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
74for the details on how to provide an implementation for a user-defined numeric type
75that does not satisfy the <a class="reference" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
76</div>
77<div class="section" id="bitwise-shift-expression-semantics">
78<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
79<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>
80<pre class="literal-block">
81typedef <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt;::type r;
82</pre>
83<table class="field-list" frame="void" rules="none">
84<col class="field-name" />
85<col class="field-body" />
86<tbody valign="top">
87<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>
88</tr>
89<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
90<pre class="last literal-block">
91typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;
92      c::<a href="./value-type.html" class="identifier">value_type</a>
93    , ( c::value &gt;&gt; shift::value )
94    &gt; r;
95</pre>
96</td>
97</tr>
98</tbody>
99</table>
100<!-- .......................................................................... -->
101<pre class="literal-block">
102typedef <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt; r;
103</pre>
104<table class="field-list" frame="void" rules="none">
105<col class="field-name" />
106<col class="field-body" />
107<tbody valign="top">
108<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>
109</tr>
110<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
111<pre class="last literal-block">
112struct r : <a href="./shift-right.html" class="identifier">shift_right</a>&lt;c,shift&gt;::type {};
113</pre>
114</td>
115</tr>
116</tbody>
117</table>
118</div>
119<div class="section" id="bitwise-shift-complexity">
120<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
121<p>Amortized constant time.</p>
122</div>
123<div class="section" id="bitwise-shift-example">
124<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
125<pre class="literal-block">
126typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,0&gt; u0;
127typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,1&gt; u1;
128typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,2&gt; u2;
129typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;unsigned,8&gt; u8;
130
131<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 );
132<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 );
133<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 );
134<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 );
135<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 );
136</pre>
137</div>
138<div class="section" id="bitwise-shift-see-also">
139<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
140<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>
141<!-- modtime: November 10, 2004 04:31:51 +0000 -->
142</div>
143</div>
144
145<div class="footer-separator"></div>
146<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>
147</tr></table></body>
148</html>
Note: See TracBrowser for help on using the repository browser.