yat  0.21pre
Public Member Functions | List of all members
theplu::yat::omic::BamRegion Class Reference

#include <yat/omic/BamRegion.h>

Public Member Functions

 BamRegion (void)=default
 default constructor
 
 BamRegion (int tid, hts_pos_t begin=0, hts_pos_t end=HTS_POS_MAX)
 Constructor.
 
int & tid (void)
 
const int & tid (void) const
 
hts_pos_t & begin (void)
 
const hts_pos_t & begin (void) const
 
hts_pos_t & end (void)
 
const hts_pos_t & end (void) const
 

Detailed Description

Class holds a region as defined by tid (chromosome), begin and end coordinates. The region is 0-based, which means it is semi open such that begin is included and end is not.

Since
New in yat 0.21

Member Function Documentation

◆ begin() [1/2]

hts_pos_t& theplu::yat::omic::BamRegion::begin ( void  )
Returns
first position

◆ begin() [2/2]

const hts_pos_t& theplu::yat::omic::BamRegion::begin ( void  ) const
Returns
first position

◆ end() [1/2]

hts_pos_t& theplu::yat::omic::BamRegion::end ( void  )
Returns
end position

◆ end() [2/2]

const hts_pos_t& theplu::yat::omic::BamRegion::end ( void  ) const
Returns
end position

◆ tid() [1/2]

int& theplu::yat::omic::BamRegion::tid ( void  )
Returns
chromosome ID

◆ tid() [2/2]

const int& theplu::yat::omic::BamRegion::tid ( void  ) const
Returns
chromosome ID

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

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14