Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::geometry::index::indexable< Value > Struct Template Reference

The function object extracting Indexable from Value. More...

#include <indexable.hpp>

Inheritance diagram for boost::geometry::index::indexable< Value >:
Collaboration diagram for boost::geometry::index::indexable< Value >:

Public Types

typedef detail::indexable
< Value >::result_type 
result_type
 The type of result returned by function object. More...
 

Public Member Functions

result_type operator() (Value const &v) const
 Return indexable extracted from the value. More...
 
 BOOST_MPL_ASSERT_MSG ((detail::is_indexable< Value >::value), NOT_VALID_INDEXABLE_TYPE,(Value))
 

Detailed Description

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

The function object extracting Indexable from Value.

It translates Value object to Indexable object. By default, it can handle Values which are Indexables, std::pair<Indexable, T2>, boost::tuple<Indexable, ...> and std::tuple<Indexable, ...> if STD tuples and variadic templates are supported.

Template Parameters
ValueThe Value type which may be translated directly to the Indexable.

Member Typedef Documentation

template<typename Value >
typedef detail::indexable<Value>::result_type boost::geometry::index::indexable< Value >::result_type

The type of result returned by function object.

It should be const Indexable reference.

Member Function Documentation

boost::geometry::index::detail::indexable< Value, IsIndexable >::BOOST_MPL_ASSERT_MSG ( (detail::is_indexable< Value >::value)  ,
NOT_VALID_INDEXABLE_TYPE  ,
(Value)   
)
inherited
template<typename Value >
result_type boost::geometry::index::indexable< Value >::operator() ( Value const &  v) const
inline

Return indexable extracted from the value.

Parameters
vThe value.
Returns
The indexable.

References boost::geometry::index::detail::indexable< Value, IsIndexable >::operator()().


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