ibd

Class HapSegment

java.lang.Object

ibd.HapSegment

All Implemented Interfaces:

IntInterval, java.lang.Comparable<HapSegment>

public class HapSegment
extends java.lang.Object
implements java.lang.Comparable<HapSegment>, IntInterval

Class HapSegment represents a marker interval for a haplotype.

Instances of class HapSegment are immutable.

Constructor Summary

Constructors

Constructor and Description
HapSegment(int hap, int start, int end) Constructs a new HapSegment instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(HapSegment hs) Compares this object with the specified object for order.
int	end() Returns the end marker index (inclusive).
boolean	equals(java.lang.Object o) Compares the specified object with this HapSegment for equality.
int	hap() Returns the first haplotype index.
int	hashCode() Returns the hash code value for this object.
int	start() Returns the start marker index (inclusive).
java.lang.String	toString() Returns a string representation of this.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HapSegment

public HapSegment(int hap,
                  int start,
                  int end)

Constructs a new HapSegment instance.

Parameters:

hap - the haplotype index

start - the start marker index (inclusive)

end - the end marker index (inclusive)

Throws:

java.lang.IllegalArgumentException - if start > end

Method Detail

hap

public int hap()

Returns the first haplotype index.

Returns:

the first haplotype index

start

public int start()

Returns the start marker index (inclusive).

Specified by:

start in interface IntInterval

Returns:

the start marker index (inclusive)

end

public int end()

Returns the end marker index (inclusive).

Specified by:

end in interface IntInterval

Returns:

the end marker index (inclusive)

toString

public java.lang.String toString()

Returns a string representation of this. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this

hashCode

public int hashCode()

Returns the hash code value for this object. The hash code is defined by the following calculation:

  int hash = 5;
  hash = 89 * hash + this.hap();
  hash = 89 * hash + this.start();
  hash = 89 * hash + this.end();
     

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this object

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this HapSegment for equality. Returns true if the specified object is a HapSegment instance and if this HapSegment is equal to the specified HapSegment, and returns false otherwise. Two HapSegment instances are equal if they have equal haplotype indices, equal starting marker indices, and equal ending marker indices.

Overrides:

equals in class java.lang.Object

Parameters:

o - the reference object with which to compare.

Returns:

true if the specified object is an HapSegment instance and if this HapSegment is equal to the specified HapSegment

compareTo

public int compareTo(HapSegment hs)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. HapSegment instances are ordered first by this.start(), then by this.end(), and finally by this.hap().

Specified by:

compareTo in interface java.lang.Comparable<HapSegment>

Parameters:

hs - the HapSegment to be compared

Returns:

a negative integer, zero, or a positive integer as this HapSegment is less than, equal to, or greater than the specified HapSegment

Throws:

java.lang.NullPointerException - if o == null