Path

All Known Implementing Classes:

AbstractPath, ArrayListPath, ArrayPath, PathExtender, SearchResultWrappedPath, SingletonPath
```
public interface Path
```
A ion of path. A path is seen as a sequence of vertices. At this level, no implementation is defined.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`boolean`	`containsVertex(int someVertex)`
`void`	`extend(int v)`
`void`	`extend(int throughEdge, int v)`
`int`	`getDestination()` The last vertex in the path
`int`	`getEdgeHeadingToVertexAt(int i)`
`int`	`getLength()` Computes the length of this path.
`int`	`getNumberOfVertices()`
`int`	`getSource()` The first vertex in the path
`int`	`getVertexAt(int i)`
`it.unimi.dsi.fastutil.ints.IntSet`	`getVertexSet()` Deprecated.
`boolean`	`hasLoop()`
`int`	`indexOfVertex(int successor)`
`boolean`	`isApplicable(Grph g)` Checks whether this path is applicable to the given graph.
`boolean`	`isCycle()` Checks whether this path is a cycle or not.
`boolean`	`isElementary()`
`boolean`	`isHamiltonian(Grph g)` Checks whether this path is hamiltonian on the given graph.
`boolean`	`isShortestPath(Grph g, NumericalProperty weights)` Checks whether this path is a shortest path in the given graph.
`boolean`	`permitsSameTrip(Path anotherPath)` Checks whether the given path has the same source and destination has this path.
`void`	`reverse()`
`void`	`setColor(Grph g, int color)` Assigns the given color to all vertices in this path, when applied to the given graph.
`void`	`setSource(int v)`
`int[]`	`toVertexArray()` Computes the sequence of vertices as an array of ints.
`it.unimi.dsi.fastutil.ints.IntSet`	`toVertexSet()`
`java.lang.String`	`whyNotApplicable(Grph g)`

- Method Detail
  - getSource
```
int getSource()
```
    The first vertex in the path
    
    Returns:
    
    the first vertex in the path
  - setSource
```
void setSource(int v)
```
  - getDestination
```
int getDestination()
```
    The last vertex in the path
    
    Returns:
    
    the last vertex in the path
  - getNumberOfVertices
```
int getNumberOfVertices()
```
  - getVertexAt
```
int getVertexAt(int i)
```
  - indexOfVertex
```
int indexOfVertex(int successor)
```
  - containsVertex
```
boolean containsVertex(int someVertex)
```
  - getEdgeHeadingToVertexAt
```
int getEdgeHeadingToVertexAt(int i)
```
  - extend
```
void extend(int v)
```
  - extend
```
void extend(int throughEdge,
            int v)
```
  - getLength
```
int getLength()
```
    Computes the length of this path.
    
    Returns:
    
    the length of this path
  - isElementary
```
boolean isElementary()
```
  - permitsSameTrip
```
boolean permitsSameTrip(Path anotherPath)
```
    Checks whether the given path has the same source and destination has this path.
    
    Parameters:
    
    anotherPath -
    
    Returns:
    
    true the given path has the same source and destination has this path, false otherwise
  - isApplicable
```
boolean isApplicable(Grph g)
```
    Checks whether this path is applicable to the given graph. A path may not be applicable if the graph does not have some of the vertices or edges defined by this path.
    
    Parameters:
    
    g -
    
    Returns:
    
    true if this path is applicable to the given graph, false otherwise.
  - isShortestPath
```
boolean isShortestPath(Grph g,
                       NumericalProperty weights)
```
    Checks whether this path is a shortest path in the given graph.
    
    Parameters:
    
    g -
    
    Returns:
    
    true this path is a shortest path in the given graph, false otherwise.
  - setColor
```
void setColor(Grph g,
              int color)
```
    Assigns the given color to all vertices in this path, when applied to the given graph.
    
    Parameters:
    
    g -
    
    color -
  - isCycle
```
boolean isCycle()
```
    Checks whether this path is a cycle or not.
    
    Returns:
    
    true if this path is a cycle or not, false otherwise
  - isHamiltonian
```
boolean isHamiltonian(Grph g)
```
    Checks whether this path is hamiltonian on the given graph.
    
    Parameters:
    
    g - the graph
    
    Returns:
    
    true if this path is hamiltonian on the given graph, false otherwise
  - hasLoop
```
boolean hasLoop()
```
  - clone
```
java.lang.Object clone()
```
  - reverse
```
void reverse()
```
  - toVertexArray
```
int[] toVertexArray()
```
    Computes the sequence of vertices as an array of ints.
    
    Returns:
    
    the sequence of vertices as an array of ints
  - getVertexSet
```
@Deprecated
it.unimi.dsi.fastutil.ints.IntSet getVertexSet()
```
    Deprecated.
  - toVertexSet
```
it.unimi.dsi.fastutil.ints.IntSet toVertexSet()
```
  - whyNotApplicable
```
java.lang.String whyNotApplicable(Grph g)
```

Interface Path

Method Summary

Method Detail

getSource

setSource

getDestination

getNumberOfVertices

getVertexAt

indexOfVertex

containsVertex

getEdgeHeadingToVertexAt

extend

extend

getLength

isElementary

permitsSameTrip

isApplicable

isShortestPath

setColor

isCycle

isHamiltonian

hasLoop

clone

reverse

toVertexArray

getVertexSet

toVertexSet

whyNotApplicable