org.apache.giraph.edge

Class LongNullHashSetEdges

java.lang.Object

org.apache.giraph.edge.LongNullHashSetEdges

All Implemented Interfaces:

Iterable<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>>, MutableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, OutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, ReuseObjectsOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, StrictRandomAccessOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, Trimmable, org.apache.hadoop.io.Writable

public class LongNullHashSetEdges
extends Object
implements ReuseObjectsOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, MutableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, StrictRandomAccessOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, Trimmable

OutEdges implementation with long ids and null edge values, backed by a LongOpenHashSet. Parallel edges are not allowed. Note: this implementation is optimized for fast random access and mutations, and uses less space than a generic HashMapEdges (but more than LongNullArrayEdges.

Constructor Summary

Constructors

Constructor and Description
LongNullHashSetEdges()

Method Summary

Modifier and Type	Method and Description
void	add(Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable> edge) Add an edge.
org.apache.hadoop.io.NullWritable	getEdgeValue(org.apache.hadoop.io.LongWritable targetVertexId) Return the edge value for the given target vertex id (or null if there is no edge pointing to it).
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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>> edges) Initialize the data structure and set the edges from an iterable.
Iterator<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>>	iterator()
Iterator<MutableEdge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>>	mutableIterator() Returns an iterator over edges that can be modified in-place, either by changing the current edge value or by removing the current edge.
void	readFields(DataInput in)
void	remove(org.apache.hadoop.io.LongWritable targetVertexId) Remove all edges to the given target vertex.
void	setEdgeValue(org.apache.hadoop.io.LongWritable targetVertexId, org.apache.hadoop.io.NullWritable edgeValue) Set the edge value for the given target vertex id (if an edge to that vertex exists).
int	size() Return the number of edges.
void	trim() Compacts all recent updates to this object.
void	write(DataOutput out)

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

LongNullHashSetEdges

public LongNullHashSetEdges()

Method Detail

initialize

public void initialize(Iterable<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>> 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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Parameters:

edges - Iterable of edges

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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

add

public void add(Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable> 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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Parameters:

edge - Edge to add

remove

public void remove(org.apache.hadoop.io.LongWritable 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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Parameters:

targetVertexId - Target vertex id

size

public int size()

Description copied from interface: OutEdges

Return the number of edges.

Specified by:

size in interface OutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Returns:

Number of edges

iterator

public Iterator<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>> iterator()

Specified by:

iterator in interface Iterable<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>>

mutableIterator

public Iterator<MutableEdge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>> mutableIterator()

Description copied from interface: MutableOutEdges

Returns an iterator over edges that can be modified in-place, either by changing the current edge value or by removing the current edge.

Specified by:

mutableIterator in interface MutableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Returns:

A mutable edge iterator

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

getEdgeValue

public org.apache.hadoop.io.NullWritable getEdgeValue(org.apache.hadoop.io.LongWritable targetVertexId)

Description copied from interface: StrictRandomAccessOutEdges

Return the edge value for the given target vertex id (or null if there is no edge pointing to it).

Specified by:

getEdgeValue in interface StrictRandomAccessOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Parameters:

targetVertexId - Target vertex id

Returns:

Edge value

setEdgeValue

public void setEdgeValue(org.apache.hadoop.io.LongWritable targetVertexId,
                         org.apache.hadoop.io.NullWritable edgeValue)

Description copied from interface: StrictRandomAccessOutEdges

Set the edge value for the given target vertex id (if an edge to that vertex exists).

Specified by:

setEdgeValue in interface StrictRandomAccessOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

Parameters:

targetVertexId - Target vertex id

edgeValue - Edge value

trim

public void trim()

Description copied from interface: Trimmable

Compacts all recent updates to this object.

Specified by:

trim in interface Trimmable