Package com.gengoai.graph

Class DefaultGraphImpl<V>

java.lang.Object

com.gengoai.graph.DefaultGraphImpl<V>

All Implemented Interfaces:

Graph<V>, Serializable, Iterable<V>

public class DefaultGraphImpl<V>
extends Object
implements Graph<V>, Serializable

Default graph implementation that uses a Table to store edges and keeps track of the vertices in a Set. By default a LinkedHashSet is used so that the order of the vertices is the same as when added.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultGraphImpl(EdgeFactory<V> edgeFactory)	Instantiates a new Adjacency matrix.

Method Summary

Modifier and Type	Method	Description
void	addEdge(Edge<V> edge)	Adds an edge to the graph.
Edge<V>	addEdge(V fromVertex, V toVertex)	Adds an edge to the graph
Edge<V>	addEdge(V fromVertex, V toVertex, double weight)	Adds an edge to the graph
boolean	addVertex(V vertex)	Adds a vertex to the graph
void	addVertices(Collection<V> vertices)	Adds all vertices in a collection to the graph
boolean	containsEdge(V fromVertex, V toVertex)	Checks if an edge in the graph
boolean	containsVertex(V vertex)	Checks if a vertex in the graph
int	degree(V vertex)	The number of neighbors
Set<? extends Edge<V>>	edges()	Edges set.
boolean	equals(Object o)
Edge<V>	getEdge(V v1, V v2)	Gets the edge if one, between the two given vertices
EdgeFactory<V>	getEdgeFactory()	Gets the edge factory used in this grapy
Set<? extends Edge<V>>	getInEdges(V vertex)	Gets the edges coming in to the given vertex (i.e.
Set<? extends Edge<V>>	getOutEdges(V vertex)	Gets the edges coming out out of the given vertex (i.e.
Set<V>	getPredecessors(V vertex)	Gets the neighbors associated with the incoming edges for the given vertex.
Set<V>	getSuccessors(V vertex)	Gets the neighbors associated with the outgoing edges for the given vertex.
int	hashCode()
int	inDegree(V vertex)	The number of predecessors
boolean	isDirected()	Is directed.
boolean	isEmpty()	Determines if the graph is empty (no vertices no edges)
Iterator<V>	iterator()
int	numberOfEdges()	Number of edges.
int	numberOfVertices()	Number of vertices.
int	outDegree(V vertex)	The number of successors
boolean	removeEdge(Edge<V> edge)	Removes an edge from the graph
Edge<V>	removeEdge(V fromVertex, V toVertex)	Removes an edge from the graph
boolean	removeVertex(V vertex)	Removes a vertex from the graph
String	toString()
Set<V>	vertices()	Vertices set.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gengoai.graph.Graph

addEdges, containsEdge, getEdges, getNeighbors, getPredecessorsWeights, getSuccessorWeights, getWeight, getWeights, merge, merge, parallelstream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultGraphImpl

public DefaultGraphImpl(EdgeFactory<V> edgeFactory)

Instantiates a new Adjacency matrix.

Parameters:

edgeFactory - the edge factory

Method Detail

addEdge

public Edge<V> addEdge(V fromVertex,
                       V toVertex)

Description copied from interface: Graph

Adds an edge to the graph

Specified by:

addEdge in interface Graph<V>

Parameters:

fromVertex - The first (from) vertex

toVertex - The second (to) vertex

Returns:

The edge that was created

addEdge

public Edge<V> addEdge(V fromVertex,
                       V toVertex,
                       double weight)

Description copied from interface: Graph

Adds an edge to the graph

Specified by:

addEdge in interface Graph<V>

Parameters:

fromVertex - The first (from) vertex

toVertex - The second (to) vertex

weight - The weight of the edge

Returns:

The edge that was created

addEdge

public void addEdge(Edge<V> edge)

Description copied from interface: Graph

Adds an edge to the graph.

Specified by:

addEdge in interface Graph<V>

Parameters:

edge - the edge

addVertex

public boolean addVertex(V vertex)

Description copied from interface: Graph

Adds a vertex to the graph

Specified by:

addVertex in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

True if the vertex was added, False if not

addVertices

public void addVertices(Collection<V> vertices)

Description copied from interface: Graph

Adds all vertices in a collection to the graph

Specified by:

addVertices in interface Graph<V>

Parameters:

vertices - The vertices to add

containsEdge

public boolean containsEdge(V fromVertex,
                            V toVertex)

Description copied from interface: Graph

Checks if an edge in the graph

Specified by:

containsEdge in interface Graph<V>

Parameters:

fromVertex - The first (from) vertex

toVertex - The second (to) vertex

Returns:

True if the edge is in the graph, false if not

containsVertex

public boolean containsVertex(V vertex)

Description copied from interface: Graph

Checks if a vertex in the graph

Specified by:

containsVertex in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

True if the vertex is in the graph, false if not

degree

public int degree(V vertex)

Description copied from interface: Graph

The number of neighbors

Specified by:

degree in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The degree

edges

public Set<? extends Edge<V>> edges()

Description copied from interface: Graph

Edges set.

Specified by:

edges in interface Graph<V>

Returns:

The set of edges in the graph

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getEdge

public Edge<V> getEdge(V v1,
                       V v2)

Description copied from interface: Graph

Gets the edge if one, between the two given vertices

Specified by:

getEdge in interface Graph<V>

Parameters:

v1 - vertex 1

v2 - vertex 2

Returns:

The edge if one, null otherwise

getEdgeFactory

public EdgeFactory<V> getEdgeFactory()

Description copied from interface: Graph

Gets the edge factory used in this grapy

Specified by:

getEdgeFactory in interface Graph<V>

Returns:

The edge factory

getInEdges

public Set<? extends Edge<V>> getInEdges(V vertex)

Description copied from interface: Graph

Gets the edges coming in to the given vertex (i.e. in-links)

Specified by:

getInEdges in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The set of incoming edges

getOutEdges

public Set<? extends Edge<V>> getOutEdges(V vertex)

Description copied from interface: Graph

Gets the edges coming out out of the given vertex (i.e. out-links)

Specified by:

getOutEdges in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The set of outgoing edges

getPredecessors

public Set<V> getPredecessors(V vertex)

Description copied from interface: Graph

Gets the neighbors associated with the incoming edges for the given vertex.

Specified by:

getPredecessors in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The set of vertices which contain an outgoing edge to the given vertex.

getSuccessors

public Set<V> getSuccessors(V vertex)

Description copied from interface: Graph

Gets the neighbors associated with the outgoing edges for the given vertex.

Specified by:

getSuccessors in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The set of vertices which contain an incoming edge from the given vertex.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

inDegree

public int inDegree(V vertex)

Description copied from interface: Graph

The number of predecessors

Specified by:

inDegree in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The in degree

isDirected

public boolean isDirected()

Description copied from interface: Graph

Is directed.

Specified by:

isDirected in interface Graph<V>

Returns:

True if the graph is directed, false if it is undirected

isEmpty

public boolean isEmpty()

Description copied from interface: Graph

Determines if the graph is empty (no vertices no edges)

Specified by:

isEmpty in interface Graph<V>

Returns:

True if the graph is empty

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

numberOfEdges

public int numberOfEdges()

Description copied from interface: Graph

Number of edges.

Specified by:

numberOfEdges in interface Graph<V>

Returns:

Number of edges in the graph

numberOfVertices

public int numberOfVertices()

Description copied from interface: Graph

Number of vertices.

Specified by:

numberOfVertices in interface Graph<V>

Returns:

Number of vertices in the graph

outDegree

public int outDegree(V vertex)

Description copied from interface: Graph

The number of successors

Specified by:

outDegree in interface Graph<V>

Parameters:

vertex - The vertex

Returns:

The out degree

removeEdge

public Edge<V> removeEdge(V fromVertex,
                          V toVertex)

Description copied from interface: Graph

Removes an edge from the graph

Specified by:

removeEdge in interface Graph<V>

Parameters:

fromVertex - The first (from) vertex

toVertex - The second (to) vertex

Returns:

The edge that was removed or null if there was no edge

removeEdge

public boolean removeEdge(Edge<V> edge)

Description copied from interface: Graph

Removes an edge from the graph

Specified by:

removeEdge in interface Graph<V>

Parameters:

edge - The edge to remove

Returns:

True if the edge was removed, false if not

removeVertex

public boolean removeVertex(V vertex)

Description copied from interface: Graph

Removes a vertex from the graph

Specified by:

removeVertex in interface Graph<V>

Parameters:

vertex - The vertex to remove

Returns:

True if the vertex was removed, false if not

toString

public String toString()

Overrides:

toString in class Object

vertices

public Set<V> vertices()

Description copied from interface: Graph

Vertices set.

Specified by:

vertices in interface Graph<V>

Returns:

The set of vertices in the graph