Gambit::ModelHierarchy Class Reference

Model hierarchy tree class. More...

#include <modelgraph.hpp>

Collaboration diagram for Gambit::ModelHierarchy:

Classes
class	colorWriter
	Helper class for drawing the model hierarchy graph (edges) More...
struct	edge_color_t
	Property tag for adding color property to edges. More...
class	labelWriter
	Helper class for drawing the model hierarchy graph (labels) More...

Private Types
typedef std::vector< primary_model_functor * >	primodel_vec
	Shorthand for vector of pointers to primary model functors. More...
typedef boost::property< edge_color_t, std::string >	EdgeColor
	Typedefs for central boost (model) graph. More...
typedef boost::adjacency_list< boost::vecS, boost::vecS, boost::bidirectionalS, functor *, EdgeColor >	ModelGraphType
typedef boost::graph_traits< ModelGraphType >::vertex_descriptor	ModelVertexID
typedef boost::graph_traits< ModelGraphType >::edge_descriptor	ModelEdgeID
typedef boost::property_map< ModelGraphType, boost::vertex_index_t >::type	ModelIndexMap

Private Attributes
const Models::ModelFunctorClaw *	boundClaw
	The model claw that provides all the model info. More...
str	filename
	Output filename. More...
bool	verbose
	Turn on verbose operation. More...
ModelGraphType	modelGraph
	The central boost graph object for the model hierarchy. More...
void	addFunctorsToGraph (const primodel_vec &)
	Add model functors (vertices) to model hierarchy graph. More...
void	makeGraph (const primodel_vec &)
	Add edges (relationships) to model hierarchy graph. More...
	ModelHierarchy (const Models::ModelFunctorClaw &, const primodel_vec &, str, bool)
	Constructor. More...

Detailed Description

Model hierarchy tree class.

Definition at line 36 of file modelgraph.hpp.

Member Typedef Documentation

EdgeColor

typedef boost::property<edge_color_t, std::string> Gambit::ModelHierarchy::EdgeColor

private

Typedefs for central boost (model) graph.

Definition at line 43 of file modelgraph.hpp.

ModelEdgeID

typedef boost::graph_traits<ModelGraphType>::edge_descriptor Gambit::ModelHierarchy::ModelEdgeID

private

Definition at line 46 of file modelgraph.hpp.

ModelGraphType

typedef boost::adjacency_list<boost::vecS, boost::vecS, boost::bidirectionalS, functor*, EdgeColor> Gambit::ModelHierarchy::ModelGraphType

private

Definition at line 44 of file modelgraph.hpp.

ModelIndexMap

typedef boost::property_map<ModelGraphType,boost::vertex_index_t>::type Gambit::ModelHierarchy::ModelIndexMap

private

Definition at line 47 of file modelgraph.hpp.

ModelVertexID

typedef boost::graph_traits<ModelGraphType>::vertex_descriptor Gambit::ModelHierarchy::ModelVertexID

private

Definition at line 45 of file modelgraph.hpp.

primodel_vec

typedef std::vector<primary_model_functor*> Gambit::ModelHierarchy::primodel_vec

private

Shorthand for vector of pointers to primary model functors.

Definition at line 51 of file modelgraph.hpp.

Constructor & Destructor Documentation

ModelHierarchy()

Gambit::ModelHierarchy::ModelHierarchy	(	const Models::ModelFunctorClaw &	claw,
		const primodel_vec &	pmv,
		str	file,
		bool	talky
	)

Constructor.

ModelHierarchy method definitions Creates a graph of the model hierarchy for visualisation purposes.

Constructor

Definition at line 50 of file modelgraph.cpp.

References makeGraph().

     : boundClaw(&claw), filename(file), verbose(talky)
    {
      makeGraph(pmv);
    }

Here is the call graph for this function:

Member Function Documentation

addFunctorsToGraph()

void Gambit::ModelHierarchy::addFunctorsToGraph ( const primodel_vec &  primaryModelFunctors )

private

Add model functors (vertices) to model hierarchy graph.

Add model functors to the modelGraph.

Definition at line 137 of file modelgraph.cpp.

References modelGraph.

Referenced by makeGraph().

    {
      // - model functors go into modelGraph
      for (std::vector<primary_model_functor *>::const_iterator
          it  = primaryModelFunctors.begin();
          it != primaryModelFunctors.end(); ++it)
      {
        //if ( (*it)->status() != 0 ) 
        boost::add_vertex(*it, modelGraph);     
      }
    }

Here is the caller graph for this function:

makeGraph()

void Gambit::ModelHierarchy::makeGraph ( const primodel_vec &  primaryModelFunctors )

private

Add edges (relationships) to model hierarchy graph.

Figure out relationships between primary model functors.

Definition at line 57 of file modelgraph.cpp.

References addFunctorsToGraph(), boundClaw, filename, Gambit::Printers::HDF5::get, Gambit::Models::ModelFunctorClaw::get_best_friends(), Gambit::Models::ModelFunctorClaw::get_parent(), modelGraph, and verbose.

Referenced by ModelHierarchy().

    {
      boost::graph_traits<ModelGraphType>::vertex_iterator vi, vi_end;
      std::map<str, ModelVertexID> vertexIDmap;
      str model;
      // The property map which holds the edge colors:
      boost::property_map<ModelGraphType, edge_color_t>::type color(boost::get(edge_color_t(),modelGraph));

      if (verbose) std::cout<<std::endl<<"Determining model hierarchy graph..."<<std::endl;

      // Add all primary model functors to the model hierarchy graph
      addFunctorsToGraph(primaryModelFunctors);

      // Loop over all vertices (models) in modelGraph and create a map from
      // model names to vertex IDs.
      for (boost::tie(vi, vi_end) = boost::vertices(modelGraph); 
              vi != vi_end; ++vi) 
      {
        model = (*modelGraph[*vi]).origin();
        vertexIDmap[model] = *vi;
        if (verbose) std::cout<<"    Vertex added: "<<model<<std::endl;
      }
      
      // Loop over all vertices (models) in vertexIDmap, look up the 'parent' 
      // of each one in the parents database boundClaw->myParentsDB, and add
      // an edge from parent to child in the model graph.  Do the same with
      // direct (best) friends.
      typedef std::map<str, ModelVertexID>::iterator vertexIDmap_it;
      for (vertexIDmap_it vimap = vertexIDmap.begin(); 
              vimap != vertexIDmap.end(); vimap++) 
      {
        model = vimap->first;
        str parent = boundClaw->get_parent(model);  
        if (verbose) std::cout<<model<<"; parent: "<<parent<<std::endl;;       
        // If there is a parent, add an edge between parent and child
        if (parent != "none")
        {
          boost::add_edge(vertexIDmap[parent], vertexIDmap[model], modelGraph);
          if (verbose) std::cout<<"    Edge added: "<<model<<" ---> "<<parent<<std::endl;
        }
        // Add edges with all this model's best friends.  Might want to make these another colour in future.
        std::set<str> friends = boundClaw->get_best_friends(model);
        for (auto it = friends.begin(); it != friends.end(); ++it)
        {
          boost::add_edge(vertexIDmap[*it], vertexIDmap[model], modelGraph);

          // Get the descriptor for the edge we just added
          ModelEdgeID e = boost::edge(vertexIDmap[*it], vertexIDmap[model], modelGraph).first;

          // Set the color property for this edge to "red"
          boost::put(color,e,"red");

          if (verbose)
          {
            std::cout<<model<<"; friend: "<<*it<<std::endl;;       
            std::cout<<"    Edge added: "<<model<<" ---> "<<*it<<std::endl;
          }
        }
      }
      if (verbose) std::cout<<std::endl;

#ifdef HAVE_GRAPHVIZ
      // Property writer for graph; see http://www.boost.org/doc/libs/1_36_0/libs/graph/doc/write-graphviz.html
      // Also for valid properties see http://www.graphviz.org/pdf/dotguide.pdf
      struct graphWriter
      {
        void operator()(std::ostream& out) const
        {
          out << "rankdir = LR;"    << std::endl; // Turn graph orientation left to right.
          out << "edge [dir=back];" << std::endl; // Reverse all the arrows
        }
      };
      // Generate graphviz plot
      std::ofstream outf(filename);
      // args: output stream, vertex list, vertex property writer (PW), edge PW, graph PW. 
      write_graphviz(outf, modelGraph, labelWriter(&modelGraph), colorWriter(&modelGraph), graphWriter()); 
#endif
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

boundClaw

const Models::ModelFunctorClaw* Gambit::ModelHierarchy::boundClaw

private

The model claw that provides all the model info.

Definition at line 89 of file modelgraph.hpp.

Referenced by makeGraph().

filename

str Gambit::ModelHierarchy::filename

private

Output filename.

Definition at line 92 of file modelgraph.hpp.

Referenced by makeGraph().

modelGraph

ModelGraphType Gambit::ModelHierarchy::modelGraph

private

The central boost graph object for the model hierarchy.

Definition at line 98 of file modelgraph.hpp.

Referenced by addFunctorsToGraph(), and makeGraph().

verbose

bool Gambit::ModelHierarchy::verbose

private

Turn on verbose operation.

Definition at line 95 of file modelgraph.hpp.

Referenced by makeGraph().

---

The documentation for this class was generated from the following files:

• Core/include/gambit/Core/modelgraph.hpp
• Core/src/modelgraph.cpp