graphlab
Interface Graph

All Known Implementing Classes:

DenseGraph, PythonGraph, SparseGraph

public interface Graph

Graph interface. GraphLab graphs are directional. Self-edges are not allowed.

Method Summary

void	addEdge(Edge e, int fromVertex, int toVertex) Add directed edge between two vertices.
Vertex	addVertex(Vertex vertex) Add a vertex to the graph.
int[]	children(int vertex)
void	finalizeGraph()
Edge	getEdge(int sourceVertexId, int targetVertexId) Get an edge object.
int	getNumOfVertices() Return the number of vertices in graph.
Vertex	getVertex(int vid) Returns a vertex id
Vertex[]	getVertices()
boolean	isColoringEnabled() Query whether graph is colored.
int[]	parents(int vertex)
void	setVertexColor(int vertex, int vertex_color) Set vertex color.

Method Detail

getVertices

Vertex[] getVertices()

Returns:

array of vertices

getVertex

Vertex getVertex(int vid)

Returns a vertex id

Parameters:

vid -

Returns:

addEdge

void addEdge(Edge e,
             int fromVertex,
             int toVertex)

Add directed edge between two vertices.

Parameters:

e - edge object encapsulating the edge data

fromVertex -

toVertex -

getEdge

Edge getEdge(int sourceVertexId,
             int targetVertexId)

Get an edge object.

Parameters:

sourceVertexId - vertex id of the origin vertex

targetVertexId - vertex id of the destination vertex

Returns:

edge-object corresponding to the edge or null.

addVertex

Vertex addVertex(Vertex vertex)

Add a vertex to the graph.

Parameters:

vertex - object containing vertex data

Returns:

vertex object of the new vertex

setVertexColor

void setVertexColor(int vertex,
                    int vertex_color)

Set vertex color.

Parameters:

vertex -

vertex_color -

children

int[] children(int vertex)

Parameters:

vertex - id of vertex

Returns:

array of outbound neighbors of a vertex

parents

int[] parents(int vertex)

Parameters:

vertex - id of vertex

Returns:

array of inbound neighbors of a vertex

isColoringEnabled

boolean isColoringEnabled()

Query whether graph is colored.

Returns:

true if vertices have color

getNumOfVertices

int getNumOfVertices()

Return the number of vertices in graph.

Returns:

finalizeGraph

void finalizeGraph()