1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
|
.. Metafunctions/Bitwise Operations//shift_right
shift_right
===========
Synopsis
--------
.. parsed-literal::
template<
typename T
, typename Shift
>
struct shift_right
{
typedef |unspecified| type;
};
Description
-----------
Returns the result of bitwise *shift right* (``>>``) operation on ``T``.
Header
------
.. parsed-literal::
#include <boost/mpl/shift_right.hpp>
#include <boost/mpl/bitwise.hpp>
Model of
--------
|Numeric Metafunction|
Parameters
----------
+---------------+-------------------------------+---------------------------+
| Parameter | Requirement | Description |
+===============+===============================+===========================+
| ``T`` | |Integral Constant| | A value to shift. |
+---------------+-------------------------------+---------------------------+
| ``Shift`` | Unsigned |Integral Constant| | A shift distance. |
+---------------+-------------------------------+---------------------------+
|Note:| |numeric metafunction note| |-- end note|
Expression semantics
--------------------
For arbitrary |Integral Constant| ``c`` and unsigned |Integral Constant| ``shift``:
.. parsed-literal::
typedef shift_right<c,shift>::type r;
:Return type:
|Integral Constant|.
:Semantics:
Equivalent to
.. parsed-literal::
typedef integral_c<
c::value_type
, ( c::value >> shift::value )
> r;
.. ..........................................................................
.. parsed-literal::
typedef shift_right<c,shift> r;
:Return type:
|Integral Constant|.
:Semantics:
Equivalent to
.. parsed-literal::
struct r : shift_right<c,shift>::type {};
Complexity
----------
Amortized constant time.
Example
-------
.. parsed-literal::
typedef integral_c<unsigned,0> u0;
typedef integral_c<unsigned,1> u1;
typedef integral_c<unsigned,2> u2;
typedef integral_c<unsigned,8> u8;
BOOST_MPL_ASSERT_RELATION( (shift_right<u0,u0>::value), ==, 0 );
BOOST_MPL_ASSERT_RELATION( (shift_right<u1,u0>::value), ==, 1 );
BOOST_MPL_ASSERT_RELATION( (shift_right<u1,u1>::value), ==, 0 );
BOOST_MPL_ASSERT_RELATION( (shift_right<u2,u1>::value), ==, 1 );
BOOST_MPL_ASSERT_RELATION( (shift_right<u8,u1>::value), ==, 4 );
See also
--------
|Bitwise Operations|, |Numeric Metafunction|, |numeric_cast|, |shift_left|, |bitand_|
.. copyright:: Copyright 2001-2009 Aleksey Gurtovoy and David Abrahams
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|