bpp-popgen  2.2.0
bpp::MonolocusGenotype Class Referenceabstract

The MonolocusGenotype virtual class. More...

#include <Bpp/PopGen/MonolocusGenotype.h>

+ Inheritance diagram for bpp::MonolocusGenotype:
+ Collaboration diagram for bpp::MonolocusGenotype:

Public Member Functions

virtual ~MonolocusGenotype ()
 Destroy a MonolocusGenotype. More...
 
virtual std::vector< size_t > getAlleleIndex () const =0
 Get the alleles' index. More...
 

Detailed Description

The MonolocusGenotype virtual class.

A MonolocusGenotype containes the Alleles' keys defined in a Locus object. This keys are returned as size_tegers. This class is an interface for all monolocus genotypes.

Author
Sylvain Gaillard

Definition at line 59 of file MonolocusGenotype.h.

Constructor & Destructor Documentation

◆ ~MonolocusGenotype()

virtual bpp::MonolocusGenotype::~MonolocusGenotype ( )
inlinevirtual

Destroy a MonolocusGenotype.

Definition at line 67 of file MonolocusGenotype.h.

Member Function Documentation

◆ getAlleleIndex()

virtual std::vector<size_t> bpp::MonolocusGenotype::getAlleleIndex ( ) const
pure virtual

Get the alleles' index.

The alleles' index are the position of the AlleleInfo in a LocusInfo object. If no LocusInfo is used, the index are just numbers to identify the alleles.

Returns
A vector of size_t.

The size of the vector corresponds to the number of alleles at this locus.

Implemented in bpp::BiAlleleMonolocusGenotype, bpp::MultiAlleleMonolocusGenotype, and bpp::MonoAlleleMonolocusGenotype.

Referenced by bpp::MultilocusGenotypeStatistics::countHeterozygousForGroups(), bpp::MultilocusGenotypeStatistics::getHeterozygousFrqForGroups(), bpp::PolymorphismMultiGContainerTools::permutAlleles(), bpp::PolymorphismMultiGContainerTools::permutIntraGroupAlleles(), bpp::DarwinVarSingle::write(), and bpp::PopgenlibIO::write().


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