A toolkit for working with phylogenetic data.
v0.20.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NexusTaxa Class Reference

#include <genesis/utils/formats/nexus/taxa.hpp>

Inherits NexusBlock.

Detailed Description

Definition at line 60 of file taxa.hpp.

Public Member Functions

 NexusTaxa ()=default
 
 NexusTaxa (NexusTaxa const &)=default
 
 NexusTaxa (NexusTaxa &&)=default
 
 ~NexusTaxa ()=default
 
void add_taxa (std::unordered_set< std::string > taxa)
 
void add_taxon (std::string name)
 
const_iterator begin () const
 
std::string block_name () const override
 
void clear ()
 
bool empty () const
 
const_iterator end () const
 
void erase_taxon (std::string name)
 
bool has_taxon (std::string name) const
 
NexusTaxaoperator= (NexusTaxa const &)=default
 
NexusTaxaoperator= (NexusTaxa &&)=default
 
size_t size () const
 
void swap (NexusTaxa &other)
 
void to_stream (std::ostream &os) const override
 
- Public Member Functions inherited from NexusBlock
 NexusBlock ()=default
 
 NexusBlock (NexusBlock const &)=default
 
 NexusBlock (NexusBlock &&)=default
 
virtual ~NexusBlock ()=default
 
NexusBlockoperator= (NexusBlock const &)=default
 
NexusBlockoperator= (NexusBlock &&)=default
 

Public Types

using const_iterator = container::const_iterator
 
using container = std::unordered_set< std::string >
 

Friends

bool operator!= (NexusTaxa const &lhs, NexusTaxa const &rhs)
 
bool operator== (NexusTaxa const &lhs, NexusTaxa const &rhs)
 

Constructor & Destructor Documentation

NexusTaxa ( )
default
~NexusTaxa ( )
default
NexusTaxa ( NexusTaxa const &  )
default
NexusTaxa ( NexusTaxa &&  )
default

Member Function Documentation

void add_taxa ( std::unordered_set< std::string >  taxa)
inline

Definition at line 157 of file taxa.hpp.

void add_taxon ( std::string  name)
inline

Definition at line 152 of file taxa.hpp.

const_iterator begin ( ) const
inline

Definition at line 136 of file taxa.hpp.

std::string block_name ( ) const
inlineoverridevirtual

Implements NexusBlock.

Definition at line 178 of file taxa.hpp.

void clear ( )
inline

Definition at line 167 of file taxa.hpp.

bool empty ( ) const
inline

Definition at line 115 of file taxa.hpp.

const_iterator end ( ) const
inline

Definition at line 141 of file taxa.hpp.

void erase_taxon ( std::string  name)
inline

Definition at line 162 of file taxa.hpp.

bool has_taxon ( std::string  name) const
inline

Definition at line 125 of file taxa.hpp.

NexusTaxa& operator= ( NexusTaxa const &  )
default
NexusTaxa& operator= ( NexusTaxa &&  )
default
size_t size ( ) const
inline

Definition at line 120 of file taxa.hpp.

void swap ( NexusTaxa other)
inline

Definition at line 87 of file taxa.hpp.

void to_stream ( std::ostream &  os) const
inlineoverridevirtual

Implements NexusBlock.

Definition at line 183 of file taxa.hpp.

Friends And Related Function Documentation

bool operator!= ( NexusTaxa const &  lhs,
NexusTaxa const &  rhs 
)
friend

Definition at line 104 of file taxa.hpp.

bool operator== ( NexusTaxa const &  lhs,
NexusTaxa const &  rhs 
)
friend

Definition at line 99 of file taxa.hpp.

Member Typedef Documentation

using const_iterator = container::const_iterator

Definition at line 70 of file taxa.hpp.

using container = std::unordered_set<std::string>

Definition at line 69 of file taxa.hpp.


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