1<?xml version="1.0" standalone="yes"?> 2<library-reference><header name="boost/core/ref.hpp"> 3<namespace name="boost"> 4<struct name="is_reference_wrapper"><template> 5 <template-type-parameter name="T"/> 6 </template><purpose>Determine if a type <computeroutput>T</computeroutput> is an instantiation of <computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname></computeroutput>. </purpose><description><para>The value static constant will be true if the type <computeroutput>T</computeroutput> is a specialization of <computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname></computeroutput>. </para></description><method-group name="public member functions"> 7<method name="BOOST_STATIC_CONSTANT"><type/><parameter name=""><paramtype>bool</paramtype></parameter><parameter name=""><paramtype>value</paramtype><default>false</default></parameter></method> 8</method-group> 9</struct><class name="reference_wrapper"><template> 10 <template-type-parameter name="T"/> 11 </template><purpose>Contains a reference to an object of type <computeroutput>T</computeroutput>. </purpose><description><para><computeroutput><classname alt="boost::reference_wrapper">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"><description><para>Type <computeroutput>T</computeroutput>. </para></description><type>T</type></typedef> 12<method-group name="public member functions"> 13<method name="conversion-operator" cv="const"><type>T &</type><description><para> 14<para>Does not throw. </para> 15 16</para></description><returns><para>The stored reference. </para> 17</returns></method> 18<method name="get" cv="const"><type>T &</type><description><para> 19<para>Does not throw. </para> 20 21</para></description><returns><para>The stored reference. </para> 22</returns></method> 23<method name="get_pointer" cv="const"><type>T *</type><description><para> 24<para>Does not throw. </para> 25 26</para></description><returns><para>A pointer to the object referenced by the stored reference. </para> 27</returns></method> 28</method-group> 29<constructor specifiers="explicit"><parameter name="t"><paramtype>T &</paramtype></parameter><description><para>Constructs a <computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname></computeroutput> object that stores a reference to <computeroutput>t</computeroutput>.</para><para><para>Does not throw. </para> 30 31</para></description></constructor> 32<constructor cv="= delete"><parameter name="t"><paramtype>T &&</paramtype></parameter><description><para><para>Construction from a temporary object is disabled. </para> 33 34</para></description></constructor> 35</class><struct name="unwrap_reference"><template> 36 <template-type-parameter name="T"/> 37 </template><purpose>Find the type in a <computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname></computeroutput>. </purpose><description><para>The <computeroutput>typedef</computeroutput> type is <computeroutput>T::type</computeroutput> if <computeroutput>T</computeroutput> is a <computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname></computeroutput>, <computeroutput>T</computeroutput> otherwise. </para></description><typedef name="type"><type>T</type></typedef> 38</struct><function name="ref"><type><classname>reference_wrapper</classname>< T > const</type><template> 39 <template-type-parameter name="T"/> 40 </template><parameter name="t"><paramtype>T &</paramtype></parameter><description><para> 41<para>Does not throw. </para> 42 43</para></description><returns><para><computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname><T>(t)</computeroutput> </para> 44</returns></function> 45<function name="cref"><type><classname>reference_wrapper</classname>< T const > const</type><template> 46 <template-type-parameter name="T"/> 47 </template><parameter name="t"><paramtype>T const &</paramtype></parameter><description><para> 48<para>Does not throw. </para> 49 50</para></description><returns><para><computeroutput><classname alt="boost::reference_wrapper">reference_wrapper</classname><T const>(t)</computeroutput> </para> 51</returns></function> 52<function name="ref"><type>void</type><template> 53 <template-type-parameter name="T"/> 54 </template><parameter name=""><paramtype>T const &&</paramtype></parameter><description><para><para>Construction from a temporary object is disabled. </para> 55 56</para></description></function> 57<function name="cref"><type>void</type><template> 58 <template-type-parameter name="T"/> 59 </template><parameter name=""><paramtype>T const &&</paramtype></parameter><description><para><para>Construction from a temporary object is disabled. </para> 60 61</para></description></function> 62<function name="unwrap_ref"><type><classname>unwrap_reference</classname>< T >::type &</type><template> 63 <template-type-parameter name="T"/> 64 </template><parameter name="t"><paramtype>T &</paramtype></parameter><description><para> 65<para>Does not throw. </para> 66 67</para></description><returns><para><computeroutput><classname alt="boost::unwrap_reference">unwrap_reference</classname><T>::type&(t)</computeroutput> </para> 68</returns></function> 69</namespace> 70</header> 71</library-reference>