boost::reference_wrapper< T > Class Template Reference

Contains a reference to an object of type T. More...

#include <ref.hpp>

Public Types
typedef T	type

Public Member Functions
BOOST_FORCEINLINE T &	get () const
BOOST_FORCEINLINE T *	get_pointer () const
BOOST_FORCEINLINE	operator T& () const
BOOST_FORCEINLINE	reference_wrapper (T &t)

Private Attributes
T *	t_

Detailed Description

template<class T>
class boost::reference_wrapper< T >

Contains a reference to an object of type T.

reference_wrapper is primarily used to "feed" references to function templates (algorithms) that take their parameter by value. It provides an implicit conversion to T&, which usually allows the function templates to work on references unmodified.

Definition at line 59 of file core/ref.hpp.

Member Typedef Documentation

type

template<class T >

typedef T boost::reference_wrapper< T >::type

Type T.

Definition at line 65 of file core/ref.hpp.

Constructor & Destructor Documentation

reference_wrapper()

template<class T >

BOOST_FORCEINLINE boost::reference_wrapper< T >::reference_wrapper ( T &  t )

inlineexplicit

Constructs a reference_wrapper object that stores a reference to t.

Remarks

Does not throw.

Definition at line 73 of file core/ref.hpp.

Member Function Documentation

get()

template<class T >

BOOST_FORCEINLINE T& boost::reference_wrapper< T >::get ( ) const

inline

Returns

The stored reference.

Remarks

Does not throw.

Definition at line 99 of file core/ref.hpp.

get_pointer()

template<class T >

BOOST_FORCEINLINE T* boost::reference_wrapper< T >::get_pointer ( ) const

inline

Returns

A pointer to the object referenced by the stored reference.

Remarks

Does not throw.

Definition at line 106 of file core/ref.hpp.

operator T&()

template<class T >

BOOST_FORCEINLINE boost::reference_wrapper< T >::operator T& ( ) const

inline

Remarks

Construction from a temporary object is disabled.

Returns

The stored reference.

Remarks

Does not throw.

Definition at line 93 of file core/ref.hpp.

Member Data Documentation

t_

template<class T >

T* boost::reference_wrapper< T >::t_

private

Definition at line 110 of file core/ref.hpp.

---

The documentation for this class was generated from the following file:

• core/ref.hpp