Package jebl.evolution.coalescent
Class Intervals
- java.lang.Object
-
- jebl.evolution.coalescent.Intervals
-
- All Implemented Interfaces:
IntervalList
public class Intervals extends java.lang.Object implements IntervalList
A concrete class for a set of coalescent intevals.- Version:
- $Id: Intervals.java 305 2006-04-26 00:22:30Z rambaut $
- Author:
- Andrew Rambaut, Alexei Drummond
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jebl.evolution.coalescent.IntervalList
IntervalList.IntervalType, IntervalList.Utils
-
-
Constructor Summary
Constructors Constructor Description Intervals(int maxEventCount)Intervals(RootedTree tree)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCoalescentEvent(double time)voidaddMigrationEvent(double time, int destination)voidaddNothingEvent(double time)voidaddSampleEvent(double time)voidcopyIntervals(Intervals source)intgetCoalescentEvents(int i)Returns the number coalescent events in an intervaldoublegetInterval(int i)Gets an interval.intgetIntervalCount()get number of intervalsIntervalList.IntervalTypegetIntervalType(int i)Returns the type of interval observed.intgetLineageCount(int i)Returns the number of uncoalesced lineages within this interval.intgetSampleCount()get the total number of sampling events.doublegetTotalDuration()get the total duration of these intervals.booleanisBinaryCoalescent()Checks whether this set of coalescent intervals is fully resolved (i.e.booleanisCoalescentOnly()Checks whether this set of coalescent intervals coalescent only (i.e.voidresetEvents()
-
-
-
Constructor Detail
-
Intervals
public Intervals(RootedTree tree)
-
Intervals
public Intervals(int maxEventCount)
-
-
Method Detail
-
copyIntervals
public void copyIntervals(Intervals source)
-
resetEvents
public void resetEvents()
-
addSampleEvent
public void addSampleEvent(double time)
-
addCoalescentEvent
public void addCoalescentEvent(double time)
-
addMigrationEvent
public void addMigrationEvent(double time, int destination)
-
addNothingEvent
public void addNothingEvent(double time)
-
getSampleCount
public int getSampleCount()
Description copied from interface:IntervalListget the total number of sampling events.- Specified by:
getSampleCountin interfaceIntervalList
-
getIntervalCount
public int getIntervalCount()
Description copied from interface:IntervalListget number of intervals- Specified by:
getIntervalCountin interfaceIntervalList
-
getInterval
public double getInterval(int i)
Description copied from interface:IntervalListGets an interval.- Specified by:
getIntervalin interfaceIntervalList
-
getLineageCount
public int getLineageCount(int i)
Description copied from interface:IntervalListReturns the number of uncoalesced lineages within this interval. Required for s-coalescents, where new lineages are added as earlier samples are come across.- Specified by:
getLineageCountin interfaceIntervalList
-
getCoalescentEvents
public int getCoalescentEvents(int i)
Description copied from interface:IntervalListReturns the number coalescent events in an interval- Specified by:
getCoalescentEventsin interfaceIntervalList
-
getIntervalType
public IntervalList.IntervalType getIntervalType(int i)
Description copied from interface:IntervalListReturns the type of interval observed.- Specified by:
getIntervalTypein interfaceIntervalList
-
getTotalDuration
public double getTotalDuration()
Description copied from interface:IntervalListget the total duration of these intervals.- Specified by:
getTotalDurationin interfaceIntervalList
-
isBinaryCoalescent
public boolean isBinaryCoalescent()
Description copied from interface:IntervalListChecks whether this set of coalescent intervals is fully resolved (i.e. whether is has exactly one coalescent event in each subsequent interval)- Specified by:
isBinaryCoalescentin interfaceIntervalList
-
isCoalescentOnly
public boolean isCoalescentOnly()
Description copied from interface:IntervalListChecks whether this set of coalescent intervals coalescent only (i.e. whether is has exactly one or more coalescent event in each subsequent interval)- Specified by:
isCoalescentOnlyin interfaceIntervalList
-
-