Math.Grads.Drawing.Coords

Module providing functions for obtaining coordinates of GenericGraphs on a 2D plane.

Documentation

type Coord e = (GraphEdge e, (V2 Float, V2 Float))

Coord is pair that containts graph's edge and coordinates of vertices that are incident to it.

type CoordList e = [Coord e]

Alias for list of Coords.

type CoordMap = Map Int (Float, Float)

Map that matches indexes of vertices to coordinates of these vertices.

class Graph g => Drawable g v e where

Type class that defines whether graph can be drawn or not.

Minimal complete definition

Nothing

Methods

edgeFixator :: g v e -> EdgeFixator e

Change coordinates and fixate edges that shouldn't take part in sampling.

type EdgeFixator e = CoordMap -> (EdgeList e, CoordMap)

Type alias for function that, given CoordMap of graph, returns modified version of that CoordMap alongside with EdgeList of graph's edges of that shouldn't participate in sampling.

bondLength :: Float

This constant is used to determine length of one edge when graph is drawn.

getCoordsForGraph :: (Ord v, Ord e, Eq e, Drawable GenericGraph v e) => StdGen -> GenericGraph v e -> Maybe CoordMap

Given StdGen returns CoordMap, which keys correspond to indices of vertices of given GenericGraph. Works only for simple planar graphs. If graph is neither simple nor planar, returns Nothing. This function is best used for graphs that can be represented as systems of conjugated cycles and paths between them. If graph contains too complex conjugated cycles, function will return Nothing.