fern.analysis

Class ShortestPath

java.lang.Object

fern.analysis.AnalysisBase

fern.analysis.ShortestPath

public class ShortestPath
extends AnalysisBase

Computes shortest paths in the network by a bfs. Either the path from some source species to only one species can be calculated (by using one of the computePath methods) or paths to all species (by computePaths). A NodeChecker can optionally be given for each method.

Author:

Florian Erhard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ShortestPath.Path Encapsulates a path from one species to another.

Constructor Summary

Constructors

Constructor and Description
ShortestPath(Network network) Creates the class with the specified network.

Method Summary

Modifier and Type	Method and Description
ShortestPath.Path	computePath(NodeChecker checker, String toSpecies, String... species) Compute the shortest paths from some source species to one species by only using parts of the network specified by the NodeChecker checker.
ShortestPath.Path	computePath(String toSpecies, String... species) Compute the shortest paths from some source species to one species.
ShortestPath.Path[]	computePaths(NodeChecker checker, String... species) Compute all shortest paths from some source species by only using parts of the network specified by the NodeChecker checker.
ShortestPath.Path[]	computePaths(String... species) Compute all shortest paths from some source species.

Methods inherited from class fern.analysis.AnalysisBase

bfs, dfs, search

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortestPath

public ShortestPath(Network network)

Creates the class with the specified network.

Parameters:

network - the network where shortest paths shall be computed

Method Detail

computePaths

public ShortestPath.Path[] computePaths(String... species)

Compute all shortest paths from some source species.

Parameters:

species - the names of the source species

Returns:

an array of paths

See Also:

ShortestPath.Path

computePaths

public ShortestPath.Path[] computePaths(NodeChecker checker,
                                        String... species)

Compute all shortest paths from some source species by only using parts of the network specified by the NodeChecker checker.

Parameters:

species - the names of the source species

checker - a NodeChecker for the search

Returns:

an array of paths

See Also:

ShortestPath.Path

computePath

public ShortestPath.Path computePath(String toSpecies,
                                     String... species)

Compute the shortest paths from some source species to one species.

Parameters:

toSpecies - the name of the species where the shortest path should be computed to

species - the names of the source species

Returns:

the shortest path

See Also:

ShortestPath.Path

computePath

public ShortestPath.Path computePath(NodeChecker checker,
                                     String toSpecies,
                                     String... species)

Compute the shortest paths from some source species to one species by only using parts of the network specified by the NodeChecker checker.

Parameters:

checker - a NodeChecker for the search

toSpecies - the name of the species where the shortest path should be computed to

species - the names of the source species

Returns:

the shortest path

See Also:

ShortestPath.Path