bslstl::MapComparator< KEY, VALUE, COMPARATOR > Class Template Reference

#include <bslstl_mapcomparator.h>

List of all members.

Public Types
typedef bsl::pair< const KEY, VALUE >	ValueType
typedef TreeNode< ValueType >	NodeType
Public Member Functions
	MapComparator ()
	MapComparator (const COMPARATOR &keyComparator)
	MapComparator (const MapComparator &original)
	~MapComparator ()
template<class LOOKUP_KEY >
bool	operator() (const LOOKUP_KEY &lhs, const bslalg::RbTreeNode &rhs)
template<class LOOKUP_KEY >
bool	operator() (const bslalg::RbTreeNode &lhs, const LOOKUP_KEY &rhs)
void	swap (MapComparator &other)
template<class LOOKUP_KEY >
bool	operator() (const LOOKUP_KEY &lhs, const bslalg::RbTreeNode &rhs) const
template<class LOOKUP_KEY >
bool	operator() (const bslalg::RbTreeNode &lhs, const LOOKUP_KEY &rhs) const
COMPARATOR &	keyComparator ()
const COMPARATOR &	keyComparator () const

template<class KEY, class VALUE, class COMPARATOR>
class bslstl::MapComparator< KEY, VALUE, COMPARATOR >

---

Member Typedef Documentation

template<class KEY , class VALUE , class COMPARATOR >

typedef bsl::pair<const KEY, VALUE> bslstl::MapComparator< KEY, VALUE, COMPARATOR >::ValueType

template<class KEY , class VALUE , class COMPARATOR >

typedef TreeNode<ValueType> bslstl::MapComparator< KEY, VALUE, COMPARATOR >::NodeType

---

Constructor & Destructor Documentation

template<class KEY , class VALUE , class COMPARATOR >

bslstl::MapComparator< KEY, VALUE, COMPARATOR >::MapComparator

(

)

Create a MapComparator object that will use a default constructed COMPARATOR.

template<class KEY , class VALUE , class COMPARATOR >

bslstl::MapComparator< KEY, VALUE, COMPARATOR >::MapComparator

(

const COMPARATOR &

keyComparator

)

[explicit]

Create a MapComparator object holding a copy of the specified keyComparator.

template<class KEY , class VALUE , class COMPARATOR >

bslstl::MapComparator< KEY, VALUE, COMPARATOR >::MapComparator

(

const MapComparator< KEY, VALUE, COMPARATOR > &

original

)

Create a MapComparator object with the COMPARATOR object of the specified original object.

template<class KEY , class VALUE , class COMPARATOR >

bslstl::MapComparator< KEY, VALUE, COMPARATOR >::~MapComparator

(

)

Destroy this object.

---

Member Function Documentation

template<class KEY , class VALUE , class COMPARATOR >

template<class LOOKUP_KEY >

bool bslstl::MapComparator< KEY, VALUE, COMPARATOR >::operator()	(	const LOOKUP_KEY &	lhs,
		const bslalg::RbTreeNode &	rhs
	)

Return true if the specified lhs is less than (ordered before, according to the comparator held by this object) value().first of the specified rhs after being cast to NodeType, and false otherwise. The behavior is undefined unless rhs can be safely cast to NodeType.

template<class KEY , class VALUE , class COMPARATOR >

template<class LOOKUP_KEY >

bool bslstl::MapComparator< KEY, VALUE, COMPARATOR >::operator()	(	const bslalg::RbTreeNode &	lhs,
		const LOOKUP_KEY &	rhs
	)

Return true if value().first() of the specified lhs after being cast to NodeType is less than (ordered before, according to the comparator held by this object) the specified rhs, and false otherwise. The behavior is undefined unless rhs can be safely cast to NodeType.

template<class KEY , class VALUE , class COMPARATOR >

void bslstl::MapComparator< KEY, VALUE, COMPARATOR >::swap

(

MapComparator< KEY, VALUE, COMPARATOR > &

other

)

Efficiently exchange the value of this object with the value of the specified other object. This method provides the no-throw exception-safety guarantee.

template<class KEY , class VALUE , class COMPARATOR >

template<class LOOKUP_KEY >

bool bslstl::MapComparator< KEY, VALUE, COMPARATOR >::operator()	(	const LOOKUP_KEY &	lhs,
		const bslalg::RbTreeNode &	rhs
	)			const

Return true if the specified lhs is less than (ordered before, according to the comparator held by this object) value().first of the specified rhs after being cast to NodeType, and false otherwise. The behavior is undefined unless rhs can be safely cast to NodeType.

template<class KEY , class VALUE , class COMPARATOR >

template<class LOOKUP_KEY >

bool bslstl::MapComparator< KEY, VALUE, COMPARATOR >::operator()	(	const bslalg::RbTreeNode &	lhs,
		const LOOKUP_KEY &	rhs
	)			const

Return true if value().first() of the specified lhs after being cast to NodeType is less than (ordered before, according to the comparator held by this object) the specified rhs, and false otherwise. The behavior is undefined unless rhs can be safely cast to NodeType.

template<class KEY , class VALUE , class COMPARATOR >

COMPARATOR& bslstl::MapComparator< KEY, VALUE, COMPARATOR >::keyComparator

(

)

Return a reference providing modifiable access to the function pointer or functor to which this comparator delegates comparison operations.

template<class KEY , class VALUE , class COMPARATOR >

const COMPARATOR& bslstl::MapComparator< KEY, VALUE, COMPARATOR >::keyComparator

(

)

const

Return a reference providing non-modifiable access to the function pointer or functor to which this comparator delegates comparison operations.

---

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

• bslstl_mapcomparator.h