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

#include <yat/omic/VcfCompare.h>

Public Member Functions

 VcfCompare (void)
 
 VcfCompare (const VcfHeader &hdr)
 
bool operator() (const VCF &lhs, const VCF &rhs) const
 

Detailed Description

Functor used to compare to VCF objects with respect to their genomic position.

Since
New in yat 0.16

Constructor & Destructor Documentation

◆ VcfCompare() [1/2]

theplu::yat::omic::VcfCompare::VcfCompare ( void  )

Default constructor

Note
Constructed object is useless as no chromosomes are defined

◆ VcfCompare() [2/2]

theplu::yat::omic::VcfCompare::VcfCompare ( const VcfHeader hdr)

Constructs an object using chromosomes as defoined in contig entries in header hdr.

Member Function Documentation

◆ operator()()

bool theplu::yat::omic::VcfCompare::operator() ( const VCF lhs,
const VCF rhs 
) const
Returns
true if lhs is less than rhs

The following criteria are used to compare the two objects: 1) chromosome (as defined din constructor) 2) position POS 3) reference allele REF 4) alternative sequence ALT


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