SubcloneSeeker  1.0.0
Subclone deconvolution software framework
 All Classes Files Functions Variables Macros Pages
SubcloneSeeker::GenomicRange Class Reference

A segment on a reference genome. More...

#include <GenomicRange.h>

Inheritance diagram for SubcloneSeeker::GenomicRange:
SubcloneSeeker::GenomicLocation

Public Member Functions

 GenomicRange ()
 
virtual bool overlaps (GenomicRange &another)
 
bool operator== (const GenomicRange &another) const
 
- Public Member Functions inherited from SubcloneSeeker::GenomicLocation
 GenomicLocation ()
 
virtual bool operator< (const GenomicLocation &another) const
 
virtual bool operator> (const GenomicLocation &another) const
 

Public Attributes

unsigned long length
 
- Public Attributes inherited from SubcloneSeeker::GenomicLocation
int chrom
 
unsigned long position
 

Detailed Description

A segment on a reference genome.

This class represents a segment on a (implied) reference genome. It contains a start position described by GenomicLocation, and a greater than 1 length. In this way a segment will never cross a chromosome boundry.

See also
GenomicLocation

Constructor & Destructor Documentation

SubcloneSeeker::GenomicRange::GenomicRange ( )
inline

minimal constructor to reset all member variables

Member Function Documentation

bool SubcloneSeeker::GenomicRange::operator== ( const GenomicRange another) const
inline

GenomicRange compare operator ==

Parameters
anotherThe other GenomicRange to compare to
Returns
true if they are equal, false if not
virtual bool SubcloneSeeker::GenomicRange::overlaps ( GenomicRange another)
inlinevirtual

Check if two GenomicRange overlap with each other

Parameters
anotherThe other GenomicRange to check with
Returns
true if overlaps, or false

Member Data Documentation

unsigned long SubcloneSeeker::GenomicRange::length

The length of the segment


The documentation for this class was generated from the following file: