berack96.lib.graph.visit.impl

Class Dijkstra<V,W extends java.lang.Number>

java.lang.Object

berack96.lib.graph.visit.impl.Dijkstra<V,W>

Type Parameters:

V - vertex

W - weight

All Implemented Interfaces:

VisitDistance<V,W>, VisitStrategy<V,W>

public class Dijkstra<V,W extends java.lang.Number>
extends java.lang.Object
implements VisitDistance<V,W>

Class that implements the Dijkstra algorithm and uses it for getting all the distance from a source

Author:

Berack96

Constructor Summary

Constructors

Constructor and Description
Dijkstra()

Method Summary

Modifier and Type	Method and Description
java.util.Map<V,java.util.List<Edge<V,W>>>	getLastDistance() Get the last calculated distance to all the possible destinations The map contains all the possible vertices that are reachable from the source set in the visit If there is no path between the destination and the source, then null is returned as accordingly to the map interface If the visit is not already been done, then the map is null.
V	getLastSource() Get the last source vertex of the visit for calculating the destinations. Returns null if the visit is not already been done
VisitInfo<V>	visit(Graph<V,W> graph, V source, java.util.function.Consumer<V> visit) With this the graph will be visited accordingly to the strategy of the visit. Some strategy can accept a source vertex null, because they visit all the graph anyway. If you want to stop the visit of the graph, you just have to throw any exception in the visit function, but be sure to catch it

Methods inherited from class java.lang.Object

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

Constructor Detail

Dijkstra

public Dijkstra()

Method Detail

getLastDistance

public java.util.Map<V,java.util.List<Edge<V,W>>> getLastDistance()

Description copied from interface: VisitDistance

Get the last calculated distance to all the possible destinations
The map contains all the possible vertices that are reachable from the source set in the visit
If there is no path between the destination and the source, then null is returned as accordingly to the map interface
If the visit is not already been done, then the map is null.

Specified by:

getLastDistance in interface VisitDistance<V,W extends java.lang.Number>

Returns:

the last distance

getLastSource

public V getLastSource()

Description copied from interface: VisitDistance

Get the last source vertex of the visit for calculating the destinations.
Returns null if the visit is not already been done

Specified by:

getLastSource in interface VisitDistance<V,W extends java.lang.Number>

Returns:

the last vertex

visit

public VisitInfo<V> visit(Graph<V,W> graph,
                          V source,
                          java.util.function.Consumer<V> visit)
                   throws java.lang.NullPointerException,
                          java.lang.IllegalArgumentException

Description copied from interface: VisitStrategy

With this the graph will be visited accordingly to the strategy of the visit.
Some strategy can accept a source vertex null, because they visit all the graph anyway.
If you want to stop the visit of the graph, you just have to throw any exception in the visit function, but be sure to catch it

Specified by:

visit in interface VisitStrategy<V,W extends java.lang.Number>

Parameters:

graph - the graph to visit

source - the source of the visit

visit - the function to apply at each vertex when they are visited

Returns:

an info of the view

Throws:

java.lang.NullPointerException - if one of the arguments is null (only the consumers can be null)

java.lang.IllegalArgumentException - if the source vertex is not in the graph