Documentation

Embedded, *connected*, planar graph

A *connected* Planar graph with bidirected edges. I.e. the edges (darts) are directed, however, for every directed edge, the edge in the oposite direction is also in the graph.

The types v, e, and f are the are the types of the data associated with the vertices, edges, and faces, respectively.

The orbits in the embedding are assumed to be in counterclockwise order. Therefore, every dart directly bounds the face to its right.

Note that the functor instance is in v

Construct a plane graph from a simple polygon. It is assumed that the polygon is given in counterclockwise order.

the interior of the polygon will have faceId 0

pre: the input polygon is given in counterclockwise order running time: \(O(n)\).

Constructs a connected plane graph

pre: The segments form a single connected component

running time: \(O(n\log n)\)

Construct a planar graph from a adjacency matrix. For every vertex, all vertices should be given in counter clockwise order.

pre: No self-loops, and no multi-edges

running time: \(O(n)\).

Get the number of vertices

>>> numVertices myGraph
4

Get the number of Edges

>>> numEdges myGraph
6

Get the number of faces

>>> numFaces myGraph
4

Get the number of Darts

>>> numDarts myGraph
12

Enumerate all vertices

>>> vertices' myGraph
[VertexId 0,VertexId 1,VertexId 2,VertexId 3]

Enumerate all vertices, together with their vertex data

Enumerate all edges. We report only the Positive darts

Enumerate all edges with their edge data. We report only the Positive darts.

>>> mapM_ print $ edges myGraph
(Dart (Arc 2) +1,"c+")
(Dart (Arc 1) +1,"b+")
(Dart (Arc 0) +1,"a+")
(Dart (Arc 5) +1,"g+")
(Dart (Arc 4) +1,"e+")
(Dart (Arc 3) +1,"d+")

Enumerate all faces in the plane graph

All faces with their face data.

Reports all internal faces. running time: \(O(n)\)

Reports the outerface and all internal faces separately. running time: \(O(n)\)

Enumerate all darts

The vertex this dart is heading in to

running time: \(O(1)\)

The tail of a dart, i.e. the vertex this dart is leaving from

running time: \(O(1)\)

Get the twin of this dart (edge)

>>> twin (dart 0 "+1")
Dart (Arc 0) -1
>>> twin (dart 0 "-1")
Dart (Arc 0) +1

endPoints d g = (tailOf d g, headOf d g)

running time: \(O(1)\)

All edges incident to vertex v, in counterclockwise order around v.

running time: \(O(k)\), where \(k\) is the output size

All incoming edges incident to vertex v, in counterclockwise order around v.

All outgoing edges incident to vertex v, in counterclockwise order around v.

Gets the neighbours of a particular vertex, in counterclockwise order around the vertex.

running time: \(O(k)\), where \(k\) is the output size

Given a dart d that points into some vertex v, report the next dart in the cyclic order around v.

running time: \(O(1)\)

Given a dart d that points into some vertex v, report the next dart in the cyclic order around v.

running time: \(O(1)\)

The face to the left of the dart

>>> leftFace (dart 1 "+1") myGraph
FaceId 1
>>> leftFace (dart 1 "-1") myGraph
FaceId 2
>>> leftFace (dart 2 "+1") myGraph
FaceId 2
>>> leftFace (dart 0 "+1") myGraph
FaceId 0

running time: \(O(1)\).

The face to the right of the dart

>>> rightFace (dart 1 "+1") myGraph
FaceId 2
>>> rightFace (dart 1 "-1") myGraph
FaceId 1
>>> rightFace (dart 2 "+1") myGraph
FaceId 1
>>> rightFace (dart 0 "+1") myGraph
FaceId 1

running time: \(O(1)\).

Get the next edge along the face

running time: \(O(1)\).

Get the previous edge along the face

running time: \(O(1)\).

The darts bounding this face, for internal faces in clockwise order, for the outer face in counter clockwise order.

running time: \(O(k)\), where \(k\) is the output size.

Generates the darts incident to a face, starting with the given dart.

\(O(k)\), where \(k\) is the number of darts reported

The vertices bounding this face, for internal faces in clockwise order, for the outer face in counter clockwise order.

running time: \(O(k)\), where \(k\) is the output size.

gets the id of the outer face

running time: \(O(n)\)

gets a dart incident to the outer face (in particular, that has the outerface on its left)

running time: \(O(n)\)

Getter for the data at the endpoints of a dart

running time: \(O(1)\)

Data corresponding to the endpoints of the dart

running time: \(O(1)\)

Lens to access face data

lens to access the Dart Data

Lens to access the raw dart data, use at your own risk

Given a dart and the graph constructs the line segment representing the dart

\(O(1)\)

Reports all edges as line segments

Alias for rawFace Boundary

runningtime: \(O(k)\), where \(k\) is the size of the face.

The polygon describing the face

runningtime: \(O(k)\), where \(k\) is the size of the face.

Lists all faces of the plane graph.

A vertex in a planar graph. A vertex is tied to a particular planar graph by the phantom type s, and to a particular world w.

A face

A dart represents a bi-directed edge. I.e. a dart has a direction, however the dart of the oposite direction is always present in the planar graph as well.

The world in which the graph lives

Labels the edges of a plane graph with their distances, as specified by the distance function.