prg_graph_vertex_remove()
Abstract
Removes the vertex from the graph and deallocates it.
Syntax
prg_graph_vertex_remove (graph_ptr, vertex_ptr, dealloc_client_state)
| Argument | Type | Description |
|---|---|---|
graph_ptr |
PrgT_Graph * |
The graph that contains the vertex |
vertex_ptr |
PrgT_Graph_Vertex * |
The vertex that needs to be removed |
dealloc_client_state |
int |
Flag that governs whether the client state on the vertex will be deallocated |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if success, else PrgC_Compcode_Failure
Header
prg_graph.h
Details
Removes the vertex from the graph and deallocates it. Client state is also deallocated if dealloc_client_state is set. The edges connected to the vertex are also removed from the graph. There can be no floating edges in the graph.