WIntArrayList (Apache Giraph Core 1.3.0-SNAPSHOT API)

java.lang.Object
- java.util.AbstractCollection<Integer>
- - it.unimi.dsi.fastutil.ints.AbstractIntCollection
  - - it.unimi.dsi.fastutil.ints.AbstractIntList
    - - it.unimi.dsi.fastutil.ints.IntArrayList
      - org.apache.giraph.types.ops.collections.array.WIntArrayList

All Implemented Interfaces:

it.unimi.dsi.fastutil.ints.IntCollection, it.unimi.dsi.fastutil.ints.IntIterable, it.unimi.dsi.fastutil.ints.IntList, it.unimi.dsi.fastutil.ints.IntStack, it.unimi.dsi.fastutil.Stack<Integer>, Serializable, Cloneable, Comparable<List<? extends Integer>>, Iterable<Integer>, Collection<Integer>, List<Integer>, RandomAccess, WArrayList<org.apache.hadoop.io.IntWritable>, WCollection<org.apache.hadoop.io.IntWritable>, WIntCollection, org.apache.hadoop.io.Writable

Direct Known Subclasses:

WIntArrayList.WReusableIntArrayList
```
public class WIntArrayList
extends it.unimi.dsi.fastutil.ints.IntArrayList
implements WArrayList<org.apache.hadoop.io.IntWritable>, WIntCollection
```
Writable extension of IntArrayList, as well as IntWritable implementation of WArrayList.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WIntArrayList.WReusableIntArrayList` Variant of WIntArrayList that doesn't reallocate smaller backing array on consecutive readFields/readElements calls, and so is suitable for reusable use.

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList
it.unimi.dsi.fastutil.ints.AbstractIntList.IntSubList

Field Summary
- Fields inherited from class it.unimi.dsi.fastutil.ints.IntArrayList
  a, DEFAULT_INITIAL_CAPACITY, size

Constructor Summary

Constructors
Constructor and Description
`WIntArrayList()` Creates a new array list with `IntArrayList.DEFAULT_INITIAL_CAPACITY` capacity.
`WIntArrayList(int capacity)` Creates a new array list with given capacity.
`WIntArrayList(it.unimi.dsi.fastutil.ints.IntCollection c)` Creates a new array list and fills it with a given type-specific collection.
`WIntArrayList(it.unimi.dsi.fastutil.ints.IntList l)` Creates a new array list and fills it with a given type-specific list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addW(org.apache.hadoop.io.IntWritable value)` Add value to the collection
`int`	`capacity()` Capacity of currently allocated memory
`void`	`fastForEachW(Consumer<org.apache.hadoop.io.IntWritable> f)` Traverse all elements of the collection, calling given function on each element.
`boolean`	`fastForEachWhileW(Predicate<org.apache.hadoop.io.IntWritable> f)` Traverse all elements of the collection, calling given function on each element, or until predicate returns false.
`ResettableIterator<org.apache.hadoop.io.IntWritable>`	`fastIteratorW()` Fast iterator over collection objects, which doesn't allocate new element for each returned element, and can be iterated multiple times using reset().
`ResettableIterator<org.apache.hadoop.io.IntWritable>`	`fastIteratorW(org.apache.hadoop.io.IntWritable iterationValue)` Fast iterator over collection objects, which doesn't allocate new element for each returned element, and can be iterated multiple times using reset().
`void`	`fillW(int from, int to, org.apache.hadoop.io.IntWritable value)` Sets given range of elements to a specified value.
`void`	`forEachInt(IntConsumer f)` Traverse all elements of the array list, calling given function on each element, or until predicate returns false.
`boolean`	`forEachWhileInt(IntPredicate f)` Traverse all elements of the array list, calling given function on each element.
`PrimitiveTypeOps<org.apache.hadoop.io.IntWritable>`	`getElementTypeOps()` TypeOps for type of elements this object holds
`void`	`getIntoW(int index, org.apache.hadoop.io.IntWritable to)` Get element at given index in the array, storing it into 'to' argument
`void`	`popIntoW(org.apache.hadoop.io.IntWritable to)` Pop value from the end of the array, storing it into 'to' argument
`void`	`readElements(DataInput in, int size)` Read elements from DataInput stream, with passing the size instead reading it from the stream.
`void`	`readFields(DataInput in)`
`static WIntArrayList`	`readNew(DataInput in)` Read array list from the DataInput stream into a newly created object.
`protected void`	`resizeArrayForRead(int size)` Resize array for reading given number of elements.
`void`	`setCapacity(int n)` Forces allocated memory to hold exactly N values
`void`	`setW(int index, org.apache.hadoop.io.IntWritable value)` Set element at given index in the array
`void`	`sort()` Sort the array in ascending order
`void`	`write(DataOutput out)`
`void`	`writeElements(DataOutput out)` Write elements to the DataOutput stream, without the size itself.
`static void`	`writeOrNull(WIntArrayList list, DataOutput out)` Write a potentially null list to a DataOutput.

Methods inherited from class it.unimi.dsi.fastutil.ints.IntArrayList
add, add, addAll, addAll, addElements, clear, clone, compareTo, elements, ensureCapacity, equals, getElements, getInt, indexOf, isEmpty, lastIndexOf, listIterator, rem, removeElements, removeInt, set, size, size, toIntArray, trim, trim, wrap, wrap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList
add, addAll, addAll, addAll, addAll, addElements, compareTo, contains, ensureIndex, ensureRestrictedIndex, equals, get, hashCode, indexOf, intListIterator, intListIterator, intSubList, iterator, lastIndexOf, listIterator, peek, peekInt, pop, popInt, push, push, remove, remove, set, subList, top, topInt, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
add, contains, containsAll, containsAll, intIterator, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.giraph.types.ops.collections.array.WArrayList
size, trim

Methods inherited from interface org.apache.giraph.types.ops.collections.WCollection
clear, size

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
add, addAll, contains, containsAll, intIterator, iterator, rem, removeAll, retainAll, toArray, toArray, toIntArray, toIntArray

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
add, contains, containsAll, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

- Constructor Detail
  - WIntArrayList
```
public WIntArrayList()
```
    Creates a new array list with IntArrayList.DEFAULT_INITIAL_CAPACITY capacity.
  - WIntArrayList
```
public WIntArrayList(int capacity)
```
    Creates a new array list with given capacity.
    
    Parameters:
    
    capacity - the initial capacity of the array list (may be 0).
  - WIntArrayList
```
public WIntArrayList(it.unimi.dsi.fastutil.ints.IntCollection c)
```
    Creates a new array list and fills it with a given type-specific collection.
    
    Parameters:
    
    c - a type-specific collection that will be used to fill the array list.
  - WIntArrayList
```
public WIntArrayList(it.unimi.dsi.fastutil.ints.IntList l)
```
    Creates a new array list and fills it with a given type-specific list.
    
    Parameters:
    
    l - a type-specific list that will be used to fill the array list.
- Method Detail
  - getElementTypeOps
```
public PrimitiveTypeOps<org.apache.hadoop.io.IntWritable> getElementTypeOps()
```
    Description copied from interface: WCollection
    
    TypeOps for type of elements this object holds
    
    Specified by:
    
    getElementTypeOps in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    TypeOps
  - capacity
```
public int capacity()
```
    Description copied from interface: WCollection
    
    Capacity of currently allocated memory
    
    Specified by:
    
    capacity in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    capacity
  - setCapacity
```
public void setCapacity(int n)
```
    Description copied from interface: WCollection
    
    Forces allocated memory to hold exactly N values
    
    Specified by:
    
    setCapacity in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    n - new capacity
  - addW
```
public void addW(org.apache.hadoop.io.IntWritable value)
```
    Description copied from interface: WCollection
    
    Add value to the collection
    
    Specified by:
    
    addW in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    value - Value
  - getIntoW
```
public void getIntoW(int index,
                     org.apache.hadoop.io.IntWritable to)
```
    Description copied from interface: WArrayList
    
    Get element at given index in the array, storing it into 'to' argument
    
    Specified by:
    
    getIntoW in interface WArrayList<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    index - Index
    
    to - Object to store value into
  - popIntoW
```
public void popIntoW(org.apache.hadoop.io.IntWritable to)
```
    Description copied from interface: WArrayList
    
    Pop value from the end of the array, storing it into 'to' argument
    
    Specified by:
    
    popIntoW in interface WArrayList<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    to - Object to store value into
  - setW
```
public void setW(int index,
                 org.apache.hadoop.io.IntWritable value)
```
    Description copied from interface: WArrayList
    
    Set element at given index in the array
    
    Specified by:
    
    setW in interface WArrayList<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    index - Index
    
    value - Value
  - fillW
```
public void fillW(int from,
                  int to,
                  org.apache.hadoop.io.IntWritable value)
```
    Description copied from interface: WArrayList
    
    Sets given range of elements to a specified value.
    
    Specified by:
    
    fillW in interface WArrayList<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    from - From index (inclusive)
    
    to - To index (exclusive)
    
    value - Value
  - fastIteratorW
```
public ResettableIterator<org.apache.hadoop.io.IntWritable> fastIteratorW()
```
    Description copied from interface: WCollection
    
    Fast iterator over collection objects, which doesn't allocate new element for each returned element, and can be iterated multiple times using reset(). Object returned by next() is only valid until next() is called again, because it is reused.
    
    Specified by:
    
    fastIteratorW in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    RessettableIterator
  - fastIteratorW
```
public ResettableIterator<org.apache.hadoop.io.IntWritable> fastIteratorW(org.apache.hadoop.io.IntWritable iterationValue)
```
    Description copied from interface: WCollection
    
    Fast iterator over collection objects, which doesn't allocate new element for each returned element, and can be iterated multiple times using reset(). Each call to next() populates passed value.
    
    Specified by:
    
    fastIteratorW in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    iterationValue - Value that call to next() will populate
    
    Returns:
    
    RessettableIterator
  - fastForEachW
```
public void fastForEachW(Consumer<org.apache.hadoop.io.IntWritable> f)
```
    Description copied from interface: WCollection
    
    Traverse all elements of the collection, calling given function on each element. Passed values are valid only during the call to the passed function, so data needs to be consumed during the function.
    
    Specified by:
    
    fastForEachW in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    f - Function to call on each element.
  - fastForEachWhileW
```
public boolean fastForEachWhileW(Predicate<org.apache.hadoop.io.IntWritable> f)
```
    Description copied from interface: WCollection
    
    Traverse all elements of the collection, calling given function on each element, or until predicate returns false. Passed values are valid only during the call to the passed function, so data needs to be consumed during the function.
    
    Specified by:
    
    fastForEachWhileW in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    f - Function to call on each element.
    
    Returns:
    
    true if the predicate returned true for all elements, false if it returned false for some element.
  - forEachInt
```
public void forEachInt(IntConsumer f)
```
    Traverse all elements of the array list, calling given function on each element, or until predicate returns false.
    
    Specified by:
    
    forEachInt in interface WIntCollection
    
    Parameters:
    
    f - Function to call on each element.
  - forEachWhileInt
```
public boolean forEachWhileInt(IntPredicate f)
```
    Traverse all elements of the array list, calling given function on each element.
    
    Specified by:
    
    forEachWhileInt in interface WIntCollection
    
    Parameters:
    
    f - Function to call on each element.
    
    Returns:
    
    true if the predicate returned true for all elements, false if it returned false for some element.
  - sort
```
public void sort()
```
    Description copied from interface: WArrayList
    
    Sort the array in ascending order
    
    Specified by:
    
    sort in interface WArrayList<org.apache.hadoop.io.IntWritable>
  - writeElements
```
public void writeElements(DataOutput out)
                   throws IOException
```
    Description copied from interface: WCollection
    
    Write elements to the DataOutput stream, without the size itself. Can be read back using readElements function.
    
    Specified by:
    
    writeElements in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    out - Data output
    
    Throws:
    
    IOException
  - write
```
public void write(DataOutput out)
           throws IOException
```
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException
  - readElements
```
public void readElements(DataInput in,
                         int size)
                  throws IOException
```
    Description copied from interface: WCollection
    
    Read elements from DataInput stream, with passing the size instead reading it from the stream.
    
    Specified by:
    
    readElements in interface WCollection<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    in - Data Input
    
    size - Number of elements
    
    Throws:
    
    IOException
  - resizeArrayForRead
```
protected void resizeArrayForRead(int size)
```
    Resize array for reading given number of elements.
    
    Parameters:
    
    size - Number of elements that will be read.
  - readFields
```
public void readFields(DataInput in)
                throws IOException
```
    Specified by:
    
    readFields in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException
  - writeOrNull
```
public static void writeOrNull(WIntArrayList list,
                               DataOutput out)
                        throws IOException
```
    Write a potentially null list to a DataOutput. Null list is written equivalently as an empty list. Use WritableUtils.writeIfNotNullAndObject if distinction is needed.
    
    Parameters:
    
    list - Array list to be written
    
    out - Data output
    
    Throws:
    
    IOException
  - readNew
```
public static WIntArrayList readNew(DataInput in)
                             throws IOException
```
    Read array list from the DataInput stream into a newly created object.
    
    Parameters:
    
    in - Data input
    
    Returns:
    
    New read array list object.
    
    Throws:
    
    IOException

Class WIntArrayList

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.ints.IntArrayList

Constructor Summary

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.ints.IntArrayList

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.giraph.types.ops.collections.array.WArrayList

Methods inherited from interface org.apache.giraph.types.ops.collections.WCollection

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Constructor Detail

WIntArrayList

WIntArrayList

WIntArrayList

WIntArrayList

Method Detail

getElementTypeOps

capacity

setCapacity

addW

getIntoW

popIntoW

setW

fillW

fastIteratorW

fastIteratorW

fastForEachW

fastForEachWhileW

forEachInt

forEachWhileInt

sort

writeElements

write

readElements

resizeArrayForRead

readFields

writeOrNull

readNew