yat  0.21pre
Public Member Functions | List of all members
theplu::yat::omic::BamPairBuffer< OutputIterator > Class Template Reference

#include <yat/omic/BamPairBuffer.h>

Public Member Functions

 BamPairBuffer (OutputIterator out)
 Constructor. More...
 
void push (const BamRead &first, const BamRead &second)
 

Detailed Description

template<typename OutputIterator>
class theplu::yat::omic::BamPairBuffer< OutputIterator >

Bam read pairs can be added to this class and it handles to sort reads (according to the genomic position, see BamLessPos) and copy to an output iterator. It is assumed that the inserted read pairs are sorted with respect to their first read. This can be accomplished with e.g. BapPairIterator2.

See also
BamPairIterator2
Since
New in yat 0.19

Constructor & Destructor Documentation

◆ BamPairBuffer()

template<typename OutputIterator >
theplu::yat::omic::BamPairBuffer< OutputIterator >::BamPairBuffer ( OutputIterator  out)
inline

Constructor.

Creates a buffer that flush elements to out.

Member Function Documentation

◆ push()

template<typename OutputIterator >
void theplu::yat::omic::BamPairBuffer< OutputIterator >::push ( const BamRead first,
const BamRead second 
)
inline

Position of first read is less (or equal) than position of second.

It is assumed that read pairs are pushed in a sorted order such that first is not less than the previous first.


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