Misc functions

Functions
	CAtlas::CAtlas (int dimension, bool directed)
virtual	CAtlas::~CAtlas ()
int	CAtlas::GetDimension (int *dimension)
int	CAtlas::ResetGraph ()
int	CAtlas::LoadGraph (char *fileName)
int	CAtlas::SaveGraph (char *fileName)
int	CAtlas::CheckUsefulCycle (int startID, int goalID, AT_scalar K, AT_CalculateDistanceCallbackType calcDistCB, bool *result, void *userDef=NULL)

---

Function Documentation

CAtlas::CAtlas (  int  dimension, bool  directed )  [inherited]

This function creates an instance of Atlas. Parameters: dimension  The dimension of the vertices. directed  Set to TRUE if the graph is directed. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

virtual CAtlas::~CAtlas (   )  [virtual, inherited]

The destructor for the class.

int CAtlas::GetDimension (  int *  dimension  )  [inherited]

Retrieve the dimension of the vertices. Parameters: dimension  The dimension. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::ResetGraph (   )  [inherited]

Delete graph. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::LoadGraph (  char *  fileName  )  [inherited]

Loads a graph from disc. Parameters: fileName  Name of the file to load. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::SaveGraph (  char *  fileName  )  [inherited]

Saves a graph to disc. Parameters: fileName  Name of the file to save. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::CheckUsefulCycle (  int  startID, int  goalID, AT_scalar  K, AT_CalculateDistanceCallbackType  calcDistCB, bool *  result, void *  userDef = NULL )  [inherited]

Checks whether an edge that creates a cycle is "useful". Parameters: startID  The ID of the start vertex. goalID  The ID of the goal vertex. K  The K value to uses when determining the usefulness. calcDistCB  A user provided callback routine to calculate the discance between two vertices. result  True when the edge is useful. 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.

---