boost_graph.h File Reference

Contains definitions for the BoostGraph class. More...

#include <boost/graph/graph_traits.hpp>
#include <boost/graph/adjacency_matrix.hpp>
#include <boost/graph/directed_graph.hpp>
#include <boost/graph/compressed_sparse_row_graph.hpp>
#include <boost/graph/adjacency_list.hpp>

Include dependency graph for boost_graph.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	std::hash< std::array< float, 3 > >
struct	HF::Pathfinding::Edge_Cost
	Data stored for every edge in the BoostGraph. More...
struct	HF::Pathfinding::vertex_data
	Data stored for every vertex in the BoostGraph. More...
class	HF::Pathfinding::BoostGraph
	A graph usable with the BoostGraphLibrary. More...

Namespaces
namespace	std
	STL namespace.
namespace	boost
	The Boost C++ library. https://www.boost.org/.
namespace	HF
	Perform human scale analysis on 3D environments.
namespace	HF::SpatialStructures
	Contains standard fundamental data structures for representing space used throughout DHARTAPI.
namespace	HF::Pathfinding
	Algorithms to find the shortest path between nodes in a HF::SpatialStructures::Graph.

Typedefs
typedef boost::compressed_sparse_row_graph< boost::directedS, vertex_data, Edge_Cost >	HF::Pathfinding::graph_t
	Type of graph held by the BoostGraph. More...
typedef boost::graph_traits< graph_t >::vertex_descriptor	HF::Pathfinding::vertex_descriptor
	Quick alias to shorten the typename of vertex descriptors for our graph_t type. /summary> More...
typedef std::pair< int, int >	HF::Pathfinding::pair
	Shorten std::pair to simplify graph construction. More...

Functions
template<typename SizeT >
void	std::array_hash_combine_impl (SizeT &seed, SizeT value)
	Combine the hash of value into seed. More...

Detailed Description

Contains definitions for the BoostGraph class.

Author

TBA

Date

17 Jun 2020

Definition in file boost_graph.h.

---

Class Documentation

HF::Pathfinding::Edge_Cost

struct HF::Pathfinding::Edge_Cost

Data stored for every edge in the BoostGraph.

Each edge in the graph only stores its weight as a float.

Definition at line 99 of file boost_graph.h.

Collaboration diagram for HF::Pathfinding::Edge_Cost:

Class Members
float	weight	Cost of traversing this edge.

HF::Pathfinding::vertex_data

struct HF::Pathfinding::vertex_data

Data stored for every vertex in the BoostGraph.

Every vertex stores in the graph stores it's index p and a unique double d.

Todo:

Is the double d needed?

Definition at line 111 of file boost_graph.h.

Collaboration diagram for HF::Pathfinding::vertex_data:

Class Members
double	d	Unknown may have been used for the colormap.
graph_traits< compressed_sparse_row_graph< directedS > >::vertex_descriptor	p	The index of a vertex in the CSR.