The BiAlleleMonolocusGenotype class. More...

#include <Bpp/PopGen/BiAlleleMonolocusGenotype.h>

Inheritance diagram for bpp::BiAlleleMonolocusGenotype:

Collaboration diagram for bpp::BiAlleleMonolocusGenotype:

Public Member Functions
	BiAlleleMonolocusGenotype (size_t firstAlleleIndex, size_t secondAlleleIndex)
	Build a monolocus genotype containing two alleles. More...

	BiAlleleMonolocusGenotype (std::vector< size_t > alleleIndex)
	Build a monolocus genotype containing two alleles. More...

	BiAlleleMonolocusGenotype (const BiAlleleMonolocusGenotype &bmg)
	Copy constructor. More...

virtual	~BiAlleleMonolocusGenotype ()
	Destroy the BiAlleleMonolocusGenotype. More...

BiAlleleMonolocusGenotype &	operator= (const BiAlleleMonolocusGenotype &bmg)
	The affectation operator. More...

bool	operator== (const BiAlleleMonolocusGenotype &bmg) const
	The == operator. More...

size_t	getFirstAlleleIndex () const
	Get the first allele index. More...

size_t	getSecondAlleleIndex () const
	Get the second allele index. More...

bool	isHomozygous () const
	Test the homozygozity of the locus. More...

The MonolocusGenotype interface:
std::vector< size_t >	getAlleleIndex () const override
	Get the alleles' index. More...

The Clonable interface:
BiAlleleMonolocusGenotype *	clone () const override

Private Attributes
std::vector< size_t >	alleleIndex_

Detailed Description

The BiAlleleMonolocusGenotype class.

Author: Sylvain Gaillard

Definition at line 24 of file BiAlleleMonolocusGenotype.h.

Constructor & Destructor Documentation

◆ BiAlleleMonolocusGenotype() [1/3]

BiAlleleMonolocusGenotype::BiAlleleMonolocusGenotype	(	size_t	firstAlleleIndex,
		size_t	secondAlleleIndex
	)

Build a monolocus genotype containing two alleles.

Definition at line 12 of file BiAlleleMonolocusGenotype.cpp.

References alleleIndex_.

Referenced by clone().

◆ BiAlleleMonolocusGenotype() [2/3]

BiAlleleMonolocusGenotype::BiAlleleMonolocusGenotype ( std::vector< size_t > alleleIndex )

Build a monolocus genotype containing two alleles.

Definition at line 20 of file BiAlleleMonolocusGenotype.cpp.

References alleleIndex_.

◆ BiAlleleMonolocusGenotype() [3/3]

BiAlleleMonolocusGenotype::BiAlleleMonolocusGenotype ( const BiAlleleMonolocusGenotype & bmg )

Copy constructor.

Definition at line 29 of file BiAlleleMonolocusGenotype.cpp.

References alleleIndex_, and getAlleleIndex().

◆ ~BiAlleleMonolocusGenotype()

BiAlleleMonolocusGenotype::~BiAlleleMonolocusGenotype ( )

virtual

Destroy the BiAlleleMonolocusGenotype.

Definition at line 40 of file BiAlleleMonolocusGenotype.cpp.

References alleleIndex_.

Member Function Documentation

◆ clone()

BiAlleleMonolocusGenotype* bpp::BiAlleleMonolocusGenotype::clone ( ) const

inlineoverridevirtual

Implements bpp::MonolocusGenotypeInterface.

Definition at line 105 of file BiAlleleMonolocusGenotype.h.

References BiAlleleMonolocusGenotype().

◆ getAlleleIndex()

std::vector<size_t> bpp::BiAlleleMonolocusGenotype::getAlleleIndex ( ) const

inlineoverridevirtual

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.