berack96.lib.graph.visit.impl

Class VisitInfo<V>

java.lang.Object

berack96.lib.graph.visit.impl.VisitInfo<V>

Type Parameters:

V - the vertex of the visit

public class VisitInfo<V>
extends java.lang.Object

The class used for getting the info of the visit.
It could be used with the algorithm of the visit for set some useful data.

Author:

Berack96

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VisitInfo.VertexInfo Class used mainly for storing the data of the visit

Constructor Summary

Constructors

Constructor and Description
VisitInfo(V source) Need a source for initialize the basic values

Method Summary

Modifier and Type	Method and Description
void	forEach(java.util.function.Consumer<VisitInfo.VertexInfo> consumer) Iterate through all the vertices discovered and visited with the correct timeline. The vertices will be visited in the order that they are discovered and visited, so a vertex can appear two times (one for the discovery, anc the other for the visit)
void	forEachDiscovered(java.util.function.Consumer<VisitInfo.VertexInfo> consumer) Iterate through all the vertices that are discovered. The vertices will be ordered by the time of their discover.
void	forEachVisited(java.util.function.Consumer<VisitInfo.VertexInfo> consumer) Iterate through all the vertices that are visited. The vertices will be ordered by the time of their visit.
java.util.Set<V>	getDiscovered() Get all the discovered vertices so far.
V	getParentOf(V vertex) Get the parent of a particular vertex. The parent of a vertex is the one that has discovered it If the vertex has no parent (it has not been set by the visit algorithm or it's the source) then null is returned.
V	getSource() Get the source of the visit.
long	getTimeDiscover(V vertex) The time of the vertex when it is discovered in the visit. For "discovered" i mean when the node is first found by the visit algorithm.
long	getTimeVisit(V vertex) The time when the vertex is visited by the algorithm For "visited" i mean when the node is finally visited by the visit algorithm.
java.util.Set<V>	getVisited() Get all the visited vertices so far.
boolean	isDiscovered(V vertex) Tells if a vertex is discovered or not
boolean	isVisited(V vertex) Tells if the vertex is visited or not

Methods inherited from class java.lang.Object

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

Constructor Detail

VisitInfo

public VisitInfo(V source)

Need a source for initialize the basic values

Parameters:

source - the source of the visit

Throws:

java.lang.NullPointerException - if the source is null

Method Detail

getTimeDiscover

public long getTimeDiscover(V vertex)
                     throws java.lang.IllegalArgumentException,
                            java.lang.NullPointerException

The time of the vertex when it is discovered in the visit.
For "discovered" i mean when the node is first found by the visit algorithm. It may depends form VisitStrategy
The time starts at 0 and for each vertex discovered it is increased by one. If a vertex is visited it also increase the time

Parameters:

vertex - the vertex needed

Returns:

the time of it's discovery

Throws:

java.lang.IllegalArgumentException - if the vertex is not discovered

java.lang.NullPointerException - if the vertex is null

getTimeVisit

public long getTimeVisit(V vertex)
                  throws java.lang.IllegalArgumentException,
                         java.lang.NullPointerException

The time when the vertex is visited by the algorithm
For "visited" i mean when the node is finally visited by the visit algorithm. It may depends form VisitStrategy
The time starts at 0 and for each vertex discovered or visited is increased by one

Parameters:

vertex - the vertex needed

Returns:

the time of it's visit

Throws:

java.lang.IllegalArgumentException - if the vertex is not visited

java.lang.NullPointerException - if the vertex is null

isDiscovered

public boolean isDiscovered(V vertex)
                     throws java.lang.NullPointerException

Tells if a vertex is discovered or not

Parameters:

vertex - the vertex chosen

Returns:

true if is discovered

Throws:

java.lang.NullPointerException

isVisited

public boolean isVisited(V vertex)
                  throws java.lang.NullPointerException

Tells if the vertex is visited or not

Parameters:

vertex - the vertex chosen

Returns:

true if is visited

Throws:

java.lang.NullPointerException

getSource

public V getSource()

Get the source of the visit.

Returns:

the source vertex where it's started the visit

getParentOf

public V getParentOf(V vertex)
              throws java.lang.IllegalArgumentException

Get the parent of a particular vertex.
The parent of a vertex is the one that has discovered it
If the vertex has no parent (it has not been set by the visit algorithm or it's the source) then null is returned.

Parameters:

vertex - the child vertex

Returns:

the parent of the child

Throws:

java.lang.IllegalArgumentException - if the vertex has not been discovered yet

getVisited

public java.util.Set<V> getVisited()

Get all the visited vertices so far.

Returns:

the visited vertices

getDiscovered

public java.util.Set<V> getDiscovered()

Get all the discovered vertices so far.

Returns:

the discovered vertices

forEachDiscovered

public void forEachDiscovered(java.util.function.Consumer<VisitInfo.VertexInfo> consumer)

Iterate through all the vertices that are discovered.
The vertices will be ordered by the time of their discover.

Parameters:

consumer - the function to apply to each

forEachVisited

public void forEachVisited(java.util.function.Consumer<VisitInfo.VertexInfo> consumer)

Iterate through all the vertices that are visited.
The vertices will be ordered by the time of their visit.

Parameters:

consumer - the function to apply to each

forEach

public void forEach(java.util.function.Consumer<VisitInfo.VertexInfo> consumer)

Iterate through all the vertices discovered and visited with the correct timeline.
The vertices will be visited in the order that they are discovered and visited, so a vertex can appear two times (one for the discovery, anc the other for the visit)

Parameters:

consumer - the function to apply at each vertex