org.apache.giraph.edge

Class LongDiffNullArrayEdges

java.lang.Object

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

org.apache.giraph.edge.ConfigurableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>

org.apache.giraph.edge.LongDiffNullArrayEdges

All Implemented Interfaces:

Iterable<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>>, GiraphConfigurationSettable<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.NullWritable>, ImmutableClassesGiraphConfigurable<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,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>, Trimmable, org.apache.hadoop.io.Writable

@NotThreadSafe
public class LongDiffNullArrayEdges
extends ConfigurableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>
implements ReuseObjectsOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, MutableOutEdges<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>, Trimmable

Implementation of OutEdges with long ids and null edge values, backed by a dynamic primitive array. Parallel edges are allowed. Note: this implementation is optimized for space usage, but random access and edge removals are expensive. Users of this class should explicitly call trim() function to compact in-memory representation after all updates are done. Compacting object is expensive so should only be done once after bulk update. Compaction can also be caused by serialization attempt or by calling iterator()

Constructor Summary

Constructors

Constructor and Description
LongDiffNullArrayEdges()

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.
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>> edgeIterator) 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	setConf(ImmutableClassesGiraphConfiguration<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.NullWritable> conf) Set the configuration to be used by this object.
int	size() Return the number of edges.
void	trim() This function takes all recent updates and stores them efficiently.
void	write(DataOutput out)

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

getConf

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

LongDiffNullArrayEdges

public LongDiffNullArrayEdges()

Method Detail

setConf

public void setConf(ImmutableClassesGiraphConfiguration<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.NullWritable> conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

setConf in interface GiraphConfigurationSettable<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.NullWritable>

Overrides:

setConf in class DefaultImmutableClassesGiraphConfigurable<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.NullWritable>

Parameters:

conf - Set configuration

initialize

public void initialize(Iterable<Edge<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.NullWritable>> edgeIterator)

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:

edgeIterator - 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

trim

public void trim()

This function takes all recent updates and stores them efficiently. It is safe to call this function multiple times.

Specified by:

trim in interface Trimmable