org.apache.giraph.edge

Interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Type Parameters:

I - Vertex id

E - Edge value

All Superinterfaces:

Iterable<Edge<I,E>>, org.apache.hadoop.io.Writable

All Known Subinterfaces:

MultiRandomAccessOutEdges<I,E>, MutableOutEdges<I,E>, ReuseObjectsOutEdges<I,E>, StrictRandomAccessOutEdges<I,E>

All Known Implementing Classes:

ArrayListEdges, ByteArrayEdges, ConfigurableOutEdges, HashMapEdges, HashMultimapEdges, IdAndNullArrayEdges, IdAndValueArrayEdges, IntNullArrayEdges, LongByteHashMapEdges, LongDiffNullArrayEdges, LongDoubleArrayEdges, LongDoubleHashMapEdges, LongNullArrayEdges, LongNullHashSetEdges, MutableEdgesWrapper

public interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>
extends Iterable<Edge<I,E>>, org.apache.hadoop.io.Writable

Interface for data structures that store out-edges for a vertex.

Method Summary

Modifier and Type	Method and Description
void	add(Edge<I,E> edge) Add an edge.
void	initialize() Initialize the data structure with the default initial capacity.
void	initialize(int capacity) Initialize the data structure with the specified initial capacity.
void	initialize(Iterable<Edge<I,E>> edges) Initialize the data structure and set the edges from an iterable.
void	remove(I targetVertexId) Remove all edges to the given target vertex.
int	size() Return the number of edges.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Method Detail

initialize

void initialize(Iterable<Edge<I,E>> edges)

Initialize the data structure and set the edges from an iterable. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called. Note: whether parallel edges are allowed or not depends on the implementation.

Parameters:

edges - Iterable of edges

initialize

void initialize(int capacity)

Initialize the data structure with the specified initial capacity. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called.

Parameters:

capacity - Initial capacity

initialize

void initialize()

Initialize the data structure with the default initial capacity. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called.

add

void add(Edge<I,E> edge)

Add an edge. Note: whether parallel edges are allowed or not depends on the implementation.

Parameters:

edge - Edge to add

remove

void remove(I targetVertexId)

Remove all edges to the given target vertex. Note: the implementation will vary depending on whether parallel edges are allowed or not.

Parameters:

targetVertexId - Target vertex id

size

int size()

Return the number of edges.

Returns:

Number of edges