com.codemelon.graph.vertex

Interface Vertex

All Known Subinterfaces:

BfsVertex, ChildVertex, ColoredVertex, ComponentVertex, DfsVertex, DistanceVertex, EdgeColorVertex<E>, EdgeDataVertex<T>, EdgeTypeDfsVertex<T>, EdgeTypeVertex<T>, EdgeWeightVertex<T>, KruskalVertex<E>, OrderedDfsVertex, OrderedSearchVertex, PrimVertex<E>, ShortestPathVertex<E>, VisitedVertex, WeightedVertex

All Known Implementing Classes:

AbstractVertex, DirectedDfsVertex, DirectedEdgeDataVertex, DirectedOrderedDfsVertex, DirectedShortestPathVertex, DirectedSimpleColoredVertex, DirectedSimpleVertex, UndirectedBfsVertex, UndirectedEdgeDataVertex, UndirectedKruskalVertex, UndirectedPrimVertex, UndirectedSimpleVertex

public interface Vertex

Basic specification which any Vertex class must implement

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Vertex> boolean	addAdjacency(T to) Adds the specified vertex to the set of adjacencies.
int	adjacencyCount() Returns the number of vertices in the adjacency set
void	clearAdjacencies() Removes all vertices from the adjacency set.
boolean	containsAdjacency(Vertex to) Returns true if the adjacency set contains the specified vertex
java.util.Set<? extends Vertex>	getAdjacencies() Returns a set of all adjacent vertices
AbstractGraph<? extends Vertex>	getGraph() Returns the graph to which the vertex belongs.
boolean	hasAdjacencies() Returns true if the vertex is the tail of at least one edge
boolean	removeAdjacency(Vertex to) Removes the specified vertex from the adjacency set.
void	setGraph(AbstractGraph<? extends Vertex> graph) Set the graph to which the vertex belongs

Method Detail

setGraph

void setGraph(AbstractGraph<? extends Vertex> graph)

Set the graph to which the vertex belongs

Parameters:

graph - graph with which the vertex is to be associated

getGraph

AbstractGraph<? extends Vertex> getGraph()

Returns the graph to which the vertex belongs.

Returns:

the graph to which the vertex belongs

addAdjacency

<T extends Vertex> boolean addAdjacency(T to)

Adds the specified vertex to the set of adjacencies. Note that this method only adds a directed adjacency. If the vertex belongs to an undirected graph, the graph will be put into an inconsistent state if an adjacency (u, v) is added using this method without also adding the directed adjacency (v, u)!

Parameters:

to - vertex to be added

Returns:

true if the adjacency list did not already contain to

removeAdjacency

boolean removeAdjacency(Vertex to)

Removes the specified vertex from the adjacency set. Note that this method only removes a directed adjacency.

Parameters:

to - vertex to be removed

Returns:

true if the vertex was found in the adjacency set

clearAdjacencies

void clearAdjacencies()

Removes all vertices from the adjacency set. The adjacency set will be empty after this call returns. The cautionary statements regarding the use of removeAdjacency() in an undirected graph also apply to this method.

containsAdjacency

boolean containsAdjacency(Vertex to)

Returns true if the adjacency set contains the specified vertex

Parameters:

to - vertex whose presence is to be tested

Returns:

true if to is found in the adjacency set

adjacencyCount

int adjacencyCount()

Returns the number of vertices in the adjacency set

Returns:

the number of vertices in this adjacency set (its cardinality)

getAdjacencies

java.util.Set<? extends Vertex> getAdjacencies()

Returns a set of all adjacent vertices

Returns:

a set of all adjacent vertices

hasAdjacencies

boolean hasAdjacencies()

Returns true if the vertex is the tail of at least one edge

Returns:

true if the vertex has at least one adjacency