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: bind</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
2009-08-17 11:30:52 +00:00
< table class = "header" >< tr class = "header" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./lambda.html" class = "navigation-link" > Prev</ a > < a href = "./quote.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./lambda.html" class = "navigation-link" > Back</ a > < a href = "./quote.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./composition-and-argument-binding.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 = "./composition-and-argument-binding.html" class = "navigation-link" > Composition and Argument Binding</ a > / < a href = "./bind.html" class = "navigation-link" > bind</ a ></ td >
2004-11-28 03:35:12 +00:00
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "bind" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./composition-and-argument-binding.html#id1531" > bind</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id929" >
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 F
>
struct bind0
{
// < em > unspecified</ em >
// < em > ...</ em >
};
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename F, typename A1
>
struct bind1
{
// < em > unspecified</ em >
// < em > ...</ em >
};
< em > ...</ em >
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename F, typename A1,< em > ...</ em > typename An
>
struct < a href = "./bind.html" class = "identifier" > bind</ a >< em > n</ em >
{
// < em > unspecified</ em >
// < em > ...</ em >
};
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename F
, typename A1 = < em > unspecified</ em >
< em > ...</ em >
, typename An = < em > unspecified</ em >
>
struct < a href = "./bind.html" class = "identifier" > bind</ a >
{
// < em > unspecified</ em >
// < em > ...</ em >
};
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id930" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< tt class = "literal" >< span class = "pre" >< a href = "./bind.html" class = "identifier" > bind</ a ></ span ></ tt > is a higher-order primitive for < a class = "reference internal" href = "./metafunction-class.html" > Metafunction Class</ a > composition
and argument binding. In essence, it's a compile-time counterpart of
the similar run-time functionality provided by < a class = "reference external" href = "http://www.boost.org/libs/bind/bind.html" target = "_top" > Boost.Bind</ a > and < a class = "reference external" href = "http://www.boost.org/libs/lambda/doc/index.html" target = "_top" > Boost.Lambda</ a >
2004-11-28 03:35:12 +00:00
libraries.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id931" >
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/bind.hpp" class = "header" > boost/mpl/bind.hpp</ a > >
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id932" >
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 = "./metafunction-class.html" > Metafunction Class</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id933" >
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 = "15%" />
< col width = "36%" />
< col width = "48%" />
</ 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" > F</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./metafunction-class.html" > Metafunction Class</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > An metafunction class to perform binding on.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > A1</ span ></ tt > ,... < tt class = "literal" >< span class = "pre" > An</ span ></ tt ></ td >
< td > Any type</ td >
< td > Arguments to bind.</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id934" >
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 any < a class = "reference internal" href = "./metafunction-class.html" > Metafunction Class</ a > < tt class = "literal" >< span class = "pre" > f</ span ></ tt > and arbitrary types < tt class = "literal" >< span class = "pre" > a1</ span ></ tt > ,... < tt class = "literal" >< span class = "pre" > an</ span ></ tt > :</ p >
2004-11-28 03:35:12 +00:00
< pre class = "literal-block" >
typedef < a href = "./bind.html" class = "identifier" > bind</ a > < f,a1,...a< em > n</ em > > g;
typedef < a href = "./bind.html" class = "identifier" > bind</ a >< em > n</ em > < f,a1,...a< em > n</ em > > g;
</ 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" >< a class = "reference internal" href = "./metafunction-class.html" > Metafunction Class</ a ></ td >
2004-11-28 03:35:12 +00:00
</ tr >
</ tbody >
</ table >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" id = "bind-semantics" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Semantics:</ th >< td class = "field-body" >< p class = "first" > Equivalent to</ p >
< pre class = "literal-block" >
struct g
{
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename U1 = < em > unspecified</ em >
< em > ...</ em >
, typename U< em > n</ em > = < em > unspecified</ em >
>
struct < a href = "./apply.html" class = "identifier" > apply</ a >
: < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< em > n</ em > <
2009-08-17 11:30:52 +00:00
typename h0< f,U1,< em > ...</ em > U< em > n</ em > > ::type
, typename h1< a1,U1,< em > ...</ em > U< em > n</ em > > ::type
2004-11-28 03:35:12 +00:00
< em > ...</ em >
2009-08-17 11:30:52 +00:00
, typename h< em > n</ em > < a< em > n</ em > ,U1,< em > ...</ em > U< em > n</ em > > ::type
2004-11-28 03:35:12 +00:00
>
{
};
};
</ pre >
< p > where < tt class = "literal" >< span class = "pre" > h</ span ></ tt >< em > k</ em > is equivalent to</ p >
< pre class = "literal-block" >
template< typename X, typename U1,< em > ...</ em > typename U< em > n</ em > > struct h< em > k</ em >
: < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< em > n</ em > < X,U1,< em > ...</ em > U< em > n</ em > >
{
};
</ pre >
2009-08-17 11:30:52 +00:00
< p > if < tt class = "literal" >< span class = "pre" > f</ span ></ tt > or < tt class = "literal" >< span class = "pre" > a</ span ></ tt >< em > k</ em > is a < a class = "reference internal" href = "./terminology.html#bind-expression" > bind expression</ a > or a < a class = "reference internal" href = "./placeholders.html#placeholder" > placeholder</ a > , and</ p >
2004-11-28 03:35:12 +00:00
< pre class = "literal-block" >
template< typename X, typename U1,< em > ...</ em > typename U< em > n</ em > > struct h< em > k</ em >
{
typedef X type;
};
</ pre >
2009-08-17 11:30:52 +00:00
< p class = "last" > otherwise. [< em > Note:</ em > Every < tt class = "literal" >< span class = "pre" > n</ span ></ tt > th appearance of the < a class = "reference internal" href = "./placeholders.html" > unnamed placeholder</ a >
2004-11-28 03:35:12 +00:00
in the < tt class = "literal" >< span class = "pre" >< a href = "./bind.html" class = "identifier" > bind</ a > < f,a1,...an> </ span ></ tt > specialization is replaced with the corresponding
numbered placeholder < tt class = "literal" >< span class = "pre" > _</ span ></ tt >< em > n</ em > — < em > end note</ em > ]</ p >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id936" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
struct f1
{
template< typename T1 > struct < a href = "./apply.html" class = "identifier" > apply</ a >
{
typedef T1 type;
};
};
struct f5
{
template< typename T1, typename T2, typename T3, typename T4, typename T5 >
struct < a href = "./apply.html" class = "identifier" > apply</ a >
{
typedef T5 type;
};
};
2009-08-17 11:30:52 +00:00
typedef < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< tt class = "literal" >< span class = "pre" > 1</ span ></ tt > <
< a href = "./bind.html" class = "identifier" > bind</ a >< tt class = "literal" >< span class = "pre" > 1</ span ></ tt > < f1,< a href = "./placeholders.html" class = "identifier" > _1</ a > >
, int
2004-11-28 03:35:12 +00:00
> ::type r11;
2009-08-17 11:30:52 +00:00
typedef < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< tt class = "literal" >< span class = "pre" > 5</ span ></ tt > <
< a href = "./bind.html" class = "identifier" > bind</ a >< tt class = "literal" >< span class = "pre" > 1</ span ></ tt > < f1,< a href = "./placeholders.html" class = "identifier" > _5</ a > >
, void,void,void,void,int
2004-11-28 03:35:12 +00:00
> ::type r12;
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< r11,int> ));
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< r12,int> ));
2009-08-17 11:30:52 +00:00
typedef < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< tt class = "literal" >< span class = "pre" > 5</ span ></ tt > <
< a href = "./bind.html" class = "identifier" > bind</ a >< tt class = "literal" >< span class = "pre" > 5</ span ></ tt > < f5,< a href = "./placeholders.html" class = "identifier" > _1</ a > ,< a href = "./placeholders.html" class = "identifier" > _2</ a > ,< a href = "./placeholders.html" class = "identifier" > _3</ a > ,< a href = "./placeholders.html" class = "identifier" > _4</ a > ,< a href = "./placeholders.html" class = "identifier" > _5</ a > >
, void,void,void,void,int
2004-11-28 03:35:12 +00:00
> ::type r51;
typedef < a href = "./apply-wrap.html" class = "identifier" > apply_wrap</ a >< tt class = "literal" >< span class = "pre" > 5</ span ></ tt > <
2009-08-17 11:30:52 +00:00
< a href = "./bind.html" class = "identifier" > bind</ a >< tt class = "literal" >< span class = "pre" > 5</ span ></ tt > < f5,< a href = "./placeholders.html" class = "identifier" > _5</ a > ,< a href = "./placeholders.html" class = "identifier" > _4</ a > ,< a href = "./placeholders.html" class = "identifier" > _3</ a > ,< a href = "./placeholders.html" class = "identifier" > _2</ a > ,< a href = "./placeholders.html" class = "identifier" > _1</ a > >
2004-11-28 03:35:12 +00:00
, int,void,void,void,void
> ::type r52;
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< r51,int> ));
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< r52,int> ));
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id937" >
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 = "./composition-and-argument-binding.html" > Composition and Argument Binding</ a > , < a class = "reference internal" href = "./invocation.html" > invocation</ a > , < a class = "reference internal" href = "./placeholders.html" > Placeholders</ a > , < a class = "reference internal" href = "./lambda.html" > lambda</ a > , < a class = "reference internal" href = "./quote.html" > quote</ a > ,
< a class = "reference internal" href = "./protect.html" > protect</ a > , < a class = "reference internal" href = "./apply.html" > apply</ a > , < a class = "reference internal" href = "./apply-wrap.html" > apply_wrap</ a ></ p >
2004-11-28 03:35:12 +00:00
<!-- Metafunctions/Composition and Argument Binding//quote |40 -->
</ div >
</ div >
< div class = "footer-separator" ></ div >
2009-08-17 11:30:52 +00:00
< table class = "footer" >< tr class = "footer" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./lambda.html" class = "navigation-link" > Prev</ a > < a href = "./quote.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./lambda.html" class = "navigation-link" > Back</ a > < a href = "./quote.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./composition-and-argument-binding.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 >< 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 >
