bsl::equal_to< VALUE_TYPE > Struct Template Reference

#include <bslstl_equalto.h>

Public Types
typedef VALUE_TYPE	first_argument_type
typedef VALUE_TYPE	second_argument_type
typedef bool	result_type

Public Member Functions
	equal_to ()=default
	Create a equal_to object.
	equal_to (const equal_to &original)=default
	~equal_to ()=default
	Destroy this object.
equal_to &	operator= (const equal_to &)=default
BSLA_NODISCARD BSLS_KEYWORD_CONSTEXPR bool	operator() (const VALUE_TYPE &lhs, const VALUE_TYPE &rhs) const

Detailed Description

template<class VALUE_TYPE = void>
struct bsl::equal_to< VALUE_TYPE >

This struct defines a binary comparison functor applying operator== to two VALUE_TYPE objects. This class conforms to the C++11 standard specification of std::equal_to that does not require inheriting from std::binary_function. Note that this class is an empty POD type.

Member Typedef Documentation

first_argument_type

template<class VALUE_TYPE = void>

typedef VALUE_TYPE bsl::equal_to< VALUE_TYPE >::first_argument_type

result_type

template<class VALUE_TYPE = void>

typedef bool bsl::equal_to< VALUE_TYPE >::result_type

second_argument_type

template<class VALUE_TYPE = void>

typedef VALUE_TYPE bsl::equal_to< VALUE_TYPE >::second_argument_type

Constructor & Destructor Documentation

equal_to() [1/2]

template<class VALUE_TYPE = void>

bsl::equal_to< VALUE_TYPE >::equal_to ( )

default

equal_to() [2/2]

template<class VALUE_TYPE = void>

bsl::equal_to< VALUE_TYPE >::equal_to ( const equal_to< VALUE_TYPE > &  original )

default

Create a equal_to object. Note that as equal_to is an empty (stateless) type, this operation will have no observable effect.

~equal_to()

template<class VALUE_TYPE = void>

bsl::equal_to< VALUE_TYPE >::~equal_to ( )

default

Member Function Documentation

operator()()

template<class VALUE_TYPE >

BSLA_NODISCARD BSLS_KEYWORD_CONSTEXPR bool bsl::equal_to< VALUE_TYPE >::operator() ( const VALUE_TYPE &  lhs, const VALUE_TYPE &  rhs  ) const

inline

Return true if the specified lhs compares equal to the specified rhs using the equality-comparison operator, lhs == rhs.

operator=()

template<class VALUE_TYPE = void>

equal_to & bsl::equal_to< VALUE_TYPE >::operator= ( const equal_to< VALUE_TYPE > &  )

default

Assign to this object the value of the specified rhs object, and a return a reference providing modifiable access to this object. Note that as equal_to is an empty (stateless) type, this operation will have no observable effect.

---

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

• bslstl_equalto.h