org.mathIT.graphs

Interface Vertible<V extends Vertible<V>>

Type Parameters:

V - the type of the vertices of the graph

All Known Implementing Classes:

Actor, SimpleVertex, Vertex

public interface Vertible<V extends Vertible<V>>

This interface specifies classes representing a vertex of a graph.

Version:

1.1

Author:

Andreas de Vries

See Also:

Graph

Method Summary

Modifier and Type	Method and Description
V	copy() Creates and returns a new copy of this object.
V[]	getAdjacency() Returns the adjacency list of this vertex as specified by the graph it belongs to.
double	getDistance() Returns the distance of the shortest path from a specified source to this vertex as determined by the Dijkstra algorithm.
int	getIndex() Returns the index of this vertex as specified by the graph it belongs to.
String	getName() Returns the name of this vertex.
V	getPredecessor() Returns the predecessor of this vertex in the shortest path from a specified source as determined by the Dijkstra algorithm.
boolean	isInProcess() Returns a flag if this vertex is in process.
boolean	isMarked() Returns a flag if this vertex is marked.
void	mark() Marks this vertex as true.
void	setAdjacency(V[] adjacency) Sets the adjacency list of this vertex as specified by the graph it belongs to.
void	setDistance(double distance) Sets the distance of the shortest path from a specified source to this vertex as determined by the Dijkstra algorithm.
void	setIndex(int index) Sets the index of this vertex as specified by the graph it belongs to.
void	setInProcess(boolean inProcess) Sets this vertex process flag to the specified value.
void	setMarked(boolean marked) Sets this vertex mark flag to the specified value.
void	setName(String name) Sets the index of this vertex as specified by the graph it belongs to.
void	setPredecessor(V predecessor) Sets the predecessor of this vertex in the shortest path from a specified source as determined by the Dijkstra algorithm.

Method Detail

copy

V copy()

Creates and returns a new copy of this object. For any object x, the expression x.copy() != x is true. The typical implementation in a class VertexClazz implementing this interface could simply look like return new VertexClazz(...).

Returns:

a copy of this object

setName

void setName(String name)

Sets the index of this vertex as specified by the graph it belongs to. The index has to be consistent with the weight matrix of the graph.

Parameters:

name - the name of this vertex in the graph

getName

String getName()

Returns the name of this vertex.

Returns:

the name of this vertex

getIndex

int getIndex()

Returns the index of this vertex as specified by the graph it belongs to. The index has to be consistent with the weight matrix of the graph.

Returns:

the name of this vertex

setIndex

void setIndex(int index)

Sets the index of this vertex as specified by the graph it belongs to. The index has to be consistent with the weight matrix of the graph.

Parameters:

index - the index of this vertex in the graph

getAdjacency

V[] getAdjacency()

Returns the adjacency list of this vertex as specified by the graph it belongs to. The adjacency list has to be consistent with the weight matrix of the graph.

Returns:

the adjacency list this vertex

setAdjacency

void setAdjacency(V[] adjacency)

Sets the adjacency list of this vertex as specified by the graph it belongs to. The adjacency list has to be consistent with the weight matrix of the graph.

Parameters:

adjacency - the adjacency list this vertex

getPredecessor

V getPredecessor()

Returns the predecessor of this vertex in the shortest path from a specified source as determined by the Dijkstra algorithm.

Returns:

the predecessor of this vertex in the shortest path

setPredecessor

void setPredecessor(V predecessor)

Sets the predecessor of this vertex in the shortest path from a specified source as determined by the Dijkstra algorithm.

Parameters:

predecessor - the predecessor of this vertex in the shortest path

See Also:

WeightedGraph

getDistance

double getDistance()

Returns the distance of the shortest path from a specified source to this vertex as determined by the Dijkstra algorithm.

Returns:

the distance of this vertex in the shortest path

See Also:

WeightedGraph

setDistance

void setDistance(double distance)

Sets the distance of the shortest path from a specified source to this vertex as determined by the Dijkstra algorithm.

Parameters:

distance - the distance of this vertex in the shortest path

mark

void mark()

Marks this vertex as true. The mark is designed to be utilized as a temporary and dynamic attribute for algorithms.

setMarked

void setMarked(boolean marked)

Sets this vertex mark flag to the specified value. The mark is designed to be utilized as a temporary and dynamic attribute for algorithms.

Parameters:

marked - flag which marks this vertex

isMarked

boolean isMarked()

Returns a flag if this vertex is marked. The flag is designed to be utilized as a temporary and dynamic attribute for algorithms.

Returns:

true if and only this vertex is marked

isInProcess

boolean isInProcess()

Returns a flag if this vertex is in process. The flag is designed to be utilized as a temporary and dynamic attribute for algorithms.

Returns:

true if and only this vertex is marked

setInProcess

void setInProcess(boolean inProcess)

Sets this vertex process flag to the specified value. The flag is designed to be utilized as a temporary and dynamic attribute for algorithms.

Parameters:

inProcess - flag which marks this vertex