ch.awae.utils.pathfinding

Interface Vertex<T extends Vertex<T>>

Type Parameters:

T - the edge type

public interface Vertex<T extends Vertex<T>>

Base interface for pathfinding graph vertices

Since:

awaeUtils 1.0.0

Author:

Andreas Wälchli

Field Summary

Fields

Modifier and Type	Field and Description
static double[]	EMPTY_SPATIAL_ARRAY An empty double array used as the default 0-dimensional spatial coordinates for any vertex.

Method Summary

Modifier and Type	Method and Description
double	getDistance(T neighbour) returns the distance to the given neighbour
java.util.List<T>	getNeighbours() returns a list of all neighbours of the vertex
default double[]	getSpatialPosition() provides spatial information about a vertex if applicable.

Field Detail

EMPTY_SPATIAL_ARRAY

static final double[] EMPTY_SPATIAL_ARRAY

An empty double array used as the default 0-dimensional spatial coordinates for any vertex.

Method Detail

getNeighbours

java.util.List<T> getNeighbours()

returns a list of all neighbours of the vertex

Returns:

the complete vertex list

getDistance

double getDistance(T neighbour)

returns the distance to the given neighbour

Parameters:

neighbour - the neighbour to get the distance for

Returns:

the distance

Throws:

java.lang.IllegalArgumentException - if the given neighbour is no neighbour of the vertex

getSpatialPosition

default double[] getSpatialPosition()

provides spatial information about a vertex if applicable. This information can be used by heuristics-based path finders (e.g. A*). The spatial information can be of arbitrary dimensionality (even 0-dimensional). It is recommended to use a fixed number of dimensions for any implementation.

Returns:

a potentially empty array containing n-dimensional spatial coordinates of the vertex.

Since:

awaeUtils 1.0.2