2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" />
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: shift_left</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< table class = "header" >< tr class = "header" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./bitxor.html" class = "navigation-link" > Prev</ a > < a href = "./shift-right.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bitxor.html" class = "navigation-link" > Back</ a > < a href = "./shift-right.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bitwise-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 >
< 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-left.html" class = "navigation-link" > shift_left</ a ></ td >
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "shift-left" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./bitwise-operations.html#id1557" > shift_left</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1116" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis</ a ></ h3 >
< pre class = "literal-block" >
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename T
, typename Shift
>
struct < a href = "./shift-left.html" class = "identifier" > shift_left</ a >
{
typedef < em > unspecified</ em > type;
};
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1117" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
< p > Returns the result of bitwise < em > shift left</ em > (< tt class = "literal" >< span class = "pre" > << </ span ></ tt > ) operation on < tt class = "literal" >< span class = "pre" > T</ span ></ tt > .</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1118" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#header" name = "header" > Header</ a ></ h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/shift_left.hpp" class = "header" > boost/mpl/shift_left.hpp</ a > >
#include < < a href = "../../../../boost/mpl/bitwise.hpp" class = "header" > boost/mpl/bitwise.hpp</ a > >
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1119" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#model-of" name = "model-of" > Model of</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1120" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "21%" />
< col width = "42%" />
< col width = "37%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Parameter</ th >
< th class = "head" > Requirement</ th >
< th class = "head" > Description</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" > T</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > A value to shift.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > Shift</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td > Unsigned < a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > A shift distance.</ td >
</ tr >
</ tbody >
</ table >
< p > [< em > Note:</ em > The requirements listed in this specification
2009-08-17 11:30:52 +00:00
are the ones imposed by the default implementation. See < a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction</ a > concept
for the details on how to provide an implementation for a user-defined numeric type
that does not satisfy the < a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > requirements. — < em > end note</ em > ]</ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1121" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p > For arbitrary < a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > < tt class = "literal" >< span class = "pre" > c</ span ></ tt > and unsigned < a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > < tt class = "literal" >< span class = "pre" > shift</ span ></ tt > :</ p >
2004-11-28 03:35:12 +00:00
< pre class = "literal-block" >
2009-08-17 11:30:52 +00:00
typedef < a href = "./shift-left.html" class = "identifier" > shift_left</ a > < c,shift> ::type r;
2004-11-28 03:35:12 +00:00
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" >< th class = "field-name" > Return type:</ th >< td class = "field-body" >< p class = "first" >< a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > .</ p >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
< tr class = "field" >< th class = "field-name" > Semantics:</ th >< td class = "field-body" >< p class = "first" > Equivalent to</ p >
< pre class = "last literal-block" >
typedef < a href = "./integral-c.html" class = "identifier" > integral_c</ a > <
c::< a href = "./value-type.html" class = "identifier" > value_type</ a >
, ( c::value << shift::value )
> r;
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
<!-- .......................................................................... -->
< pre class = "literal-block" >
2009-08-17 11:30:52 +00:00
typedef < a href = "./shift-left.html" class = "identifier" > shift_left</ a > < c,shift> r;
2004-11-28 03:35:12 +00:00
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" >< th class = "field-name" > Return type:</ th >< td class = "field-body" >< p class = "first" >< a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > .</ p >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
< tr class = "field" >< th class = "field-name" > Semantics:</ th >< td class = "field-body" >< p class = "first" > Equivalent to</ p >
< pre class = "last literal-block" >
struct r : < a href = "./shift-left.html" class = "identifier" > shift_left</ a > < c,shift> ::type {};
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1122" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#complexity" name = "complexity" > Complexity</ a ></ h3 >
< p > Amortized constant time.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1123" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
typedef < a href = "./integral-c.html" class = "identifier" > integral_c</ a > < unsigned,0> u0;
typedef < a href = "./integral-c.html" class = "identifier" > integral_c</ a > < unsigned,1> u1;
typedef < a href = "./integral-c.html" class = "identifier" > integral_c</ a > < unsigned,2> u2;
typedef < a href = "./integral-c.html" class = "identifier" > integral_c</ a > < unsigned,8> u8;
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( (< a href = "./shift-left.html" class = "identifier" > shift_left</ a > < u0,u0> ::value), ==, 0 );
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( (< a href = "./shift-left.html" class = "identifier" > shift_left</ a > < u1,u0> ::value), ==, 1 );
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( (< a href = "./shift-left.html" class = "identifier" > shift_left</ a > < u1,u1> ::value), ==, 2 );
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( (< a href = "./shift-left.html" class = "identifier" > shift_left</ a > < u2,u1> ::value), ==, 4 );
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( (< a href = "./shift-left.html" class = "identifier" > shift_left</ a > < u8,u1> ::value), ==, 16 );
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1124" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./bitwise-operations.html" > Bitwise Operations</ a > , < a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction</ a > , < a class = "reference internal" href = "./numeric-cast.html" > numeric_cast</ a > , < a class = "reference internal" href = "./shift-right.html" > shift_right</ a > , < a class = "reference internal" href = "./bitand.html" > bitand_</ a ></ p >
2004-11-28 03:35:12 +00:00
<!-- Metafunctions/Bitwise Operations//shift_right -->
</ div >
</ div >
< div class = "footer-separator" ></ div >
< table class = "footer" >< tr class = "footer" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./bitxor.html" class = "navigation-link" > Prev</ a > < a href = "./shift-right.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bitxor.html" class = "navigation-link" > Back</ a > < a href = "./shift-right.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bitwise-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 >
2009-08-17 11:30:52 +00:00
< td >< div class = "copyright-footer" >< div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</ div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a class = "reference external" href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt</ a > )</ div ></ td ></ tr ></ table ></ body >
2004-11-28 03:35:12 +00:00
</ html >
