multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
multovl::MultiRegLimit Class Reference

#include "multireglimit.hh"

Inheritance diagram for multovl::MultiRegLimit:
multovl::MultiOverlap multovl::prob::ShuffleOvl

Public Types

typedef std::multiset< RegLimitreglim_t
 

Public Member Functions

 MultiRegLimit ()
 Init to empty.
 
 MultiRegLimit (const Region &region, unsigned int trackid)
 Init to contain a region and trackid.
 
 MultiRegLimit (const MultiRegLimit &other)
 
MultiRegLimitoperator= (const MultiRegLimit &rhs)
 
void add (const Region &region, unsigned int trackid)
 
const reglim_t & reglim () const
 
MultiRegLimitoperator+= (const MultiRegLimit &rhs)
 

Protected Member Functions

reglim_t & nonconst_reglim ()
 

Friends

class boost::serialization::access
 

Detailed Description

Objects of the MultiRegLimit class store genomic regions encoded by the regions' first and last positions. Internally, this is implemented by a multiset storing RegLimit objects.

Constructor & Destructor Documentation

multovl::MultiRegLimit::MultiRegLimit ( const MultiRegLimit other)

Copy ctor Implements a deep copy so that the AncestorRegion objects under the RegLimits will be completely independent from those under /other/

Member Function Documentation

void multovl::MultiRegLimit::add ( const Region region,
unsigned int  trackid 
)

Adds a region /region/ identified by /trackid/ to the calling object.

Parameters
regiona genomic region to be stored
trackidan arbitrary number identifying a track (collection of regions).
reglim_t& multovl::MultiRegLimit::nonconst_reglim ( )
inlineprotected
Returns
non-const access to the RegLimit multiset inside
MultiRegLimit& multovl::MultiRegLimit::operator+= ( const MultiRegLimit rhs)

Merges another MultiRegLimit object into the calling object.

Parameters
rhsthe other MultiRegLimit object.
Returns
the calling object
MultiRegLimit& multovl::MultiRegLimit::operator= ( const MultiRegLimit rhs)

Assignment Implements a deep copy of the underlying AncestorRegion objects just like the copy ctor

const reglim_t& multovl::MultiRegLimit::reglim ( ) const
inline
Returns
const access to the RegLimit multiset inside

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