org.apache.giraph.edge

Class HashMultimapEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable<I,org.apache.hadoop.io.Writable,E>

org.apache.giraph.edge.ConfigurableOutEdges<I,E>

org.apache.giraph.edge.HashMultimapEdges<I,E>

Type Parameters:

I - Vertex id

E - Edge value

All Implemented Interfaces:

Iterable<Edge<I,E>>, GiraphConfigurationSettable<I,org.apache.hadoop.io.Writable,E>, ImmutableClassesGiraphConfigurable<I,org.apache.hadoop.io.Writable,E>, MultiRandomAccessOutEdges<I,E>, OutEdges<I,E>, Trimmable, org.apache.hadoop.io.Writable

public class HashMultimapEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>
extends ConfigurableOutEdges<I,E>
implements MultiRandomAccessOutEdges<I,E>, Trimmable

OutEdges implementation backed by an ArrayListMultimap. Parallel edges are allowed. Note: this implementation is optimized for fast mutations, but uses more space.

Constructor Summary

Constructors

Constructor and Description
HashMultimapEdges()

Method Summary

Modifier and Type	Method and Description
void	add(Edge<I,E> edge) Add an edge.
Iterable<E>	getAllEdgeValues(I targetVertexId) Return an iterable over the edge values for a given target vertex id.
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(int expectedNeighbors, int expectedEdgesPerNeighbor) Additional initialization method tailored to the underlying multimap implementation.
void	initialize(Iterable<Edge<I,E>> edges) Initialize the data structure and set the edges from an iterable.
Iterator<Edge<I,E>>	iterator()
void	readFields(DataInput in)
void	remove(I targetVertexId) Remove all edges to the given target vertex.
int	size() Return the number of edges.
void	trim() Compacts all recent updates to this object.
void	write(DataOutput out)

Methods inherited from class org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HashMultimapEdges

public HashMultimapEdges()

Method Detail

initialize

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

Description copied from interface: OutEdges

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.

Specified by:

initialize in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Parameters:

edges - Iterable of edges

initialize

public void initialize(int expectedNeighbors,
                       int expectedEdgesPerNeighbor)

Additional initialization method tailored to the underlying multimap implementation.

Parameters:

expectedNeighbors - Expected number of unique neighbors

expectedEdgesPerNeighbor - Expected number of edges per neighbor

initialize

public void initialize(int capacity)

Description copied from interface: OutEdges

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.

Specified by:

initialize in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Parameters:

capacity - Initial capacity

initialize

public void initialize()

Description copied from interface: OutEdges

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.

Specified by:

initialize in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

add

public void add(Edge<I,E> edge)

Description copied from interface: OutEdges

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

Specified by:

add in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Parameters:

edge - Edge to add

remove

public void remove(I targetVertexId)

Description copied from interface: OutEdges

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

Specified by:

remove in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Parameters:

targetVertexId - Target vertex id

getAllEdgeValues

public Iterable<E> getAllEdgeValues(I targetVertexId)

Description copied from interface: MultiRandomAccessOutEdges

Return an iterable over the edge values for a given target vertex id.

Specified by:

getAllEdgeValues in interface MultiRandomAccessOutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Parameters:

targetVertexId - Target vertex id

Returns:

Iterable of edge values

size

public int size()

Description copied from interface: OutEdges

Return the number of edges.

Specified by:

size in interface OutEdges<I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable>

Returns:

Number of edges

iterator

public Iterator<Edge<I,E>> iterator()

Specified by:

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

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

trim

public void trim()

Description copied from interface: Trimmable

Compacts all recent updates to this object.

Specified by:

trim in interface Trimmable