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::detail::indexable< Value, IsIndexable > Struct Template Reference

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

#include <indexable.hpp>

Inheritance diagram for boost::geometry::index::detail::indexable< Value, IsIndexable >:

Public Types

typedef Value const & result_type
 The type of result returned by function object. More...
 

Public Member Functions

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

Detailed Description

template<typename Value, bool IsIndexable = is_indexable<Value>::value>
struct boost::geometry::index::detail::indexable< Value, IsIndexable >

The function object extracting Indexable from Value.

It translates Value object to Indexable object. The default version handles Values which are Indexables. This template is also specialized for std::pair<Indexable, T2>, boost::tuple<Indexable, ...> and std::tuple<Indexable, ...>.

Template Parameters
ValueThe Value type which may be translated directly to the Indexable.
IsIndexableIf true, the const reference to Value is returned.

Member Typedef Documentation

template<typename Value, bool IsIndexable = is_indexable<Value>::value>
typedef Value const& boost::geometry::index::detail::indexable< Value, IsIndexable >::result_type

The type of result returned by function object.

Member Function Documentation

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

Return indexable extracted from the value.

Parameters
vThe value.
Returns
The indexable.

Referenced by boost::geometry::index::indexable< Value >::operator()().


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