HashMapEdges (Apache Giraph Parent 1.4.0-SNAPSHOT API)

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.HashMapEdges<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>, MutableOutEdges<I,E>, OutEdges<I,E>, StrictRandomAccessOutEdges<I,E>, org.apache.hadoop.io.Writable
```
public class HashMapEdges
extends ConfigurableOutEdges<I,E>
implements StrictRandomAccessOutEdges<I,E>, MutableOutEdges<I,E>
```
OutEdges implementation backed by a HashMap. Parallel edges are not allowed. Note: this implementation is optimized for fast random access and mutations, but uses more space.

Constructor Summary

Constructors
Constructor and Description

HashMapEdges()

Constructors
Constructor and Description
`HashMapEdges()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Edge<I,E> edge)` Add an edge.
`E`	`getEdgeValue(I 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<I,E>> edges)` Initialize the data structure and set the edges from an iterable.
`Iterator<Edge<I,E>>`	`iterator()`
`Iterator<MutableEdge<I,E>>`	`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(I targetVertexId)` Remove all edges to the given target vertex.
`void`	`setEdgeValue(I targetVertexId, E 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`	`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
 - HashMapEdges
```
public HashMapEdges()
```
- 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
 
 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
 
 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
 - 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
 
 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
 
 Parameters:
 
 targetVertexId - Target vertex id
 - getEdgeValue
```
public E getEdgeValue(I 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
 
 Parameters:
 
 targetVertexId - Target vertex id
 
 Returns:
 
 Edge value
 - setEdgeValue
```
public void setEdgeValue(I targetVertexId,
 E 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
 
 Parameters:
 
 targetVertexId - Target vertex id
 
 edgeValue - Edge value
 - size
```
public int size()
```
 Description copied from interface: OutEdges
 
 Return the number of edges.
 
 Specified by:
 
 size in interface OutEdges
 
 Returns:
 
 Number of edges
 - iterator
```
public Iterator<Edge<I,E>> iterator()
```
 Specified by:
 
 iterator in interface Iterable<Edge>
 - mutableIterator
```
public Iterator<MutableEdge<I,E>> 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
 
 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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

HashMapEdges

Method Detail

initialize

initialize

initialize

add

remove

getEdgeValue

setEdgeValue

size

iterator

mutableIterator

write

readFields