Core Debug Layer

Detailed Description

All debug and correctness testing routines reside here. Do not use them in production builds.

Classes

struct msmazes::COutVertexVisitor< EventFilter >

This is a debug class. Do not use in a production build. More...

struct msmazes::COutEdgeVisitor< EventFilter >

This is a debug class. Do not use in a production build. More...

Functions

template<typename PathIterator, typename VertexIDMap>

void msmazes::coutPath (PathIterator begin, PathIterator end, const VertexIDMap id_map)

This is a debug function. Do not use in a production build.

template<typename VertexListGraph, typename VertexIDMap, typename PredecessorMap>

void msmazes::coutPredecessorMap (const VertexListGraph &g, const VertexIDMap id_map, const PredecessorMap p_map)

This is a debug function. Do not use in a production build.

template<typename VertexListGraph, typename VertexIDMap, typename PropertyMap>

void msmazes::coutVertexPmap (const VertexListGraph &g, const VertexIDMap id_map, const PropertyMap p_map)

This is a debug function. Do not use in a production build.

template<typename EdgeListGraph, typename VertexIDMap, typename PropertyMap>

void msmazes::coutEdgePmap (const EdgeListGraph &g, const VertexIDMap id_map, const PropertyMap p_map)

This is a debug function. Do not use in a production build.

template<typename EdgeListSelector, typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>

void msmazes::makeIndexMap (boost::adjacency_list< EdgeListSelector, boost::vecS, DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > &g, VertexIndexMap index_map)

This is a correctness testing function. Do not use in a production build.

template<typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>

void msmazes::makeIndexMap (boost::adjacency_matrix< DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > &g, VertexIndexMap index_map)

This is a correctness testing function. Do not use in a production build.

template<typename VertexListGraph, typename VertexIndexMap>

void msmazes::makeIndexMap (VertexListGraph &g, VertexIndexMap index_map)

This is a correctness testing function. Do not use in a production build.

Function Documentation

template<typename PathIterator, typename VertexIDMap>

void coutPath ( PathIterator begin,

PathIterator end,

const VertexIDMap id_map

)

Sends the stream-readable form of each vertex in the range [ begin, end ) to standard output, using id_map to convert each vertex to its stream-readable form.
This is a debug function. Do not use in a production build.

Parameters:

begin the start of the input range.

end the past-the-end iterator indicating the end of the input range.

id_map the property map used to convert each vertex to its stream-readable form.

Precondition:
The type PathIterator must be a model of Input Iterator.
The type VertexIDMap must be a model of Readable Property Map.
The value type of PathIterator must be convertible to boost::property_traits<VertexIDMap>::key_type.
boost::property_traits<VertexIDMap>::value_type must be a valid parameter type for standard output's operator<<.
[ begin, end ) must be a valid range.
All elements in the range [ begin, end ) must be valid keys in id_map.

template<typename VertexListGraph, typename VertexIDMap, typename PredecessorMap>

void coutPredecessorMap ( const VertexListGraph & g,

const VertexIDMap id_map,

const PredecessorMap p_map

)

For each vertex v in the graph, sends the vertex pair (v, boost::get(p_map, v)) to standard output, using id_map to convert each vertex to its stream-readable form.
This is a debug function. Do not use in a production build.

Parameters:

g the input graph.

id_map the property map used to convert each vertex to its stream-readable form.

p_map a mapping of each vertex in g to another vertex in g.

Precondition:
The type VertexListGraph must model the Vertex List Graph concept.
The VertexIDMap and PredecessorMap types must the model Readable Property Map concept.
boost::graph_traits<VertexListGraph>::vertex_descriptor, boost::property_traits::<VertexIDMap>::key_type, boost::property_traits::<PredecessorMap>::key_type, and boost::property_traits<PredecessorMap>::value_type must be the same type.
boost::property_traits<VertexIDMap>::value_type must be a valid parameter type for standard output's operator<<.

template<typename VertexListGraph, typename VertexIDMap, typename PropertyMap>

void coutVertexPmap ( const VertexListGraph & g,

const VertexIDMap id_map,

const PropertyMap p_map

)

For each vertex v in the graph, sends the pair (v, boost::get(p_map, v)) to standard output, using id_map to convert each vertex to its stream-readable form.
This is a debug function. Do not use in a production build.

Parameters:

g the input graph.

id_map the property map used to convert each vertex to its stream-readable form.

p_map a mapping of each vertex in g to the corresponding value of its desired property.

Precondition:
The type VertexListGraph must model the Vertex List Graph concept.
The VertexIDMap and PropertyMap types must model the Readable Property Map concept.
boost::graph_traits<VertexListGraph>::vertex_descriptor, boost::property_traits::<VertexIDMap>::key_type, and boost::property_traits::<PropertyMap>::key_type must be the same type.
boost::property_traits<VertexIDMap>::value_type must be a valid parameter type for standard output's operator<<.
boost::property_traits<PropertyMap>::value_type must be a valid parameter type for standard output's operator<<.

template<typename EdgeListGraph, typename VertexIDMap, typename PropertyMap>

void coutEdgePmap ( const EdgeListGraph & g,

const VertexIDMap id_map,

const PropertyMap p_map

)

For each edge e in the graph, sends the pair (e, boost::get(p_map, e)) to standard output, using id_map to convert each edge's source and target vertices to their stream-readable forms.
This is a debug function. Do not use in a production build.

Parameters:

g the input graph.

id_map the property map used to convert each vertex to its stream-readable form.

p_map a mapping of each edge in g to the corresponding value of its desired property.

Precondition:
The type EdgeListGraph must be a model of Edge List Graph.
The VertexIDMap and PropertyMap types must model Readable Property Map.
boost::graph_traits<EdgeListGraph>::vertex_descriptor must be the same type as boost::property_traits::<VertexIDMap>::key_type.
boost::graph_traits<EdgeListGraph>::edge_descriptor must be the same type as boost::property_traits::<PropertyMap>::key_type.
boost::property_traits<VertexIDMap>::value_type must be a valid parameter type for standard output's operator<<.
boost::property_traits<PropertyMap>::value_type must be a valid parameter type for standard output's operator<<.

template<typename EdgeListSelector, typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>

void makeIndexMap ( boost::adjacency_list< EdgeListSelector, boost::vecS, DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > & g,

VertexIndexMap index_map

) [inline]

Maps the specified graph's vertices to their indices in the specified index map so that boost::get(index_map, boost::vertex(index, g)) == index for all values of index in the range [0, boost::num_vertices(g)).
This is a correctness testing function. Do not use in a production build.

template<typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>

void makeIndexMap ( boost::adjacency_matrix< DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > & g,

VertexIndexMap index_map

) [inline]

Maps the specified graph's vertices to their indices in the specified index map so that boost::get(index_map, boost::vertex(index, g)) == index for all values of index in the range [0, boost::num_vertices(g)).
This is a correctness testing function. Do not use in a production build.

template<typename VertexListGraph, typename VertexIndexMap>

void makeIndexMap ( VertexListGraph & g,

VertexIndexMap index_map

)

Maps the specified graph's vertices to their indices in the specified index map so that boost::get(index_map, boost::vertex(index, g)) == index for all values of index in the range [0, boost::num_vertices(g)).
This is a correctness testing function. Do not use in a production build.

Multi-State Mazes in C++ is hosted by . Use the Table of Contents for navigation.


Classes
struct	msmazes::COutVertexVisitor< EventFilter >
	This is a debug class. Do not use in a production build. More...
struct	msmazes::COutEdgeVisitor< EventFilter >
	This is a debug class. Do not use in a production build. More...
Functions
template<typename PathIterator, typename VertexIDMap>
void	msmazes::coutPath (PathIterator begin, PathIterator end, const VertexIDMap id_map)
	This is a debug function. Do not use in a production build.
template<typename VertexListGraph, typename VertexIDMap, typename PredecessorMap>
void	msmazes::coutPredecessorMap (const VertexListGraph &g, const VertexIDMap id_map, const PredecessorMap p_map)
	This is a debug function. Do not use in a production build.
template<typename VertexListGraph, typename VertexIDMap, typename PropertyMap>
void	msmazes::coutVertexPmap (const VertexListGraph &g, const VertexIDMap id_map, const PropertyMap p_map)
	This is a debug function. Do not use in a production build.
template<typename EdgeListGraph, typename VertexIDMap, typename PropertyMap>
void	msmazes::coutEdgePmap (const EdgeListGraph &g, const VertexIDMap id_map, const PropertyMap p_map)
	This is a debug function. Do not use in a production build.
template<typename EdgeListSelector, typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>
void	msmazes::makeIndexMap (boost::adjacency_list< EdgeListSelector, boost::vecS, DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > &g, VertexIndexMap index_map)
	This is a correctness testing function. Do not use in a production build.
template<typename DirectionalSelector, typename VertexProperty, typename EdgeProperty, typename GraphProperty, typename VertexIndexMap>
void	msmazes::makeIndexMap (boost::adjacency_matrix< DirectionalSelector, VertexProperty, EdgeProperty, GraphProperty > &g, VertexIndexMap index_map)
	This is a correctness testing function. Do not use in a production build.
template<typename VertexListGraph, typename VertexIndexMap>
void	msmazes::makeIndexMap (VertexListGraph &g, VertexIndexMap index_map)
	This is a correctness testing function. Do not use in a production build.