oracle.spatial.network.lod

Class EuclideanCostFunction

java.lang.Object

oracle.spatial.network.lod.EuclideanCostFunction

All Implemented Interfaces:

HeuristicCostFunction, XMLConfigurable

public class EuclideanCostFunction
extends java.lang.Object
implements HeuristicCostFunction, XMLConfigurable

This class implements the A* heuristic cost function as the 2D euclidean distance between the current node and the goal node.

Since:

11gR2

Constructor Summary

Constructors

Constructor and Description
EuclideanCostFunction(int userDataCategory, int xCoordUserDataIndex, int yCoordUserDataIndex, int geometryUserDataIndex) Creates a EuclideanCostFunction instance.

Method Summary

Modifier and Type	Method and Description
double	getHeuristicCost(double x1, double y1, double x2, double y2) The implementation of this abstract method should return the heuristic cost between point (x1, y1) and (x2, y2).
double	getHeuristicCost(HeavyPointOnNet currentPoint, HeavyPointOnNet goalPoint) Returns the heuristic cost between the current node and the goal node.
double	getHeuristicCost(HeavyPointOnNet currentPoint, LogicalNode goalNode) Returns the heuristic cost between the current node and the goal node.
double	getHeuristicCost(LogicalNode currentNode, HeavyPointOnNet goalPoint) Returns the heuristic cost between the current node and the goal node.
double	getHeuristicCost(LogicalNode currentNode, LogicalNode goalNode) Returns the heuristic cost between the current node and the goal node.
int[]	getUserDataCategories()
java.lang.String	getXMLSchema()
void	init(org.w3c.dom.Element parameter)

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.spatial.network.lod.HeuristicCostFunction

getHeuristicCost, getUserDataCategories

Methods inherited from interface oracle.spatial.network.lod.XMLConfigurable

getXMLSchema, init

Constructor Detail

EuclideanCostFunction

public EuclideanCostFunction(int userDataCategory,
                             int xCoordUserDataIndex,
                             int yCoordUserDataIndex,
                             int geometryUserDataIndex)

Creates a EuclideanCostFunction instance. The input parameters are interpreted as follows:
If neither xCoordUserDataName nor yCoordUserDataName is null, then the the heuristic cost is computed using the x and y coordinates stored as user data of the nodes;
Else if geometryUserDataName is not null, then the heuristic cost is computed using the JGeometry object stored as user data of the nodes.

Parameters:

userDataCategory - user data category

xCoordUserDataIndex - user data index registered for x coordinates of the nodes or points on link

yCoordUserDataIndex - user data index registered for y coordinates of the nodes or points on link

geometryUserDataIndex - user date index registered for geometries of the nodes or points on link

Method Detail

getHeuristicCost

public double getHeuristicCost(double x1,
                               double y1,
                               double x2,
                               double y2)

The implementation of this abstract method should return the heuristic cost between point (x1, y1) and (x2, y2).

Parameters:

x1 - x coordinate of the current point

y1 - y coordinate of the current point

x2 - x coordinate of the goal point

y2 - y coordinate of the goal point

Returns:

init

public void init(org.w3c.dom.Element parameter)

getXMLSchema

public java.lang.String getXMLSchema()

getHeuristicCost

public double getHeuristicCost(HeavyPointOnNet currentPoint,
                               HeavyPointOnNet goalPoint)

Returns the heuristic cost between the current node and the goal node.

Parameters:

currentPoint - current point

goalPoint - goal point

Returns:

getHeuristicCost

public double getHeuristicCost(LogicalNode currentNode,
                               LogicalNode goalNode)

Returns the heuristic cost between the current node and the goal node.

Parameters:

currentNode - current node

goalNode - goal node

Returns:

getHeuristicCost

public double getHeuristicCost(LogicalNode currentNode,
                               HeavyPointOnNet goalPoint)

Returns the heuristic cost between the current node and the goal node.

Parameters:

currentNode - current node

goalPoint - goal point

Returns:

getHeuristicCost

public double getHeuristicCost(HeavyPointOnNet currentPoint,
                               LogicalNode goalNode)

Returns the heuristic cost between the current node and the goal node.

Parameters:

currentPoint - current point

goalNode - goal node

Returns:

getUserDataCategories

public int[] getUserDataCategories()