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

Trait used to extract the internal vertex name from a vertex property. More...

#include <named_graph.hpp>

Inheritance diagram for boost::graph::internal_vertex_name< VertexProperty >:

Public Types

typedef void type
 The type field provides a function object that extracts a key from the VertexProperty. More...
 

Detailed Description

template<typename VertexProperty>
struct boost::graph::internal_vertex_name< VertexProperty >

Trait used to extract the internal vertex name from a vertex property.

To enable the use of internal vertex names in a graph type, specialize the internal_vertex_name trait for your graph property (e.g., a City class, which stores information about the vertices in a road map).

Member Typedef Documentation

template<typename VertexProperty>
typedef void boost::graph::internal_vertex_name< VertexProperty >::type

The type field provides a function object that extracts a key from the VertexProperty.

The function object type must have a nested result_type that provides the type of the key. For more information, see the KeyExtractor concept in the Boost.MultiIndex documentation: type must either be void (if VertexProperty does not have an internal vertex name) or a model of KeyExtractor.


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