A toolkit for working with phylogenetic data.
v0.24.0
NexusTaxa Class Reference

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

Inherits NexusBlock.

Detailed Description

Definition at line 61 of file taxa.hpp.

Public Member Functions

 NexusTaxa ()=default
 
 NexusTaxa (NexusTaxa const &)=default
 
 NexusTaxa (NexusTaxa &&)=default
 
virtual ~NexusTaxa () override=default
 
void add_taxa (std::vector< std::string > const &taxa)
 
void add_taxon (std::string const &name)
 
const_iterator begin () const
 
std::string block_name () const override
 
void clear ()
 
bool empty () const
 
const_iterator end () const
 
bool has_taxon (std::string const &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::vector< std::string >
 

Friends

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

Constructor & Destructor Documentation

◆ NexusTaxa() [1/3]

NexusTaxa ( )
default

◆ ~NexusTaxa()

virtual ~NexusTaxa ( )
overridevirtualdefault

◆ NexusTaxa() [2/3]

NexusTaxa ( NexusTaxa const &  )
default

◆ NexusTaxa() [3/3]

NexusTaxa ( NexusTaxa &&  )
default

Member Function Documentation

◆ add_taxa()

void add_taxa ( std::vector< std::string > const &  taxa)
inline

Definition at line 158 of file taxa.hpp.

◆ add_taxon()

void add_taxon ( std::string const &  name)
inline

Definition at line 153 of file taxa.hpp.

◆ begin()

const_iterator begin ( ) const
inline

Definition at line 137 of file taxa.hpp.

◆ block_name()

std::string block_name ( ) const
inlineoverridevirtual

Implements NexusBlock.

Definition at line 180 of file taxa.hpp.

◆ clear()

void clear ( )
inline

Definition at line 169 of file taxa.hpp.

◆ empty()

bool empty ( ) const
inline

Definition at line 116 of file taxa.hpp.

◆ end()

const_iterator end ( ) const
inline

Definition at line 142 of file taxa.hpp.

◆ has_taxon()

bool has_taxon ( std::string const &  name) const
inline

Definition at line 126 of file taxa.hpp.

◆ operator=() [1/2]

NexusTaxa& operator= ( NexusTaxa const &  )
default

◆ operator=() [2/2]

NexusTaxa& operator= ( NexusTaxa &&  )
default

◆ size()

size_t size ( ) const
inline

Definition at line 121 of file taxa.hpp.

◆ swap()

void swap ( NexusTaxa other)
inline

Definition at line 88 of file taxa.hpp.

◆ to_stream()

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

Implements NexusBlock.

Definition at line 185 of file taxa.hpp.

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 105 of file taxa.hpp.

◆ operator==

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

Definition at line 100 of file taxa.hpp.

Member Typedef Documentation

◆ const_iterator

using const_iterator = container::const_iterator

Definition at line 71 of file taxa.hpp.

◆ container

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

Definition at line 70 of file taxa.hpp.


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