Vertex functions

Functions
int	CAtlas::AddVertex (AT_scalar *conf, int *vID, void *userDef=NULL)
int	CAtlas::RemoveVertex (int vID)
int	CAtlas::GetVertexConfiguration (int vID, AT_scalar *conf, void **userDef=NULL)
int	CAtlas::GetNrVertices (int *nr)
int	CAtlas::GetVertices (int *vIDs)
int	CAtlas::SetUserDef (int vID, void *userDef)
int	CAtlas::GetNrPredecessors (int vID, int *nr)
int	CAtlas::GetNrSuccessors (int vID, int *nr)
int	CAtlas::GetSuccessor (int vID, int nr, int *nID)
int	CAtlas::GetPredecessor (int vID, int nr, int *nID)
int	CAtlas::GetPredecessors (int vID, int *ids)
int	CAtlas::GetSuccessors (int vID, int *ids)
int	CAtlas::VerticesConnected (int vID0, int vID1, bool *connected)

---

Function Documentation

int CAtlas::AddVertex (  AT_scalar *  conf, int *  vID, void *  userDef = NULL )  [inherited]

This function adds a vertex to the graph. Parameters: conf  A list of length dimension containing the values of the vertex. vID  A return value contaning the ID of the vertex. userDef  An optional pointer to store user defined data with the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::RemoveVertex (  int  vID  )  [inherited]

This function removes a vertex from the graph. Parameters: vID  The ID of the vertex to remove. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetVertexConfiguration (  int  vID, AT_scalar *  conf, void **  userDef = NULL )  [inherited]

Use this function to retrieve information from the vertex. Parameters: vID  The ID of the vertex. conf  Return value: the list of vertex values, must be of the proper size, can be NULL if you are only interested in userDef. userDef  Return value: optional, the user defined pointer associated with the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetNrVertices (  int *  nr  )  [inherited]

This function retrieves the total number of vertices in the graph. Parameters: nr  The number of vertices. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetVertices (  int *  vIDs  )  [inherited]

This function retrieves the vertices in the graph. Parameters: vIDs  The list of vertices. This list needs to have the proper size. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::SetUserDef (  int  vID, void *  userDef )  [inherited]

This function enables the user to set the user defined pointer at a later moment. Parameters: vID  The ID of the vertex. userDef  The pointer to the user defined data. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

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

Revrieve the number of incoming edges of a vertex. Parameters: vID  The ID of the vertex. nr  The nr of connections to the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

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

Revrieve the number of outgoing edges of a vertex. Parameters: vID  The ID of the vertex. nr  The nr of connections from the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

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

Retrieve the ID of the nr'th successor. Parameters: vID  The ID of the vertex. nr  The index of the successor. nID  The ID of the successor. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

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

Retrieve the ID of the nr'th predecessor. Parameters: vID  The ID of the vertex. nr  The index of the predecessor nID  The ID of the predecessor. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetPredecessors (  int  vID, int *  ids )  [inherited]

Retrieve all predecessor ID's a vertex. Parameters: vID  The ID of the vertex. ids  The list of predecessor vertex ID's (needs to be the right size). Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetSuccessors (  int  vID, int *  ids )  [inherited]

Retrieve all successor ID's a vertex. Parameters: vID  The ID of the vertex. ids  The list of successor vertex ID's (needs to be the right size). Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::VerticesConnected (  int  vID0, int  vID1, bool *  connected )  [inherited]

Check whether two vertices are connected, either direct or via other vertices. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. connected  Return value whether the two vertices are connected. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

---