edu.umd.cloud9.io.pair
Class PairOfFloats

java.lang.Object
  edu.umd.cloud9.io.pair.PairOfFloats

All Implemented Interfaces:

Comparable<PairOfFloats>, Writable, WritableComparable<PairOfFloats>

public class PairOfFloats
extends Object
implements WritableComparable<PairOfFloats>

WritableComparable representing a pair of floats. The elements in the pair are referred to as the left and right elements. The natural sort order is: first by the left element, and then by the right element.

Author:

Jimmy Lin

Nested Class Summary

static class

PairOfFloats.Comparator Comparator optimized for PairOfFloats.

Constructor Summary

PairOfFloats()
Creates a pair.

PairOfFloats(float left, float right)
Creates a pair.

Method Summary

PairOfFloats	clone() Clones this object.
int	compareTo(PairOfFloats obj) Defines a natural sort order for pairs.
boolean	equals(Object obj) Checks two pairs for equality.
float	getKey() Returns the key (left element).
float	getLeftElement() Returns the left element.
float	getRightElement() Returns the right element.
float	getValue() Returns the value (right element).
int	hashCode() Returns a hash code value for the pair.
void	readFields(DataInput in) Deserializes this pair.
void	set(float left, float right) Sets the right and left elements of this pair.
String	toString() Generates human-readable String representation of this pair.
void	write(DataOutput out) Serializes this pair.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PairOfFloats

public PairOfFloats()

Creates a pair.

PairOfFloats

public PairOfFloats(float left,
                    float right)

Creates a pair.

Parameters:

left - the left element

right - the right element

Method Detail

readFields

public void readFields(DataInput in)
                throws IOException

Deserializes this pair.

Specified by:

readFields in interface Writable

Parameters:

in - source for raw byte representation

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Serializes this pair.

Specified by:

write in interface Writable

Parameters:

out - where to write the raw byte representation

Throws:

IOException

getLeftElement

public float getLeftElement()

Returns the left element.

Returns:

the left element

getRightElement

public float getRightElement()

Returns the right element.

Returns:

the right element

getKey

public float getKey()

Returns the key (left element).

Returns:

the key

getValue

public float getValue()

Returns the value (right element).

Returns:

the value

set

public void set(float left,
                float right)

Sets the right and left elements of this pair.

Parameters:

left - the left element

right - the right element

equals

public boolean equals(Object obj)

Checks two pairs for equality.

Overrides:

equals in class Object

Parameters:

obj - object for comparison

Returns:

true if obj is equal to this object, false otherwise

compareTo

public int compareTo(PairOfFloats obj)

Defines a natural sort order for pairs. Pairs are sorted first by the left element, and then by the right element.

Specified by:

compareTo in interface Comparable<PairOfFloats>

Returns:

a value less than zero, a value greater than zero, or zero if this pair should be sorted before, sorted after, or is equal to obj.

hashCode

public int hashCode()

Returns a hash code value for the pair.

Overrides:

hashCode in class Object

Returns:

hash code for the pair

toString

public String toString()

Generates human-readable String representation of this pair.

Overrides:

toString in class Object

Returns:

human-readable String representation of this pair

clone

public PairOfFloats clone()

Clones this object.

Overrides:

clone in class Object

Returns:

clone of this object