Boost.Geometry.Index
 All Classes Functions Typedefs Groups
Public Types | Public Member Functions | List of all members
boost::geometry::index::equal_to< Value > Struct Template Reference

The function object comparing Values. More...

#include <equal_to.hpp>

Inheritance diagram for boost::geometry::index::equal_to< Value >:
boost::geometry::index::detail::equal_to< Value >

Public Types

typedef detail::equal_to
< Value >::result_type 
result_type
 The type of result returned by function object.
 
- Public Types inherited from boost::geometry::index::detail::equal_to< Value >
typedef bool result_type
 The type of result returned by function object.
 

Public Member Functions

bool operator() (Value const &l, Value const &r) const
 Compare Values. More...
 
- Public Member Functions inherited from boost::geometry::index::detail::equal_to< Value >
bool operator() (Value const &l, Value const &r) const
 Compare values. If Value is a Geometry geometry::equals() function is used. More...
 

Detailed Description

template<typename Value>
struct boost::geometry::index::equal_to< Value >

The function object comparing Values.

The default version handles Values which are Indexables, std::pair<T1, T2>, boost::tuple<...> and std::tuple<...> if STD tuples and variadic templates are supported. All members are compared from left to right, Geometries using boost::geometry::equals() function, other types using operator==.

Template Parameters
ValueThe type of objects which are compared by this function object.

Member Function Documentation

template<typename Value >
bool boost::geometry::index::equal_to< Value >::operator() ( Value const &  l,
Value const &  r 
) const
inline

Compare Values.

Parameters
lFirst value.
rSecond value.
Returns
true if Values are equal.

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