org.apache.hama.graph

Interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Type Parameters:

V - this type must be writable and should also implement equals and hashcode.

E - the type used for storing edge values, usually the value of an edge.

M - the type used for messaging, usually the value of a vertex.

All Known Implementing Classes:

Vertex

public interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

The vertex interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	compute(Iterator<M> messages) The user-defined function
List<Edge<V,E>>	getEdges()
long	getNumVertices()
long	getSuperstepCount()
M	getValue() Gets the vertex value
V	getVertexID()
void	sendMessage(Edge<V,E> e, M msg) Sends a message to another vertex.
void	sendMessage(V destinationVertexID, M msg) Sends a message to the given destination vertex by ID and the message value
void	sendMessageToNeighbors(M msg) Sends a message to neighbors
void	setup(org.apache.hadoop.conf.Configuration conf) Used to setup a vertex.
void	setValue(M value) Sets the vertex value
void	voteToHalt() Vote to halt.

Method Detail

setup

void setup(org.apache.hadoop.conf.Configuration conf)

Used to setup a vertex.

getVertexID

V getVertexID()

Returns:

the unique identification for the vertex.

getNumVertices

long getNumVertices()

Returns:

the number of vertices in the input graph.

compute

void compute(Iterator<M> messages)
             throws IOException

The user-defined function

Throws:

IOException

getEdges

List<Edge<V,E>> getEdges()

Returns:

a list of outgoing edges of this vertex in the input graph.

sendMessage

void sendMessage(Edge<V,E> e,
               M msg)
                 throws IOException

Sends a message to another vertex.

Throws:

IOException

sendMessageToNeighbors

void sendMessageToNeighbors(M msg)
                            throws IOException

Sends a message to neighbors

Throws:

IOException

sendMessage

void sendMessage(V destinationVertexID,
               M msg)
                 throws IOException

Sends a message to the given destination vertex by ID and the message value

Throws:

IOException

getSuperstepCount

long getSuperstepCount()

Returns:

the superstep number of the current superstep (starting from 0).

voteToHalt

void voteToHalt()

Vote to halt.

setValue

void setValue(M value)

Sets the vertex value

getValue

M getValue()

Gets the vertex value