IntTypeOps (Apache Giraph Parent 1.4.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<IntTypeOps>
- - org.apache.giraph.types.ops.IntTypeOps

All Implemented Interfaces:

Serializable, Comparable<IntTypeOps>, NumericTypeOps<org.apache.hadoop.io.IntWritable>, PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>, PrimitiveTypeOps<org.apache.hadoop.io.IntWritable>, TypeOps<org.apache.hadoop.io.IntWritable>
```
public enum IntTypeOps
extends Enum<IntTypeOps>
implements PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>, NumericTypeOps<org.apache.hadoop.io.IntWritable>
```
TypeOps implementation for working with IntWritable type

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
Singleton instance

Enum Constants
Enum Constant and Description
`INSTANCE` Singleton instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(org.apache.hadoop.io.IntWritable value1, org.apache.hadoop.io.IntWritable value2)` Compare two values
`org.apache.hadoop.io.IntWritable`	`create()` Create new instance of type T.
`<V> Basic2ObjectMap.BasicInt2ObjectOpenHashMap<V>`	`create2ObjectOpenHashMap(int capacity, WritableWriter<V> valueWriter)` Create Basic2ObjectMap with key type T, given capacity.
`<V> Basic2ObjectMap.BasicInt2ObjectOpenHashMap<V>`	`create2ObjectOpenHashMap(WritableWriter<V> valueWriter)` Create Basic2ObjectMap with key type T.
`WIntArrayList`	`createArrayList()` Create WArrayList of type T.
`WIntArrayList`	`createArrayList(int capacity)` Create WArrayList of type T, given capacity.
`org.apache.hadoop.io.IntWritable`	`createCopy(org.apache.hadoop.io.IntWritable from)` Create a copy of passed object
`org.apache.hadoop.io.IntWritable`	`createMaxPositiveValue()` Maximal positive value representable via current type.
`org.apache.hadoop.io.IntWritable`	`createMinNegativeValue()` Minimal negative value representable via current type.
`org.apache.hadoop.io.IntWritable`	`createOne()` Value of one
`BasicSet.BasicIntOpenHashSet`	`createOpenHashSet()` Create BasicSet of type T.
`BasicSet.BasicIntOpenHashSet`	`createOpenHashSet(long capacity)` Create BasicSet of type T, given capacity.
`org.apache.hadoop.io.IntWritable`	`createZero()` Value of zero
`Class<org.apache.hadoop.io.IntWritable>`	`getTypeClass()` Class object for generic type T.
`void`	`multiplyInto(org.apache.hadoop.io.IntWritable value, org.apache.hadoop.io.IntWritable multiplier)` value*=multiplier
`void`	`negate(org.apache.hadoop.io.IntWritable value)` -value
`void`	`plusInto(org.apache.hadoop.io.IntWritable value, org.apache.hadoop.io.IntWritable increment)` value+=adder
`WIntArrayList`	`readNewArrayList(DataInput in)` Create WArrayList of type T by reading it from given input.
`void`	`set(org.apache.hadoop.io.IntWritable to, org.apache.hadoop.io.IntWritable from)` Copies the value from the second argument into the first.
`static IntTypeOps`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IntTypeOps[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - INSTANCE
```
public static final IntTypeOps INSTANCE
```
    Singleton instance
- Method Detail
  - values
```
public static IntTypeOps[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IntTypeOps c : IntTypeOps.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IntTypeOps valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getTypeClass
```
public Class<org.apache.hadoop.io.IntWritable> getTypeClass()
```
    Description copied from interface: TypeOps
    
    Class object for generic type T.
    
    Specified by:
    
    getTypeClass in interface TypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    Class<T> object
  - create
```
public org.apache.hadoop.io.IntWritable create()
```
    Description copied from interface: TypeOps
    
    Create new instance of type T.
    
    Specified by:
    
    create in interface TypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    new instance
  - createCopy
```
public org.apache.hadoop.io.IntWritable createCopy(org.apache.hadoop.io.IntWritable from)
```
    Description copied from interface: TypeOps
    
    Create a copy of passed object
    
    Specified by:
    
    createCopy in interface TypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    from - Object to copy
    
    Returns:
    
    Copy
  - set
```
public void set(org.apache.hadoop.io.IntWritable to,
                org.apache.hadoop.io.IntWritable from)
```
    Description copied from interface: TypeOps
    
    Copies the value from the second argument into the first.
    
    Specified by:
    
    set in interface TypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    to - Object into which the value should be copied
    
    from - Value of object to be copied
  - createArrayList
```
public WIntArrayList createArrayList()
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T.
    
    Specified by:
    
    createArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    WArrayList
  - createArrayList
```
public WIntArrayList createArrayList(int capacity)
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T, given capacity.
    
    Specified by:
    
    createArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    capacity - Capacity
    
    Returns:
    
    WArrayList
  - readNewArrayList
```
public WIntArrayList readNewArrayList(DataInput in)
                               throws IOException
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T by reading it from given input.
    
    Specified by:
    
    readNewArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    in - Input
    
    Returns:
    
    WArrayList
    
    Throws:
    
    IOException
  - createOpenHashSet
```
public BasicSet.BasicIntOpenHashSet createOpenHashSet()
```
    Description copied from interface: PrimitiveIdTypeOps
    
    Create BasicSet of type T.
    
    Specified by:
    
    createOpenHashSet in interface PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    BasicSet
  - createOpenHashSet
```
public BasicSet.BasicIntOpenHashSet createOpenHashSet(long capacity)
```
    Description copied from interface: PrimitiveIdTypeOps
    
    Create BasicSet of type T, given capacity.
    
    Specified by:
    
    createOpenHashSet in interface PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    capacity - Capacity
    
    Returns:
    
    BasicSet
  - create2ObjectOpenHashMap
```
public <V> Basic2ObjectMap.BasicInt2ObjectOpenHashMap<V> create2ObjectOpenHashMap(WritableWriter<V> valueWriter)
```
    Description copied from interface: PrimitiveIdTypeOps
    
    Create Basic2ObjectMap with key type T. Values are represented as object, even if they can be primitive. You can pass null as valueWriter, but readFields/write will throw an Exception, if called.
    
    Specified by:
    
    create2ObjectOpenHashMap in interface PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>
    
    Type Parameters:
    
    V - Type of values in the map
    
    Parameters:
    
    valueWriter - Writer of values
    
    Returns:
    
    Basic2ObjectMap
  - create2ObjectOpenHashMap
```
public <V> Basic2ObjectMap.BasicInt2ObjectOpenHashMap<V> create2ObjectOpenHashMap(int capacity,
                                                                                  WritableWriter<V> valueWriter)
```
    Description copied from interface: PrimitiveIdTypeOps
    
    Create Basic2ObjectMap with key type T, given capacity. Values are represented as object, even if they can be primitive. You can pass null as valueWriter, but readFields/write will throw an Exception, if called.
    
    Specified by:
    
    create2ObjectOpenHashMap in interface PrimitiveIdTypeOps<org.apache.hadoop.io.IntWritable>
    
    Type Parameters:
    
    V - Type of values in the map
    
    Parameters:
    
    capacity - Capacity
    
    valueWriter - Writer of values
    
    Returns:
    
    Basic2ObjectMap
  - createZero
```
public org.apache.hadoop.io.IntWritable createZero()
```
    Description copied from interface: NumericTypeOps
    
    Value of zero
    
    Specified by:
    
    createZero in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    New object with value of zero
  - createOne
```
public org.apache.hadoop.io.IntWritable createOne()
```
    Description copied from interface: NumericTypeOps
    
    Value of one
    
    Specified by:
    
    createOne in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    New object with value of one
  - createMinNegativeValue
```
public org.apache.hadoop.io.IntWritable createMinNegativeValue()
```
    Description copied from interface: NumericTypeOps
    
    Minimal negative value representable via current type. Negative infinity for floating point numbers.
    
    Specified by:
    
    createMinNegativeValue in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    New object with min negative value
  - createMaxPositiveValue
```
public org.apache.hadoop.io.IntWritable createMaxPositiveValue()
```
    Description copied from interface: NumericTypeOps
    
    Maximal positive value representable via current type. Positive infinity for floating point numbers.
    
    Specified by:
    
    createMaxPositiveValue in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Returns:
    
    New object with max positive value
  - plusInto
```
public void plusInto(org.apache.hadoop.io.IntWritable value,
                     org.apache.hadoop.io.IntWritable increment)
```
    Description copied from interface: NumericTypeOps
    
    value+=adder
    
    Specified by:
    
    plusInto in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    value - Value to modify
    
    increment - Increment
  - multiplyInto
```
public void multiplyInto(org.apache.hadoop.io.IntWritable value,
                         org.apache.hadoop.io.IntWritable multiplier)
```
    Description copied from interface: NumericTypeOps
    
    value*=multiplier
    
    Specified by:
    
    multiplyInto in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    value - Value to modify
    
    multiplier - Multiplier
  - negate
```
public void negate(org.apache.hadoop.io.IntWritable value)
```
    Description copied from interface: NumericTypeOps
    
    -value
    
    Specified by:
    
    negate in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    value - Value to negate
  - compare
```
public int compare(org.apache.hadoop.io.IntWritable value1,
                   org.apache.hadoop.io.IntWritable value2)
```
    Description copied from interface: NumericTypeOps
    
    Compare two values
    
    Specified by:
    
    compare in interface NumericTypeOps<org.apache.hadoop.io.IntWritable>
    
    Parameters:
    
    value1 - First value
    
    value2 - Second value
    
    Returns:
    
    0 if values are equal, negative value if value1<value2 and positive value if value1>value2

Enum IntTypeOps

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Method Detail

values

valueOf

getTypeClass

create

createCopy

set

createArrayList

createArrayList

readNewArrayList

createOpenHashSet

createOpenHashSet

create2ObjectOpenHashMap

create2ObjectOpenHashMap

createZero

createOne

createMinNegativeValue

createMaxPositiveValue

plusInto

multiplyInto

negate

compare