forked from boostorg/bind
Merge branch 'develop'
This commit is contained in:
Peter Dimov
@@ -147,8 +147,8 @@ bind(g, _1, _1, _1)(x, y, z); // g(x, x, x)
|
|||||||
|
|
||||||
bind(f, i, _1);
|
bind(f, i, _1);
|
||||||
</pre>
|
</pre>
|
||||||
<p>a copy of the value of <b>i</b> is stored into the function object. <A href="ref.html">
|
<p>a copy of the value of <b>i</b> is stored into the function object. <A href="../core/doc/html/core/ref.html">
|
||||||
boost::ref</A> and <A href="ref.html">boost::cref</A> can be used to make
|
boost::ref</A> and <A href="../core/doc/html/core/ref.html">boost::cref</A> can be used to make
|
||||||
the function object store a reference to an object, rather than a copy:
|
the function object store a reference to an object, rather than a copy:
|
||||||
</p>
|
</p>
|
||||||
<pre>int i = 5;
|
<pre>int i = 5;
|
||||||
@@ -737,7 +737,7 @@ namespace
|
|||||||
a nonnegative integer, is defined as:</p>
|
a nonnegative integer, is defined as:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>
|
<li>
|
||||||
<tt>x.get()</tt>, when <tt>x</tt> is of type <tt><A href="ref.html">boost::reference_wrapper</A><T></tt>
|
<tt>x.get()</tt>, when <tt>x</tt> is of type <tt><A href="../core/doc/html/core/ref.html">boost::reference_wrapper</A><T></tt>
|
||||||
for some type <tt>T</tt>;
|
for some type <tt>T</tt>;
|
||||||
<li>
|
<li>
|
||||||
v<sub>k</sub>, when <tt>x</tt>
|
v<sub>k</sub>, when <tt>x</tt>
|
||||||
@@ -912,7 +912,7 @@ namespace
|
|||||||
<li>
|
<li>
|
||||||
<A href="../config/config.htm">Boost.Config</A>
|
<A href="../config/config.htm">Boost.Config</A>
|
||||||
<li>
|
<li>
|
||||||
<A href="ref.html">boost/ref.hpp</A>
|
<A href="../core/doc/html/core/ref.html">boost/ref.hpp</A>
|
||||||
<li>
|
<li>
|
||||||
<A href="mem_fn.html">boost/mem_fn.hpp</A>
|
<A href="mem_fn.html">boost/mem_fn.hpp</A>
|
||||||
<li>
|
<li>
|
||||||
|
|||||||
@@ -1,14 +0,0 @@
|
|||||||
# Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
|
|
||||||
|
|
||||||
# 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)
|
|
||||||
project bind/doc ;
|
|
||||||
import boostbook : boostbook ;
|
|
||||||
|
|
||||||
boostbook ref-doc : ref.xml
|
|
||||||
:
|
|
||||||
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
|
|
||||||
<xsl:param>boost.root=../../../..
|
|
||||||
;
|
|
||||||
|
|
||||||
262
doc/ref.xml
262
doc/ref.xml
@@ -1,262 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
|
|
||||||
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
|
||||||
<library name="Ref" dirname="ref" id="ref" last-revision="$Date$">
|
|
||||||
<libraryinfo>
|
|
||||||
<author>
|
|
||||||
<firstname>Jaakko</firstname>
|
|
||||||
<surname>Järvi</surname>
|
|
||||||
</author>
|
|
||||||
<author>
|
|
||||||
<firstname>Peter</firstname>
|
|
||||||
<surname>Dimov</surname>
|
|
||||||
</author>
|
|
||||||
<author>
|
|
||||||
<firstname>Douglas</firstname>
|
|
||||||
<surname>Gregor</surname>
|
|
||||||
</author>
|
|
||||||
<author>
|
|
||||||
<firstname>Dave</firstname>
|
|
||||||
<surname>Abrahams</surname>
|
|
||||||
</author>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>1999</year>
|
|
||||||
<year>2000</year>
|
|
||||||
<holder>Jaakko Järvi</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2001</year>
|
|
||||||
<year>2002</year>
|
|
||||||
<holder>Peter Dimov</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2002</year>
|
|
||||||
<holder>David Abrahams</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<legalnotice>
|
|
||||||
<para>Subject to the Boost Software License, Version 1.0. See
|
|
||||||
accompanying file <filename>LICENSE_1_0.txt</filename> or copy at
|
|
||||||
<ulink url="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</ulink>.
|
|
||||||
</para>
|
|
||||||
</legalnotice>
|
|
||||||
|
|
||||||
<librarypurpose>A utility library for passing references to generic functions</librarypurpose>
|
|
||||||
<librarycategory name="category:higher-order"/>
|
|
||||||
</libraryinfo>
|
|
||||||
|
|
||||||
<title>Boost.Ref</title>
|
|
||||||
|
|
||||||
<section id="ref.intro">
|
|
||||||
<title>Introduction</title>
|
|
||||||
|
|
||||||
<using-namespace name="boost"/>
|
|
||||||
|
|
||||||
<para>The Ref library is a small library that is useful for passing
|
|
||||||
references to function templates (algorithms) that would usually
|
|
||||||
take copies of their arguments. It defines the class template
|
|
||||||
<code><classname>boost::reference_wrapper<T></classname></code>,
|
|
||||||
two functions
|
|
||||||
<code><functionname>boost::ref</functionname></code> and
|
|
||||||
<code><functionname>boost::cref</functionname></code> that return
|
|
||||||
instances of <code>boost::reference_wrapper<T></code>,
|
|
||||||
a function <code><functionname>boost::unwrap_ref</functionname></code>
|
|
||||||
that unwraps a <code>boost::reference_wrapper<T></code> or
|
|
||||||
returns a reference to any other type of object, and the
|
|
||||||
two traits classes
|
|
||||||
<code><classname>boost::is_reference_wrapper<T></classname></code>
|
|
||||||
and
|
|
||||||
<code><classname>boost::unwrap_reference<T></classname></code>.</para>
|
|
||||||
|
|
||||||
<para>The purpose of
|
|
||||||
<code>boost::reference_wrapper<T></code> is to
|
|
||||||
contain a reference to an object of type T. It is primarily used to
|
|
||||||
"feed" references to function templates (algorithms) that take their
|
|
||||||
parameter by value.</para>
|
|
||||||
|
|
||||||
<para>To support this usage,
|
|
||||||
<code>boost::reference_wrapper<T></code> provides an implicit
|
|
||||||
conversion to <code>T&</code>. This usually allows the function
|
|
||||||
templates to work on references unmodified.</para>
|
|
||||||
|
|
||||||
<para><code>boost::reference_wrapper<T></code> is
|
|
||||||
both CopyConstructible and Assignable (ordinary references are not
|
|
||||||
Assignable).</para>
|
|
||||||
|
|
||||||
<para>The expression <code>boost::ref(x)</code>
|
|
||||||
returns a
|
|
||||||
<code>boost::reference_wrapper<X>(x)</code> where X
|
|
||||||
is the type of x. Similarly,
|
|
||||||
<code>boost::cref(x)</code> returns a
|
|
||||||
<code>boost::reference_wrapper<X const>(x)</code>.</para>
|
|
||||||
|
|
||||||
<para>The expression <code>boost::unwrap_ref(x)</code>
|
|
||||||
returns a
|
|
||||||
<code>boost::unwrap_reference<X>::type&</code> where X
|
|
||||||
is the type of x.</para>
|
|
||||||
|
|
||||||
<para>The expression
|
|
||||||
<code>boost::is_reference_wrapper<T>::value</code>
|
|
||||||
is true if T is a <code>reference_wrapper</code>, and
|
|
||||||
false otherwise.</para>
|
|
||||||
|
|
||||||
<para>The type-expression
|
|
||||||
<code>boost::unwrap_reference<T>::type</code> is T::type if T
|
|
||||||
is a <code>reference_wrapper</code>, T otherwise.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<library-reference>
|
|
||||||
<header name="boost/ref.hpp">
|
|
||||||
<namespace name="boost">
|
|
||||||
<class name="reference_wrapper">
|
|
||||||
<template>
|
|
||||||
<template-type-parameter name="T"/>
|
|
||||||
</template>
|
|
||||||
<purpose>
|
|
||||||
Contains a reference to an object of type
|
|
||||||
<computeroutput>T</computeroutput>.
|
|
||||||
</purpose>
|
|
||||||
|
|
||||||
<description>
|
|
||||||
<para><computeroutput><classname>reference_wrapper</classname></computeroutput>
|
|
||||||
is primarily used to "feed" references to function templates
|
|
||||||
(algorithms) that take their parameter by value. It provides
|
|
||||||
an implicit conversion to
|
|
||||||
<computeroutput>T&</computeroutput>, which usually allows
|
|
||||||
the function templates to work on references
|
|
||||||
unmodified.</para>
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<typedef name="type"><type>T</type></typedef>
|
|
||||||
|
|
||||||
<constructor specifiers="explicit">
|
|
||||||
<parameter name="t">
|
|
||||||
<paramtype>T&</paramtype>
|
|
||||||
</parameter>
|
|
||||||
|
|
||||||
<effects><simpara>Constructs a
|
|
||||||
<computeroutput><classname>reference_wrapper</classname></computeroutput>
|
|
||||||
object that stores a reference to
|
|
||||||
<computeroutput>t</computeroutput>.</simpara></effects>
|
|
||||||
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</constructor>
|
|
||||||
|
|
||||||
<method-group name="access">
|
|
||||||
<method name="conversion-operator" cv="const">
|
|
||||||
<type>T&</type>
|
|
||||||
<returns><simpara>The stored reference.</simpara></returns>
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</method>
|
|
||||||
|
|
||||||
<method name="get" cv="const">
|
|
||||||
<type>T&</type>
|
|
||||||
<returns><simpara>The stored reference.</simpara></returns>
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</method>
|
|
||||||
|
|
||||||
<method name="get_pointer" cv="const">
|
|
||||||
<type>T*</type>
|
|
||||||
<returns><simpara>A pointer to the object referenced by the stored reference.</simpara></returns>
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</method>
|
|
||||||
</method-group>
|
|
||||||
|
|
||||||
<free-function-group name="constructors">
|
|
||||||
<function name="ref">
|
|
||||||
<type>reference_wrapper<T></type>
|
|
||||||
<parameter name="t">
|
|
||||||
<paramtype>T&</paramtype>
|
|
||||||
</parameter>
|
|
||||||
|
|
||||||
<returns><simpara><computeroutput><classname>reference_wrapper</classname><T>(t)</computeroutput></simpara></returns>
|
|
||||||
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</function>
|
|
||||||
|
|
||||||
<function name="cref">
|
|
||||||
<type>reference_wrapper<T const></type>
|
|
||||||
<parameter name="t">
|
|
||||||
<paramtype>T const&</paramtype>
|
|
||||||
</parameter>
|
|
||||||
|
|
||||||
<returns><simpara><computeroutput><classname>reference_wrapper</classname><T const>(t)</computeroutput></simpara></returns>
|
|
||||||
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</function>
|
|
||||||
</free-function-group>
|
|
||||||
|
|
||||||
<free-function-group name="access">
|
|
||||||
<function name="unwrap_ref">
|
|
||||||
<type>unwrap_reference<T>::type&</type>
|
|
||||||
<parameter name="t">
|
|
||||||
<paramtype>T&</paramtype>
|
|
||||||
</parameter>
|
|
||||||
|
|
||||||
<returns><simpara><computeroutput><classname>unwrap_reference</classname><T>::type&(t)</computeroutput></simpara></returns>
|
|
||||||
|
|
||||||
<throws><simpara>Does not throw.</simpara></throws>
|
|
||||||
</function>
|
|
||||||
</free-function-group>
|
|
||||||
</class>
|
|
||||||
|
|
||||||
<class name="is_reference_wrapper">
|
|
||||||
<template>
|
|
||||||
<template-type-parameter name="T"/>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<purpose>Determine if a type <computeroutput>T</computeroutput> is an instantiation of <computeroutput><classname>reference_wrapper</classname></computeroutput>.</purpose>
|
|
||||||
|
|
||||||
<description>
|
|
||||||
<para>The <computeroutput>value</computeroutput> static
|
|
||||||
constant will be <computeroutput>true</computeroutput> iff the
|
|
||||||
type <computeroutput>T</computeroutput> is a specialization of
|
|
||||||
<computeroutput><classname>reference_wrapper</classname></computeroutput>.</para>
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<static-constant name="value">
|
|
||||||
<type>bool</type>
|
|
||||||
<default><emphasis>unspecified</emphasis></default>
|
|
||||||
</static-constant>
|
|
||||||
</class>
|
|
||||||
|
|
||||||
<class name="unwrap_reference">
|
|
||||||
<template>
|
|
||||||
<template-type-parameter name="T"/>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<purpose>Find the type in a <computeroutput><classname>reference_wrapper</classname></computeroutput>.</purpose>
|
|
||||||
|
|
||||||
<description>
|
|
||||||
<para>The typedef <computeroutput>type</computeroutput> is
|
|
||||||
<computeroutput>T::type</computeroutput> if
|
|
||||||
<computeroutput>T</computeroutput> is a
|
|
||||||
<computeroutput><classname>reference_wrapper</classname></computeroutput>,
|
|
||||||
<computeroutput>T</computeroutput> otherwise.</para>
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<typedef name="type"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
||||||
</class>
|
|
||||||
</namespace>
|
|
||||||
</header>
|
|
||||||
</library-reference>
|
|
||||||
|
|
||||||
<section id="ref.ack">
|
|
||||||
<title>Acknowledgements</title>
|
|
||||||
|
|
||||||
<using-namespace name="boost"/>
|
|
||||||
|
|
||||||
<para><functionname>ref</functionname> and <functionname>cref</functionname>
|
|
||||||
were originally part of the <libraryname>Tuple</libraryname> library
|
|
||||||
by Jaakko Järvi. They were "promoted to boost:: status" by
|
|
||||||
Peter Dimov because they are generally useful. Douglas Gregor and
|
|
||||||
Dave Abrahams contributed
|
|
||||||
<classname>is_reference_wrapper</classname> and
|
|
||||||
<classname>unwrap_reference</classname>. Frank Mori Hess and Ronald
|
|
||||||
Garcia contributed <functionname>boost::unwrap_ref</functionname></para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
</library>
|
|
||||||
15
ref.html
15
ref.html
@@ -1,15 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="refresh" content="0; URL=../../doc/html/ref.html">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
Automatic redirection failed, please go to
|
|
||||||
<a href="../../doc/html/ref.html">../../doc/html/ref.html</a>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
<!--
|
|
||||||
<09> Copyright Beman Dawes, 2001
|
|
||||||
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
|
|
||||||
-->
|
|
||||||
Reference in New Issue
Block a user