3.2.10. VertexMap.hpp¶

3.2.10.1. Class `template<typename Domain, typename Codomain> VertexMap`¶

template<typename Domain, typename Codomain> class VertexMap¶

A class template used to represent general vertex maps.

3.2.10.1.1. Synopsis¶

using DomainHandle = GraphHandle<Domain>
using CodomainHandle = GraphHandle<Codomain>
using DomVertex = typename Domain::Vertex
using CodomVertex = typename Codomain::Vertex
friend std::ostream &operator<<(std::ostream &s, const VertexMap &m)
DomainHandle getDomain() const
CodomainHandle getCodomain() const
CodomVertex operator[](DomVertex v) const
DomVertex getInverse(CodomVertex v) const

3.2.10.1.2. Details¶

using DomainHandle = GraphHandle<Domain>¶
using CodomainHandle = GraphHandle<Codomain>¶

using DomVertex = typename Domain::Vertex¶
using CodomVertex = typename Codomain::Vertex¶

friend std::ostream &operator<<(std::ostream &s, const VertexMap &m)¶

DomainHandle getDomain() const¶

CodomainHandle getCodomain() const¶

Returns:: the domain and codomain graphs for the vertex map.

CodomVertex operator[](DomVertex v) const¶

Returns:: the image of the given domain vertex. May return a null vertex if the map is partial.
Throws:: LogicError if !v.
Throws:: LogicError if v.getGraph() != getDomain().

DomVertex getInverse(CodomVertex v) const¶

Returns:: the domain vertex that maps to the given codomain vertex. May return a null vertex if non exist.
Throws:: LogicError if !v.
Throws:: LogicError if v.getGraph() != getCodomain().