Fixing ReadAndInterval overlap comments.

This commit is contained in:
Mauricio Carneiro 2011-09-19 13:28:41 -04:00
parent ecb8466662
commit 5e832254a4
1 changed files with 14 additions and 5 deletions

View File

@ -118,31 +118,40 @@ public class ReadUtils {
/** /**
* This enum represents all the different ways in which a read can overlap an interval. * This enum represents all the different ways in which a read can overlap an interval.
* *
* NO_OVERLAP: * NO_OVERLAP_CONTIG:
* read and interval are in different contigs.
*
* NO_OVERLAP_LEFT:
* the read does not overlap the interval.
*
* |----------------| (interval)
* <----------------> (read)
*
* NO_OVERLAP_RIGHT:
* the read does not overlap the interval. * the read does not overlap the interval.
* *
* |----------------| (interval) * |----------------| (interval)
* <----------------> (read) * <----------------> (read)
* *
* LEFT_OVERLAP: * OVERLAP_LEFT:
* the read starts before the beginning of the interval but ends inside of it * the read starts before the beginning of the interval but ends inside of it
* *
* |----------------| (interval) * |----------------| (interval)
* <----------------> (read) * <----------------> (read)
* *
* RIGHT_OVERLAP: * OVERLAP_RIGHT:
* the read starts inside the interval but ends outside of it * the read starts inside the interval but ends outside of it
* *
* |----------------| (interval) * |----------------| (interval)
* <----------------> (read) * <----------------> (read)
* *
* FULL_OVERLAP: * OVERLAP_LEFT_AND_RIGHT:
* the read starts before the interval and ends after the interval * the read starts before the interval and ends after the interval
* *
* |-----------| (interval) * |-----------| (interval)
* <-------------------> (read) * <-------------------> (read)
* *
* CONTAINED: * OVERLAP_CONTAINED:
* the read starts and ends inside the interval * the read starts and ends inside the interval
* *
* |----------------| (interval) * |----------------| (interval)