libraries.libtw

Class LibTW

java.lang.Object

graphana.graphs.GraphLibrary<LibTWVertex,LibTWEdge>

libraries.libtw.LibTW

public class LibTW
extends GraphLibrary<LibTWVertex,LibTWEdge>

Binds the LibTW graph library to access its tree width algorithms

Field Summary

Fields inherited from class graphana.graphs.GraphLibrary

DEFAULTDIRECTED, DEFAULTFORCELOOPFREE, DEFAULTWEIGHTED, directed, graphCreated, SET_STATUS, weighted

Constructor Summary

Constructors

Constructor and Description
LibTW()

Method Summary

Modifier and Type	Method and Description
void	checkPrefaceGraph(boolean directed, boolean weighted, boolean forceLoopFree, GraphLibrary<?,?> preface) Checks whether or not this graph library would be able to create a graph which is equivalent to the given graph.
protected LibTWEdge	derivAddEdge(LibTWVertex vertex1, LibTWVertex vertex2) Must create an edge and add it to the internal graph.
protected LibTWVertex	derivAddVertex() Must create a vertex and add it to the internal graph.
protected void	derivCreateGraph(boolean directed, boolean weighted, boolean forceLoopFree) Must create the internal graph with the given COnfiguration.
protected double	derivGetEdgeWeight(LibTWEdge edge) Returns the weight of the given edge.
LibTWVertex	derivGetEndVertex(LibTWEdge edge) Returns the end point of the given edge.
LibTWVertex	derivGetStartVertex(LibTWEdge edge) Returns the start point of the given edge.
protected void	derivRemoveEdge(LibTWEdge edge) Removes the given edge from the internal graph
protected void	derivRemoveVertex(LibTWVertex vertex) Removes the given vertex from the internal graph.
protected void	derivSetEdgeWeight(LibTWEdge edge, double weight) Sets the given weight as the weight of the given edge.
protected void	derivSetVertexIdent(LibTWVertex vertex, java.lang.String ident) Changes the identifier of the given vertex.
protected GraphConfiguration	getDefaultGraphConfiguration() Returns a GraphConfiguration which is working with the respective graph.
LibTWEdge	getEdge(LibTWVertex vertex1, LibTWVertex vertex2) Returns the edge which contains the given vertices.
int	getEdgeCount()
java.lang.Object	getEdgeData(LibTWEdge edge) Returns the data of the given edge.
java.lang.Iterable<LibTWEdge>	getEdges()
java.lang.Object	getEdgeStatus(LibTWEdge edge) Returns the status of the given edge in O(1).
int	getIngoingEdgeCount(LibTWVertex vertex) Returns the amount of ingoing edges of the given vertex.
java.lang.Iterable<LibTWEdge>	getIngoingEdges(LibTWVertex vertex) Returns all ingoing edges of the given vertex.
nl.uu.cs.treewidth.ngraph.NGraph<nl.uu.cs.treewidth.input.GraphInput.InputData>	getInternalGraph() Returns the internal graph.
java.lang.String	getLibName() Returns the (constant) name of the graph library.
int	getOutgoingEdgeCount(LibTWVertex vertex) Returns the amount of outgoing edges of the given vertex.
java.lang.Iterable<LibTWEdge>	getOutgoingEdges(LibTWVertex vertex) Returns all outgoing edges of the given vertex.
int	getVertexCount()
java.lang.Object	getVertexData(LibTWVertex vertex) Returns the data of the given vertex.
java.lang.String	getVertexIdent(LibTWVertex vertex) Returns the identifier of the given vertex.
java.lang.Object	getVertexStatus(LibTWVertex vertex) Returns the status of the given vertex in O(1).
java.lang.Iterable<LibTWVertex>	getVertices()
void	prepareAlgorithmRun() Called just before an algorithm is executed using this instance.
void	setEdgeData(LibTWEdge edge, java.lang.Object data) Sets the data of the given edge.
void	setEdgeStatus(LibTWEdge edge, java.lang.Object status) Sets the status of the given edge in O(1).
void	setVertexData(LibTWVertex vertex, java.lang.Object data) Sets the data of the given vertex.
void	setVertexStatus(LibTWVertex vertex, java.lang.Object status) Sets the status of the given vertex in O(1).

Methods inherited from class graphana.graphs.GraphLibrary

addEdge, addEdge, addEdge, addEdgeByIdent, addGraphListener, addVertex, addVertex, addVertex, addVertex, asConfigurated, clearAlgorithmResults, clearDates, clearEdgeData, clearEdgeDates, clearEdgeStates, clearEdgeStatus, clearGraph, clearStates, clearVertexData, clearVertexDates, clearVertexStates, clearVertexStatus, copyFromExistingGraph, copyFromExistingGraph, copyToGraph, copyToGraph, copyToGraph, createDefaultGraph, createGraph, createGraph, createGraph, createGraph, createGraphUnchecked, createGraphUnchecked, createMetaEdge, deleteLoops, deleteWarning, derivCopyFromExistingGraph, edgeExists, edgeExistsByIdent, edgesToString, edgeToString, enableLoops, forceLoopFree, getAlgorithmResult, getAverageDegree, getEdgeByIdent, getEdgeName, getEdgeWeight, getEdgeWeight, getEdgeWeightByIdent, getEndVertex, getEndVertex, getGraphId, getIncidentEdges, getMarkedEdgeCount, getMarkedVertexCount, getMaximumDegree, getMinimumDegree, getName, getNeighborCount, getNeighbors, getNextVertexIdentifier, getStartVertex, getUnmarkedNeighborCount, getVertexByIdent, getVertexByIdent, getVertexIdentUnchecked, getVertexStdPrefix, getVisualElements, graphModified, hasAlgorithmResult, hasEdgeData, hasVertexData, isDirected, isEdgeMarkedAsDeleted, isEdgeStatusSet, isEmpty, isForceLoopFree, isGraphCreated, isLoopFree, isVertexMarkedAsDeleted, isVertexStatusSet, isWeighted, markEdgeAsDeleted, markVertexAsDeleted, mergeGraph, metaEdgeToString, pollWarning, printWarning, putWarning, refresh, removeAlgorithmResult, removeEdge, removeEdge, removeEdge, removeEdgeDeletionMark, removeGraphListener, removeVertex, removeVertex, removeVertexDeletionMark, resolveVertexName, setAlgorithmResult, setBlockCacheOutput, setDirected, setEdgeDates, setEdgeStates, setEdgeWeight, setName, setVertexDates, setVertexIdent, setVertexStates, setVertexStatus, setVertexStdPrefix, supportsCopyFromExistingGraph, toString, vertexExistsByIdent, vertexToString, verticesToString

Methods inherited from class java.lang.Object

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

Constructor Detail

LibTW

public LibTW()

Method Detail

derivAddEdge

protected LibTWEdge derivAddEdge(LibTWVertex vertex1,
                                 LibTWVertex vertex2)

Description copied from class: GraphLibrary

Must create an edge and add it to the internal graph.

Specified by:

derivAddEdge in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex1 - The first endpoint.

vertex2 - The second endpoint.

Returns:

Reference to the added edge.

derivAddVertex

protected LibTWVertex derivAddVertex()

Description copied from class: GraphLibrary

Must create a vertex and add it to the internal graph. It's identifier will be given in a later call.

Specified by:

derivAddVertex in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

Reference to the added vertex.

derivCreateGraph

protected void derivCreateGraph(boolean directed,
                                boolean weighted,
                                boolean forceLoopFree)
                         throws InvalidGraphConfigException

Description copied from class: GraphLibrary

Must create the internal graph with the given COnfiguration.

Specified by:

derivCreateGraph in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

directed - Determines, whether the graph shall be directed.

weighted - Determines, whether the graph shall be weighted.

forceLoopFree - Determines, whether it is impossible to add loops into the graph

Throws:

InvalidGraphConfigException - If the given configuration is not

checkPrefaceGraph

public void checkPrefaceGraph(boolean directed,
                              boolean weighted,
                              boolean forceLoopFree,
                              GraphLibrary<?,?> preface)
                       throws InvalidGraphConfigException

Description copied from class: GraphLibrary

Checks whether or not this graph library would be able to create a graph which is equivalent to the given graph.

Overrides:

checkPrefaceGraph in class GraphLibrary<LibTWVertex,LibTWEdge>

preface - the graph to check.

Throws:

InvalidGraphConfigException - if this graph library is not able to create an equivalent graph to the given graph.

derivGetEdgeWeight

protected double derivGetEdgeWeight(LibTWEdge edge)

Description copied from class: GraphLibrary

Returns the weight of the given edge. This method is never called if the graph is unweighted.

Specified by:

derivGetEdgeWeight in class GraphLibrary<LibTWVertex,LibTWEdge>

derivGetStartVertex

public LibTWVertex derivGetStartVertex(LibTWEdge edge)

Description copied from class: GraphLibrary

Returns the start point of the given edge.

Specified by:

derivGetStartVertex in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

the start point of the given edge.

derivGetEndVertex

public LibTWVertex derivGetEndVertex(LibTWEdge edge)

Description copied from class: GraphLibrary

Returns the end point of the given edge.

Specified by:

derivGetEndVertex in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

the end point of the given edge.

derivRemoveEdge

protected void derivRemoveEdge(LibTWEdge edge)

Description copied from class: GraphLibrary

Removes the given edge from the internal graph

Specified by:

derivRemoveEdge in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

edge - The edge which shall be removed

derivRemoveVertex

protected void derivRemoveVertex(LibTWVertex vertex)

Description copied from class: GraphLibrary

Removes the given vertex from the internal graph.

Specified by:

derivRemoveVertex in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - The vertex which shall be removed

derivSetEdgeWeight

protected void derivSetEdgeWeight(LibTWEdge edge,
                                  double weight)

Description copied from class: GraphLibrary

Sets the given weight as the weight of the given edge.

Specified by:

derivSetEdgeWeight in class GraphLibrary<LibTWVertex,LibTWEdge>

derivSetVertexIdent

protected void derivSetVertexIdent(LibTWVertex vertex,
                                   java.lang.String ident)

Description copied from class: GraphLibrary

Changes the identifier of the given vertex.

Specified by:

derivSetVertexIdent in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - The vertex its identifier shall be set

ident - The new identifier

getEdge

public LibTWEdge getEdge(LibTWVertex vertex1,
                         LibTWVertex vertex2)

Description copied from class: GraphLibrary

Returns the edge which contains the given vertices. If the graph is undirected then the order of the two given vertices is not important.

Specified by:

getEdge in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex1 - The first vertex (start point if the graph is directed)

vertex2 - The second vertex (end point if the graph is directed)

Returns:

The respective edge

getEdgeData

public java.lang.Object getEdgeData(LibTWEdge edge)

Description copied from class: GraphLibrary

Returns the data of the given edge.

Specified by:

getEdgeData in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

edge - the edge.

Returns:

the data of the given edge.

getEdgeStatus

public java.lang.Object getEdgeStatus(LibTWEdge edge)

Description copied from class: GraphLibrary

Returns the status of the given edge in O(1).

Specified by:

getEdgeStatus in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

edge - the edge.

Returns:

the status of the given edge.

getEdges

public java.lang.Iterable<LibTWEdge> getEdges()

Specified by:

getEdges in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An iterator which iterates over all edges of the graph.

getEdgeCount

public int getEdgeCount()

Specified by:

getEdgeCount in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

The current amount of edges.

getIngoingEdgeCount

public int getIngoingEdgeCount(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns the amount of ingoing edges of the given vertex. If the graph is directed, then simply the amount of all incident edges is given. A loop is ingoing and outgoing at the same time and therefore counts as one.

Specified by:

getIngoingEdgeCount in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An integer indicating the number of ingoing edges of the given vertex.

getIngoingEdges

public java.lang.Iterable<LibTWEdge> getIngoingEdges(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns all ingoing edges of the given vertex. If the graph is directed then simply all incident edges of the vertex are given. A loop is ingoing and outgoing at the same time.

Specified by:

getIngoingEdges in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An iterator which iterates over all ingoing edges of the given vertex.

getOutgoingEdgeCount

public int getOutgoingEdgeCount(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns the amount of outgoing edges of the given vertex. If the graph is directed, then simply the amount of all incident edges is given. A loop is ingoing and outgoing at the same time and therefore counts as one.

Specified by:

getOutgoingEdgeCount in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An integer indicating the number of outgoing edges of the given vertex.

getOutgoingEdges

public java.lang.Iterable<LibTWEdge> getOutgoingEdges(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns all outgoing edges of the given vertex. If the graph is directed then simply all incident edges of the vertex are given. A loop is ingoing and outgoing at the same time.

Specified by:

getOutgoingEdges in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An iterator which iterates over all outgoing edges of the given vertex.

getInternalGraph

public nl.uu.cs.treewidth.ngraph.NGraph<nl.uu.cs.treewidth.input.GraphInput.InputData> getInternalGraph()

Description copied from class: GraphLibrary

Returns the internal graph.

Specified by:

getInternalGraph in class GraphLibrary<LibTWVertex,LibTWEdge>

getLibName

public java.lang.String getLibName()

Description copied from class: GraphLibrary

Returns the (constant) name of the graph library.

Specified by:

getLibName in class GraphLibrary<LibTWVertex,LibTWEdge>

getVertexCount

public int getVertexCount()

Specified by:

getVertexCount in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

The current amount of vertices.

getVertexData

public java.lang.Object getVertexData(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns the data of the given vertex.

Specified by:

getVertexData in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - the vertex.

Returns:

the data of the given vertex.

getVertexIdent

public java.lang.String getVertexIdent(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns the identifier of the given vertex.

Specified by:

getVertexIdent in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - The vertex its identifier shall be returned

Returns:

the identifier of the given vertex

getVertexStatus

public java.lang.Object getVertexStatus(LibTWVertex vertex)

Description copied from class: GraphLibrary

Returns the status of the given vertex in O(1).

Specified by:

getVertexStatus in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - the vertex.

Returns:

the status of the given vertex.

getVertices

public java.lang.Iterable<LibTWVertex> getVertices()

Specified by:

getVertices in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

An iterator which iterates over all vertices of the graph.

setEdgeData

public void setEdgeData(LibTWEdge edge,
                        java.lang.Object data)

Description copied from class: GraphLibrary

Sets the data of the given edge. The previous data will be overwritten.

Specified by:

setEdgeData in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

edge - the edge of which the data shall be set.

data - the new data.

setEdgeStatus

public void setEdgeStatus(LibTWEdge edge,
                          java.lang.Object status)

Description copied from class: GraphLibrary

Sets the status of the given edge in O(1).

Specified by:

setEdgeStatus in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

edge - the edge of which the status shall be set.

status - the new status to set.

setVertexData

public void setVertexData(LibTWVertex vertex,
                          java.lang.Object data)

Description copied from class: GraphLibrary

Sets the data of the given vertex. The previous data will be overwritten.

Specified by:

setVertexData in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - the vertex of which thee status shall be set.

data - the new data to set.

setVertexStatus

public void setVertexStatus(LibTWVertex vertex,
                            java.lang.Object status)

Description copied from class: GraphLibrary

Sets the status of the given vertex in O(1).

Specified by:

setVertexStatus in class GraphLibrary<LibTWVertex,LibTWEdge>

Parameters:

vertex - the vertex of which the status shall be set.

status - the new status to set.

getDefaultGraphConfiguration

protected GraphConfiguration getDefaultGraphConfiguration()

Description copied from class: GraphLibrary

Returns a GraphConfiguration which is working with the respective graph. The method createGraph must work with the given configuration.

Specified by:

getDefaultGraphConfiguration in class GraphLibrary<LibTWVertex,LibTWEdge>

Returns:

A valid GraphConfiguration

prepareAlgorithmRun

public void prepareAlgorithmRun()

Description copied from class: GraphLibrary

Called just before an algorithm is executed using this instance.

Overrides:

prepareAlgorithmRun in class GraphLibrary<LibTWVertex,LibTWEdge>