io.ataraxic.nomicflux.voyageur.impl

Class AdjListGraph<A,L,W>

Object

AdjListGraph<A,L,W>

Type Parameters:

A - The type of the nodes' ID values

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edges

All Implemented Interfaces:

Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

public final class AdjListGraph<A,L,W>
extends Object
implements Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

An adjacency list representation of a graph, using ValueNode, ValueEdge, and ValueContext to minimize the need supplying type parameters

Method Summary

Modifier and Type	Method and Description
AdjListGraph<A,L,W>	addEdge(ValueEdge<A,L,W> edge)
AdjListGraph<A,L,W>	addNode(ValueNode<A,L> node)
Choice2<AdjListGraph<A,L,W>,Tuple2<Context<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>>,AdjListGraph<A,L,W>>>	atNode(ValueNode<A,L> node) Decompose a graph at a given Node into the node's Context and the rest of the graph
Maybe<Tuple2<Context<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>>,AdjListGraph<A,L,W>>>	decompose() Implementation-dependent and possibly non-deterministic decomposition of a graph into a Context and the rest of the graph
static <A,L,W> AdjListGraph<A,L,W>	emptyGraph() Create a new, empty AdjListGraph
static <A> AdjListGraph<A,Unit,Unit>	fromChain(Iterable<A> values) Create an unlabeled, unweighted AdjListGraph using an iterable of node ID values
static <A> AdjListGraph<A,Unit,Unit>	fromChains(Iterable<Iterable<A>> values) Create an unlabeled, unweighted AdjListGraph from iterables of node ID values
static <A,L,W> AdjListGraph<A,L,W>	fromEdge(ValueEdge<A,L,W> edge) Create an AdjListGraph with a single ValueEdge and the attached ValueNodes
static <A,L,W> AdjListGraph<A,L,W>	fromEdges(Iterable<ValueEdge<A,L,W>> edges) Create an AdjListGraph from an iterable of ValueEdge
Boolean	isEmpty()
AdjListGraph<A,L,W>	removeEdge(ValueEdge<A,L,W> edge)
AdjListGraph<A,L,W>	removeNode(ValueNode<A,L> node)
static <A,L,W> AdjListGraph<A,L,W>	singletonGraph(ValueNode<A,L> a) Create an AdjListGraph with a single ValueNode and no edges

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Graph

addEdge, addNode, atNode, guidedCutFold, guidedFold, removeEdge, removeNode, simpleCutFold, simpleFold

Method Detail

isEmpty

public Boolean isEmpty()

Specified by:

isEmpty in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Returns:

Whether the current graph is empty

emptyGraph

public static <A,L,W> AdjListGraph<A,L,W> emptyGraph()

Create a new, empty AdjListGraph

Type Parameters:

A - The type of the nodes' ID values

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edges

Returns:

An empty AdjListGraph with type parameters set for nodes and edges

singletonGraph

public static <A,L,W> AdjListGraph<A,L,W> singletonGraph(ValueNode<A,L> a)

Create an AdjListGraph with a single ValueNode and no edges

Type Parameters:

A - The type of the nodes' ID values

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edges

Parameters:

a - A ValueNode

Returns:

A graph with a disconnected ValueNode and no edges

fromEdge

public static <A,L,W> AdjListGraph<A,L,W> fromEdge(ValueEdge<A,L,W> edge)

Create an AdjListGraph with a single ValueEdge and the attached ValueNodes

Type Parameters:

A - The type of the nodes' ID values

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edges

Parameters:

edge - A ValueEdge

Returns:

The graph consisting of just the two nodes in the edge and their connection

fromEdges

public static <A,L,W> AdjListGraph<A,L,W> fromEdges(Iterable<ValueEdge<A,L,W>> edges)

Create an AdjListGraph from an iterable of ValueEdge

Type Parameters:

A - The type of the nodes' ID values

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edges

Parameters:

edges - Iterable of ValueEdge to form the basis for the graph

Returns:

A graph consisting of all of the edges given in edges

fromChain

public static <A> AdjListGraph<A,Unit,Unit> fromChain(Iterable<A> values)

Create an unlabeled, unweighted AdjListGraph using an iterable of node ID values

Type Parameters:

A - The type of the nodes' ID values

Parameters:

values - ID values for a string of ValueNodes connected in the order provided

Returns:

A linear graph connecting nodes in the order provided in values

fromChains

public static <A> AdjListGraph<A,Unit,Unit> fromChains(Iterable<Iterable<A>> values)

Create an unlabeled, unweighted AdjListGraph from iterables of node ID values

Type Parameters:

A - The type of the nodes' ID values

Parameters:

values - ID values for strings of ValueNodes connected in the order provided within each iterable

Returns:

A graph connecting nodes in the orders provided in values

addEdge

public AdjListGraph<A,L,W> addEdge(ValueEdge<A,L,W> edge)

Specified by:

addEdge in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Parameters:

edge - Edge to add to graph

Returns:

Graph G with edge added

removeEdge

public AdjListGraph<A,L,W> removeEdge(ValueEdge<A,L,W> edge)

Specified by:

removeEdge in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Parameters:

edge - Edge to remove from graph

Returns:

Graph G with edge removed

addNode

public AdjListGraph<A,L,W> addNode(ValueNode<A,L> node)

Specified by:

addNode in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Parameters:

node - Node to add to graph

Returns:

Graph G with disconnected node added

removeNode

public AdjListGraph<A,L,W> removeNode(ValueNode<A,L> node)

Specified by:

removeNode in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Parameters:

node - Node to remove from graph

Returns:

Graph G with node and all connected edges removed

decompose

public Maybe<Tuple2<Context<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>>,AdjListGraph<A,L,W>>> decompose()

Implementation-dependent and possibly non-deterministic decomposition of a graph into a Context and the rest of the graph

Specified by:

decompose in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Returns:

Either the Context and the graph with the context's Node and Edges removed, or nothing to indicate the graph is empty

atNode

public Choice2<AdjListGraph<A,L,W>,Tuple2<Context<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>>,AdjListGraph<A,L,W>>> atNode(ValueNode<A,L> node)

Decompose a graph at a given Node into the node's Context and the rest of the graph

Specified by:

atNode in interface Graph<A,ValueNode<A,L>,ValueEdge<A,L,W>,HashSet<ValueEdge<A,L,W>>,AdjListGraph<A,L,W>>

Parameters:

node - Node to find in the graph, around which to base a decomposition

Returns:

Either the whole graph G if the node cannot be found, or a decomposition into a context centered on node and the rest of the graph