FloatTypeOps (Apache Giraph Parent 1.4.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Comparable<FloatTypeOps>, NumericTypeOps<org.apache.hadoop.io.FloatWritable>, PrimitiveTypeOps<org.apache.hadoop.io.FloatWritable>, TypeOps<org.apache.hadoop.io.FloatWritable>
```
public enum FloatTypeOps
extends Enum<FloatTypeOps>
implements PrimitiveTypeOps<org.apache.hadoop.io.FloatWritable>, NumericTypeOps<org.apache.hadoop.io.FloatWritable>
```
TypeOps implementation for working with FloatWritable 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.FloatWritable value1, org.apache.hadoop.io.FloatWritable value2)` Compare two values
`org.apache.hadoop.io.FloatWritable`	`create()` Create new instance of type T.
`WFloatArrayList`	`createArrayList()` Create WArrayList of type T.
`WFloatArrayList`	`createArrayList(int capacity)` Create WArrayList of type T, given capacity.
`org.apache.hadoop.io.FloatWritable`	`createCopy(org.apache.hadoop.io.FloatWritable from)` Create a copy of passed object
`org.apache.hadoop.io.FloatWritable`	`createMaxPositiveValue()` Maximal positive value representable via current type.
`org.apache.hadoop.io.FloatWritable`	`createMinNegativeValue()` Minimal negative value representable via current type.
`org.apache.hadoop.io.FloatWritable`	`createOne()` Value of one
`org.apache.hadoop.io.FloatWritable`	`createZero()` Value of zero
`Class<org.apache.hadoop.io.FloatWritable>`	`getTypeClass()` Class object for generic type T.
`void`	`multiplyInto(org.apache.hadoop.io.FloatWritable value, org.apache.hadoop.io.FloatWritable multiplier)` value*=multiplier
`void`	`negate(org.apache.hadoop.io.FloatWritable value)` -value
`void`	`plusInto(org.apache.hadoop.io.FloatWritable value, org.apache.hadoop.io.FloatWritable increment)` value+=adder
`WFloatArrayList`	`readNewArrayList(DataInput in)` Create WArrayList of type T by reading it from given input.
`void`	`set(org.apache.hadoop.io.FloatWritable to, org.apache.hadoop.io.FloatWritable from)` Copies the value from the second argument into the first.
`static FloatTypeOps`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FloatTypeOps[]`	`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 FloatTypeOps INSTANCE
```
    Singleton instance
- Method Detail
  - values
```
public static FloatTypeOps[] 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 (FloatTypeOps c : FloatTypeOps.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FloatTypeOps 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.FloatWritable> getTypeClass()
```
    Description copied from interface: TypeOps
    
    Class object for generic type T.
    
    Specified by:
    
    getTypeClass in interface TypeOps<org.apache.hadoop.io.FloatWritable>
    
    Returns:
    
    Class<T> object
  - create
```
public org.apache.hadoop.io.FloatWritable create()
```
    Description copied from interface: TypeOps
    
    Create new instance of type T.
    
    Specified by:
    
    create in interface TypeOps<org.apache.hadoop.io.FloatWritable>
    
    Returns:
    
    new instance
  - createCopy
```
public org.apache.hadoop.io.FloatWritable createCopy(org.apache.hadoop.io.FloatWritable from)
```
    Description copied from interface: TypeOps
    
    Create a copy of passed object
    
    Specified by:
    
    createCopy in interface TypeOps<org.apache.hadoop.io.FloatWritable>
    
    Parameters:
    
    from - Object to copy
    
    Returns:
    
    Copy
  - set
```
public void set(org.apache.hadoop.io.FloatWritable to,
                org.apache.hadoop.io.FloatWritable 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.FloatWritable>
    
    Parameters:
    
    to - Object into which the value should be copied
    
    from - Value of object to be copied
  - createArrayList
```
public WFloatArrayList createArrayList()
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T.
    
    Specified by:
    
    createArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Returns:
    
    WArrayList
  - createArrayList
```
public WFloatArrayList 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.FloatWritable>
    
    Parameters:
    
    capacity - Capacity
    
    Returns:
    
    WArrayList
  - readNewArrayList
```
public WFloatArrayList 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.FloatWritable>
    
    Parameters:
    
    in - Input
    
    Returns:
    
    WArrayList
    
    Throws:
    
    IOException
  - createZero
```
public org.apache.hadoop.io.FloatWritable createZero()
```
    Description copied from interface: NumericTypeOps
    
    Value of zero
    
    Specified by:
    
    createZero in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Returns:
    
    New object with value of zero
  - createOne
```
public org.apache.hadoop.io.FloatWritable createOne()
```
    Description copied from interface: NumericTypeOps
    
    Value of one
    
    Specified by:
    
    createOne in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Returns:
    
    New object with value of one
  - createMinNegativeValue
```
public org.apache.hadoop.io.FloatWritable 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.FloatWritable>
    
    Returns:
    
    New object with min negative value
  - createMaxPositiveValue
```
public org.apache.hadoop.io.FloatWritable 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.FloatWritable>
    
    Returns:
    
    New object with max positive value
  - plusInto
```
public void plusInto(org.apache.hadoop.io.FloatWritable value,
                     org.apache.hadoop.io.FloatWritable increment)
```
    Description copied from interface: NumericTypeOps
    
    value+=adder
    
    Specified by:
    
    plusInto in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Parameters:
    
    value - Value to modify
    
    increment - Increment
  - multiplyInto
```
public void multiplyInto(org.apache.hadoop.io.FloatWritable value,
                         org.apache.hadoop.io.FloatWritable multiplier)
```
    Description copied from interface: NumericTypeOps
    
    value*=multiplier
    
    Specified by:
    
    multiplyInto in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Parameters:
    
    value - Value to modify
    
    multiplier - Multiplier
  - negate
```
public void negate(org.apache.hadoop.io.FloatWritable value)
```
    Description copied from interface: NumericTypeOps
    
    -value
    
    Specified by:
    
    negate in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    Parameters:
    
    value - Value to negate
  - compare
```
public int compare(org.apache.hadoop.io.FloatWritable value1,
                   org.apache.hadoop.io.FloatWritable value2)
```
    Description copied from interface: NumericTypeOps
    
    Compare two values
    
    Specified by:
    
    compare in interface NumericTypeOps<org.apache.hadoop.io.FloatWritable>
    
    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 FloatTypeOps

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

createZero

createOne

createMinNegativeValue

createMaxPositiveValue

plusInto

multiplyInto

negate

compare