EntropyTaxonData Class Reference

#include <genesis/taxonomy/functions/entropy_data.hpp>

Inherits BaseTaxonData.

Detailed Description

Definition at line 53 of file entropy_data.hpp.

Public Member Functions
	EntropyTaxonData (EntropyTaxonData &&)=delete
virtual	~EntropyTaxonData () override=default
virtual std::unique_ptr< BaseTaxonData >	clone () const override
	Polymorphically copy an instance of this class. Use instead of copy constructor. More...
EntropyTaxonData &	operator= (EntropyTaxonData &&)=delete
Public Member Functions inherited from BaseTaxonData
	BaseTaxonData (BaseTaxonData &&)=delete
	Deleted move constructor. More...
virtual	~BaseTaxonData ()=default
	Virtual destructor. Needed for polymorphism. More...
BaseTaxonData &	operator= (BaseTaxonData &&)=delete
	Deleted move assignment. More...

Static Public Member Functions
static std::unique_ptr< EntropyTaxonData >	create ()
static std::string	status_abbreviation (PruneStatus stat)
static std::string	status_text (PruneStatus stat)
Static Public Member Functions inherited from BaseTaxonData
static std::unique_ptr< BaseTaxonData >	create ()
	Create a new instance of this class. Use instead of default constructor. More...

Public Types
enum	PruneStatus { kInside, kBorder, kOutside }

Public Attributes
sequence::SiteCounts	counts
double	entropy = 0.0
PruneStatus	status = PruneStatus::kInside

Protected Member Functions
	EntropyTaxonData ()=default
	EntropyTaxonData (EntropyTaxonData const &)=default
EntropyTaxonData &	operator= (EntropyTaxonData const &)=default
Protected Member Functions inherited from BaseTaxonData
	BaseTaxonData ()=default
	Protected default constructor. Called from the create() function. More...
	BaseTaxonData (BaseTaxonData const &)=default
	Protected copy constructor. Called from the clone() function. More...
BaseTaxonData &	operator= (BaseTaxonData const &)=default
	Protected copy assignment. Not used right now. More...

Constructor & Destructor Documentation

~EntropyTaxonData()

virtual ~EntropyTaxonData ( )

overridevirtualdefault

EntropyTaxonData() [1/3]

EntropyTaxonData ( EntropyTaxonData &&  )

delete

EntropyTaxonData() [2/3]

EntropyTaxonData ( )

protecteddefault

EntropyTaxonData() [3/3]

EntropyTaxonData ( EntropyTaxonData const &  )

protecteddefault

Member Function Documentation

clone()

virtual std::unique_ptr< BaseTaxonData > clone ( ) const

inlineoverridevirtual

Polymorphically copy an instance of this class. Use instead of copy constructor.

Reimplemented from BaseTaxonData.

Definition at line 115 of file entropy_data.hpp.

create()

static std::unique_ptr< EntropyTaxonData > create ( )

inlinestatic

Definition at line 110 of file entropy_data.hpp.

operator=() [1/2]

EntropyTaxonData& operator= ( EntropyTaxonData &&  )

delete

operator=() [2/2]

EntropyTaxonData& operator= ( EntropyTaxonData const &  )

protecteddefault

status_abbreviation()

static std::string status_abbreviation ( PruneStatus  stat )

inlinestatic

Definition at line 78 of file entropy_data.hpp.

status_text()

static std::string status_text ( PruneStatus  stat )

inlinestatic

Definition at line 68 of file entropy_data.hpp.

Member Enumeration Documentation

PruneStatus

enum PruneStatus

strong

Enumerator
kInside
kBorder
kOutside

Definition at line 61 of file entropy_data.hpp.

Member Data Documentation

counts

sequence::SiteCounts counts

Definition at line 124 of file entropy_data.hpp.

entropy

double entropy = 0.0

Definition at line 125 of file entropy_data.hpp.

status

PruneStatus status = PruneStatus::kInside

Definition at line 126 of file entropy_data.hpp.

---

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

• entropy_data.hpp