Namespaces
Variants
Views
Actions

std::owner_less

From cppreference.com
< cpp‎ | memory
Revision as of 23:44, 5 June 2013 by P12 (Talk | contribs)

 
 
 
 
Defined in header <memory>
template< class T >
struct owner_less; /* undefined */
(1) (since C++11)
template< class T >
struct owner_less<std::shared_ptr<T>>;
(2) (since C++11)
template< class T >
struct owner_less<std::weak_ptr<T>>;
(3) (since C++11)

This function object provides owner-based (as opposed to value-based) mixed-type ordering of both std::weak_ptr and std::shared_ptr. The order is such that two smart pointers compare equivalent only if they are both empty or if they both manage the same object, even if the values of the raw pointers obtained by get() are different (e.g. because they point at different subobjects within the same object)

This class template is the preferred comparison predicate when building associative containers with std::shared_ptr or std::weak_ptr as keys, that is,

std::map<std::shared_ptr<T>, U, std::owner_less<std::shared_ptr<T>>>

or

std::map<std::weak_ptr<T>, U, std::owner_less<std::weak_ptr<T>>>.

The default operator< is not defined for weak pointers, and may wrongly consider two shared pointers for the same object non-equivalent (see shared_ptr::owner_before)

Contents

Member types

Member type Definition
result_type bool
first_argument_type 1) T
2) std::shared_ptr<T>
3) std::weak_ptr<T>
second_argument_type 1) T
2) std::shared_ptr<T>
3) std::weak_ptr<T>

Member functions

operator()
compares its arguments using owner-based semantics
(function)

std::owner_less::operator()

bool operator()( const std::shared_ptr<T>& lhs,
                 const std::shared_ptr<T>& rhs ) const;
(since C++11)
(member only of shared_ptr<T> template specialization)
bool operator()( const std::shared_ptr<T>& lhs,
                 const std::weak_ptr<T>& rhs ) const;
(since C++11)
bool operator()( const std::weak_ptr<T>& lhs,
                 const std::shared_ptr<T>& rhs ) const;
(since C++11)
bool operator()( const std::weak_ptr<T>& lhs,
                 const std::weak_ptr<T>& rhs ) const;
(since C++11)
(member only of weak_ptr<T> template specialization)

Compares lhs and rhs using owner-based semantics. Effectively calls lhs.owner_less(rhs).

The ordering is strict weak ordering relation.

lhs and rhs are equivalent only if they are both empty or share ownership.

Parameters

lhs, rhs - shared-ownership pointers to compare

Return value

true if lhs is less than rhs as determined by the owner-based ordering.

Exceptions

(none)



See also

provides owner-based ordering of shared pointers
(public member function of std::shared_ptr) [edit]