Data.Graph.Types.Internal

Unsafe Internals

The internals provided here do not constitute part of the stable API. Additionally, they are unsafe. Using these data constructors directly can cause other functions in this library to segfault. If you find that you need something from this module, consider opening up an issue on github so that the functionality you need can be provided by the safe API instead.

Documentation

newtype Graph g e v

A Graph with edges labeled by e and vertices labeled by v. The g type variable is a phatom type that associates a Graph with vertices that belong to it.

Constructors

Graph

Fields

• getGraphInternal :: SomeGraph e v

Instances

Functor (Graph g e)

Methods

fmap :: (a -> b) -> Graph g e a -> Graph g e b

(<$) :: a -> Graph g e b -> Graph g e a

data SomeGraph e v

This is a Graph without the phantom type variable. Very few functions work with this type.

Constructors

SomeGraph

Fields

• graphVertices :: !(Vector v)
• graphOutboundNeighborVertices :: !(Vector (Vector Int))
• graphOutboundNeighborEdges :: !(Vector (Vector e))

Instances

Functor (SomeGraph e)

Methods

fmap :: (a -> b) -> SomeGraph e a -> SomeGraph e b

(<$) :: a -> SomeGraph e b -> SomeGraph e a

(Eq e, Eq v) => Eq (SomeGraph e v)

Methods

(==) :: SomeGraph e v -> SomeGraph e v -> Bool

(/=) :: SomeGraph e v -> SomeGraph e v -> Bool

(Ord e, Ord v) => Ord (SomeGraph e v)

Methods

compare :: SomeGraph e v -> SomeGraph e v -> Ordering

(<) :: SomeGraph e v -> SomeGraph e v -> Bool

(<=) :: SomeGraph e v -> SomeGraph e v -> Bool

(>) :: SomeGraph e v -> SomeGraph e v -> Bool

(>=) :: SomeGraph e v -> SomeGraph e v -> Bool

max :: SomeGraph e v -> SomeGraph e v -> SomeGraph e v

min :: SomeGraph e v -> SomeGraph e v -> SomeGraph e v

newtype Size g

Constructors

Size

Fields

• getSizeInternal :: Int

newtype Vertex g

A reference to a vertex in a Graph with matching type variable g. Vertex is a thin wrapper for Int and does not hold the label of the vertex.

Constructors

Vertex

Fields

• getVertexInternal :: Int

Instances

Eq (Vertex g)

Methods

(==) :: Vertex g -> Vertex g -> Bool

(/=) :: Vertex g -> Vertex g -> Bool

Ord (Vertex g)

Methods

compare :: Vertex g -> Vertex g -> Ordering

(<) :: Vertex g -> Vertex g -> Bool

(<=) :: Vertex g -> Vertex g -> Bool

(>) :: Vertex g -> Vertex g -> Bool

(>=) :: Vertex g -> Vertex g -> Bool

max :: Vertex g -> Vertex g -> Vertex g

min :: Vertex g -> Vertex g -> Vertex g

Hashable (Vertex g)

Methods

hashWithSalt :: Int -> Vertex g -> Int

hash :: Vertex g -> Int

newtype Vertices g v

All vertices in a Graph with matching type variable g.

Constructors

Vertices

Fields

• getVerticesInternal :: Vector v

Instances

Functor (Vertices g)

Methods

fmap :: (a -> b) -> Vertices g a -> Vertices g b

(<$) :: a -> Vertices g b -> Vertices g a

newtype MVertices s g v

Mutable vertices that have the same length as the vertices in a Graph. This is used to safely implement algorithms that need to mark vertices as they traverse a graph.

Constructors

MVertices

Fields

• getMVerticesInternal :: MVector s v

newtype MUVertices s g v

Mutable unboxed vertices that have the same length as the vertices in a Graph. See MVertices.

Constructors

MUVertices

Fields

• getMUVerticesInternal :: MVector s v

data IntPair

A strict pair of Ints. This is used internally.

Constructors

IntPair !Int !Int

Instances

Eq IntPair

Methods

(==) :: IntPair -> IntPair -> Bool

(/=) :: IntPair -> IntPair -> Bool

Ord IntPair

Methods

compare :: IntPair -> IntPair -> Ordering

(<) :: IntPair -> IntPair -> Bool

(<=) :: IntPair -> IntPair -> Bool

(>) :: IntPair -> IntPair -> Bool

(>=) :: IntPair -> IntPair -> Bool

max :: IntPair -> IntPair -> IntPair

min :: IntPair -> IntPair -> IntPair

Read IntPair

Methods

readsPrec :: Int -> ReadS IntPair

readList :: ReadS [IntPair]

readPrec :: ReadPrec IntPair

readListPrec :: ReadPrec [IntPair]

Show IntPair

Methods

showsPrec :: Int -> IntPair -> ShowS

show :: IntPair -> String

showList :: [IntPair] -> ShowS

Generic IntPair

Associated Types

type Rep IntPair :: * -> *

Methods

from :: IntPair -> Rep IntPair x

to :: Rep IntPair x -> IntPair

Hashable IntPair

Methods

hashWithSalt :: Int -> IntPair -> Int

hash :: IntPair -> Int

type Rep IntPair

type Rep IntPair = D1 (MetaData "IntPair" "Data.Graph.Types.Internal" "impure-containers-0.4.1-6WsephHmhVTIlQkAp4UpuT" False) (C1 (MetaCons "IntPair" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

data MGraph s g e v

This is more accurately thought of as a graph builder rather than a mutable graph. You can add vertices and edges, and you can delete edges, but you cannot delete vertices.

Constructors

MGraph

Fields

• mgraphVertexIndex :: !(MHashMap s v Int)
• mgraphCurrentId :: !(MutVar s Int)
• mgraphEdges :: !(MHashMap s IntPair e)

type IOGraph = MGraph RealWorld

type STGraph s = MGraph s