shift_right

Synopsis

template< 
      typename T
    , typename Shift
    >
struct shift_right
{
    typedef unspecified type;
};

Description

Returns the result of bitwise shift right (>>) operation on T.

Header

#include <boost/mpl/shift_right.hpp>
#include <boost/mpl/bitwise.hpp>

Parameters

Parameter	Requirement	Description
`T`	Integral Constant	A value to shift.
`Shift`	Unsigned Integral Constant	A shift distance.

[Note: The requirements listed in this specification are the ones imposed by the default implementation. See Numeric Metafunction concept for the details on how to provide an implementation for a user-defined numeric type that does not satisfy the Integral Constant requirements. — end note]

Expression semantics

For arbitrary Integral Constant c and unsigned Integral Constant shift:

typedef shift_right<c,shift>::type r;

Return type: Integral Constant.

Semantics:

Return type:	Integral Constant.
Semantics:	Equivalent to typedef integral_c< c::value_type , ( c::value >> shift::value ) > r;

Equivalent to

typedef integral_c<
      c::value_type
    , ( c::value >> shift::value )
    > r;

typedef shift_right<c,shift> r;

Return type: Integral Constant.

Semantics:

Return type:	Integral Constant.
Semantics:	Equivalent to struct r : shift_right<c,shift>::type {};

Equivalent to

struct r : shift_right<c,shift>::type {};

Complexity

Amortized constant time.

Example

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 );