Package org.goplanit.algorithms.shortest

Interface ShortestBushResult

All Superinterfaces:

ShortestResult

All Known Implementing Classes:

ShortestBushResultGeneralised

public interface ShortestBushResult
extends ShortestResult

Interfaces that defines how to access results of a shortest bush execution allowing one to extract bushes or cost information

Author:

markr

Method Summary

Modifier and Type	Method	Description
ACyclicSubGraph	createDirectedAcyclicSubGraph(IdGroupingToken idToken, DirectedVertex origin, DirectedVertex destination)	Create a bush in the form of a directed acyclic subgraph of its parent network (layer) for a given origin-destination vertex.
List<EdgeSegment>	getNextEdgeSegmentsForVertex(Vertex vertex)	Find the next edge segment for a given vertex, depending on the underlying search this can be either in upstream or downstream direction

Methods inherited from interface org.goplanit.algorithms.shortest.ShortestResult

getCostOf, getNextVertexForEdgeSegment, getSearchType, isInverted

Method Detail

createDirectedAcyclicSubGraph

ACyclicSubGraph createDirectedAcyclicSubGraph(IdGroupingToken idToken,
                                              DirectedVertex origin,
                                              DirectedVertex destination)

Create a bush in the form of a directed acyclic subgraph of its parent network (layer) for a given origin-destination vertex. The direction of the result is inherited from the search itself, so if the search was inverted, the dag has an inverted root etc.

Parameters:

idToken - to use for the Acyclic subgraph's id generation

origin - to use

destination - to use

Returns:

created acyclic graph

getNextEdgeSegmentsForVertex

List<EdgeSegment> getNextEdgeSegmentsForVertex(Vertex vertex)

Find the next edge segment for a given vertex, depending on the underlying search this can be either in upstream or downstream direction

Parameters:

vertex - to get next segment for

Returns:

next edge segment