PropertyGraph

PropertyGraph

A PropertyGraph is a graph that has some property associated with each of the vertices or edges in the graph. As a given graph may have several properties associated with each vertex or edge, a tag is used to identity which property is being accessed. The graph provides a function which returns a property map object.

Refinement of

Graph

Notation

`G`	A type that is a model of PropertyGraph.
`g`	An object of type `G`.
`X`	Either the vertex or edge descriptor type for `G`.
`x`	An object of type `X`.
`PMap`	The type `boost::property_map<G, Property>::const_type`.
`v`	An object of type `boost::property_traits<PMap>::value_type`.
`Property`	A type that models the Property concept.
`p`	An object of type `Property`.
`pmap`	An object of type `PMap`.

Associated types

Property Map Type	`boost::property_map<G, Property>::type`	The type of the property map for the property specified by `Property`. This type must be a model of ReadWritePropertyMap with a key type the same as the graph's vertex or descriptor type.
Const Property Map Type	`boost::property_map<G, Property>::const_type`	The type of the const property map for the property specified by `Property`. This type must be a model of ReadablePropertyMap with a key type the same as the graph's vertex or edge descriptor type.

Valid Expressions

Name	Expression	Return Type	Description
Get Property Map	`get(p, g)`	`boost::property_map<G, Property>::type` if `g` is mutable and `boost::property_map<G, Property>::const_type` otherwise.	Returns the property map object for the property specified by the `Property` type. The object `p` is only used to carry the type.
Get Property	`get(p, g, x)`	`boost::property_traits<PMap>::value_type`	Returns the property (specified by the `Property` type) associated with object `x` (a vertex or edge). The object `p` is only used to carry the type. This function is equivalent to: `get(get(p, g), x)`
Put Property	`put(p, g, x, v)`	`void`	Set the property (specified by the `Property` type) associated with object `x` (a vertex or edge) to the value `v`. The object `p` is only used to carry the type. This function is equivalent to: `pmap = get(p, g); put(pmap, x, v)`

Complexity

The get() property map function must be constant time.

Models

adjacency_list with VertexPlugin=plugin<vertex_distance,int,plugin<vertex_in_degree,int> > and Property=vertex_distance.
adjacency_list with VertexPlugin=plugin<vertex_distance,int,plugin<vertex_in_degree,int> > and Property=vertex_in_degree.

Concept Checking Class

  template <class Graph, class X, class Property>
  struct PropertyGraph_concept
  {
    typedef typename property_map<G, Property>::type PMap;
    typedef typename property_map<G, Property>::const_type const_PMap;
    void constraints() {
      REQUIRE(G, Graph);
      REQUIRE2(PMap, X, ReadWritePropertyMap);
      REQUIRE2(const_PMap, X, ReadablePropertyMap);

      PMap pmap = get(Property(), g);
      pval = get(Property(), g, x);
      put(Property(), g, x, pval);
      ignore_unused_variable_warning(pmap);
    }
    void const_constraints(const G& g) {
      const_PMap pmap = get(Property(), g);
      pval = get(Property(), g, x);
      ignore_unused_variable_warning(pmap);
    }
    G g;
    X x;
    typename property_traits<PMap>::value_type pval;
  };

PropertyGraph

Refinement of

Notation

Associated types

Complexity

Models

Concept Checking Class

See Also