public interface DiploidStates
Class DiploidStates
represents a list of iterators
(one iterator for each marker) that iterate over a subset of diploid
HMM states at a marker.
Instances of class DiploidStates
are not requires to be
thread-safe.
Modifier and Type | Method and Description |
---|---|
int |
edge1()
Returns the first edge of the edge pair that is the current element
in the iterations, or returns
-1 if this.next()
has not been invoked since the most recent invocation of
this.setMarker() . |
int |
edge2()
Returns the second edge of the edge pair that is the current element
in the iteration, or returns
-1 if this.next()
has not been invoked since the most recent invocation of
this.setMarker() . |
boolean |
hasNext()
Returns
true if the iteration of the ordered edge pairs has
more elements, and returns false otherwise. |
int |
marker()
Returns the current marker index.
|
void |
next()
Advances the iteration of ordered edge pairs to the next element.
|
int |
nMarkers()
Returns the number of markers.
|
void |
setMarker(int marker)
Initializes the iteration of permitted ordered edge pairs for the
specified marker.
|
int nMarkers()
void setMarker(int marker)
marker
- a marker indexjava.lang.IllegalArgumentException
- if
marker < 0 || marker >= this.nMarkers()
int marker()
boolean hasNext()
true
if the iteration of the ordered edge pairs has
more elements, and returns false
otherwise.true
if the iteration of the ordered edge pairs has
more elementsvoid next()
java.util.NoSuchElementException
- if this.hasNext() == false
int edge1()
-1
if this.next()
has not been invoked since the most recent invocation of
this.setMarker()
.int edge2()
-1
if this.next()
has not been invoked since the most recent invocation of
this.setMarker()
.