Query functions

Functions
int	CAtlas::FindShortestPaths (int startID)
int	CAtlas::FindAllPairsShortestPaths ()
int	CAtlas::AStar (int startID, int goalID, AT_AstarHeuristicCallbackType ASHCB, int *size, void *userDef=NULL)
int	CAtlas::GetAStarQueryVertex (int nr, int *vID)
int	CAtlas::Query (int goalID, int *size, AT_scalar *length=NULL)
int	CAtlas::Query (int startID, int goalID, int *size, AT_scalar *length=NULL)
int	CAtlas::GetQueryVertex (int nr, int *vID)

---

Function Documentation

int CAtlas::FindShortestPaths (  int  startID  )  [inherited]

This function calculates a single source shortest path. Parameters: startID  The ID of the vertex from which to calculate the shortest paths. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::FindAllPairsShortestPaths (   )  [inherited]

This function calculates an all pairs shortest path. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::AStar (  int  startID, int  goalID, AT_AstarHeuristicCallbackType  ASHCB, int *  size, void *  userDef = NULL )  [inherited]

Perform an A* search between a start and goal vertex. Parameters: startID  The ID of the start vertex. goalID  The ID of the goal vertex. ASHCB  Heuristic to estimate the distance between two vertices. size  Return value for the number of vertices in the query path. userDef  A user defined pointer that is send to the callback function. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetAStarQueryVertex (  int  nr, int *  vID )  [inherited]

Retrieve a vertex in the A* query. Parameters: nr  The number of the query vertex. The total numer is returned by the Query function. vID  Return value for the ID of the vertex in the query. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::Query (  int  goalID, int *  size, AT_scalar *  length = NULL )  [inherited]

Query for a shortest path. First use FindShortestPaths! Parameters: goalID  The ID of the goal vertex. size  Return value for the number of vertices in the query path. length  Return value that holds the length of the path. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::Query (  int  startID, int  goalID, int *  size, AT_scalar *  length = NULL )  [inherited]

Query for a shortest path, created by all pairs shortest path. First use FindAllPairsShortestPahts! Parameters: startID  The ID of the start vertex. goalID  The ID of the goal vertex. size  Return value for the number of vertices in the query path. length  Return value that holds the length of the path. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetQueryVertex (  int  nr, int *  vID )  [inherited]

Retrieve a vertex in the query. Parameters: nr  The number of the query vertex. The total numer is returned by the Query function. vID  Return value for the ID of the vertex in the query. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

---