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

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

Inherits NexusBlock.

Detailed Description

Definition at line 62 of file trees.hpp.

Public Member Functions

 NexusTrees ()=default
 
 NexusTrees (NexusTrees const &)=default
 
 NexusTrees (NexusTrees &&)=default
 
virtual ~NexusTrees () override=default
 
void add_tree (std::string const &name, std::string const &tree)
 
const_iterator begin () const
 
std::string block_name () const override
 
void clear ()
 
bool empty () const
 
const_iterator end () const
 
void erase_tree (std::string const &name)
 
bool has_tree (std::string const &name) const
 
NexusTreesoperator= (NexusTrees const &)=default
 
NexusTreesoperator= (NexusTrees &&)=default
 
size_t size () const
 
void swap (NexusTrees &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< Entry >
 

Classes

struct  Entry
 

Constructor & Destructor Documentation

◆ NexusTrees() [1/3]

NexusTrees ( )
default

◆ ~NexusTrees()

virtual ~NexusTrees ( )
overridevirtualdefault

◆ NexusTrees() [2/3]

NexusTrees ( NexusTrees const &  )
default

◆ NexusTrees() [3/3]

NexusTrees ( NexusTrees &&  )
default

Member Function Documentation

◆ add_tree()

void add_tree ( std::string const &  name,
std::string const &  tree 
)
inline

Definition at line 174 of file trees.hpp.

◆ begin()

const_iterator begin ( ) const
inline

Definition at line 158 of file trees.hpp.

◆ block_name()

std::string block_name ( ) const
inlineoverridevirtual

Implements NexusBlock.

Definition at line 212 of file trees.hpp.

◆ clear()

void clear ( )
inline

Definition at line 201 of file trees.hpp.

◆ empty()

bool empty ( ) const
inline

Definition at line 124 of file trees.hpp.

◆ end()

const_iterator end ( ) const
inline

Definition at line 163 of file trees.hpp.

◆ erase_tree()

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

Definition at line 191 of file trees.hpp.

◆ has_tree()

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

Definition at line 134 of file trees.hpp.

◆ operator=() [1/2]

NexusTrees& operator= ( NexusTrees const &  )
default

◆ operator=() [2/2]

NexusTrees& operator= ( NexusTrees &&  )
default

◆ size()

size_t size ( ) const
inline

Definition at line 129 of file trees.hpp.

◆ swap()

void swap ( NexusTrees other)
inline

Definition at line 96 of file trees.hpp.

◆ to_stream()

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

Implements NexusBlock.

Definition at line 217 of file trees.hpp.

Member Typedef Documentation

◆ const_iterator

using const_iterator = container::const_iterator

Definition at line 79 of file trees.hpp.

◆ container

using container = std::vector<Entry>

Definition at line 78 of file trees.hpp.


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