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

#include <genesis/tree/tree/link.hpp>

Detailed Description

Definition at line 51 of file link.hpp.

Public Member Functions

 TreeLink ()
 
 TreeLink (size_t index, TreeLink *next, TreeLink *outer, TreeNode *node, TreeEdge *edge)
 
 TreeLink (TreeLink const &)=delete
 
 TreeLink (TreeLink &&)=delete
 
 ~TreeLink ()=default
 
TreeEdgeedge ()
 Return the TreeEdge of this TreeLink. More...
 
TreeEdge const & edge () const
 Return the TreeEdge of this TreeLink. More...
 
size_t index () const
 Return the index of this Link. More...
 
TreeLinknext ()
 Return the next TreeLink within the TreeNode of this link. More...
 
TreeLink const & next () const
 Return the next TreeLink within the TreeNode of this link. More...
 
TreeNodenode ()
 Return the TreeNode of this TreeLink. More...
 
TreeNode const & node () const
 Return the TreeNode of this TreeLink. More...
 
TreeLinkoperator= (TreeLink const &)=delete
 
TreeLinkoperator= (TreeLink &&)=delete
 
TreeLinkouter ()
 Return the TreeLink of the adjacent TreeNode. More...
 
TreeLink const & outer () const
 Return the TreeLink of the adjacent TreeNode. More...
 
TreeLinkprev ()
 Return the previous TreeLink within the TreeNode of this link. More...
 
TreeLink const & prev () const
 Return the previous TreeLink within the TreeNode of this link. More...
 
TreeLinkreset_edge (TreeEdge *val)
 Reset the internal pointer to the TreeEdge of this TreeLink. More...
 
TreeLinkreset_index (size_t val)
 Reset the internal index of this TreeLink. More...
 
TreeLinkreset_next (TreeLink *val)
 Reset the internal pointer to the next TreeLink of this TreeLink. More...
 
TreeLinkreset_node (TreeNode *val)
 Reset the internal pointer to the TreeNode of this TreeLink. More...
 
TreeLinkreset_outer (TreeLink *val)
 Reset the internal pointer to the outer TreeLink of this TreeLink. More...
 

Friends

class Tree
 

Constructor & Destructor Documentation

TreeLink ( )
inline

Definition at line 65 of file link.hpp.

TreeLink ( size_t  index,
TreeLink next,
TreeLink outer,
TreeNode node,
TreeEdge edge 
)
inline

Definition at line 73 of file link.hpp.

~TreeLink ( )
default
TreeLink ( TreeLink const &  )
delete
TreeLink ( TreeLink &&  )
delete

Member Function Documentation

TreeEdge& edge ( )
inline

Return the TreeEdge of this TreeLink.

Definition at line 169 of file link.hpp.

TreeEdge const& edge ( ) const
inline

Return the TreeEdge of this TreeLink.

Definition at line 177 of file link.hpp.

size_t index ( ) const
inline

Return the index of this Link.

Definition at line 99 of file link.hpp.

TreeLink& next ( )
inline

Return the next TreeLink within the TreeNode of this link.

Definition at line 107 of file link.hpp.

TreeLink const& next ( ) const
inline

Return the next TreeLink within the TreeNode of this link.

Definition at line 115 of file link.hpp.

TreeNode& node ( )
inline

Return the TreeNode of this TreeLink.

Definition at line 185 of file link.hpp.

TreeNode const& node ( ) const
inline

Return the TreeNode of this TreeLink.

Definition at line 193 of file link.hpp.

TreeLink& operator= ( TreeLink const &  )
delete
TreeLink& operator= ( TreeLink &&  )
delete
TreeLink& outer ( )
inline

Return the TreeLink of the adjacent TreeNode.

Definition at line 153 of file link.hpp.

TreeLink const& outer ( ) const
inline

Return the TreeLink of the adjacent TreeNode.

Definition at line 161 of file link.hpp.

TreeLink& prev ( )
inline

Return the previous TreeLink within the TreeNode of this link.

The previous link of a given link L is the one whose next-pointer is pointing to L. As this link first has to be found, this function is not as cheap as next().

Definition at line 126 of file link.hpp.

TreeLink const& prev ( ) const
inline

Return the previous TreeLink within the TreeNode of this link.

The previous link of a given link L is the one whose next-pointer is pointing to L. As this link first has to be found, this function is not as cheap as next().

Definition at line 141 of file link.hpp.

TreeLink& reset_edge ( TreeEdge val)
inline

Reset the internal pointer to the TreeEdge of this TreeLink.

This is a helper function that needs to be used with care and only in cases where appropriate.

This function exists to allow building and modifying a Tree without the need for many friend declarations. However, the function should rarely be needed outside of this context.

Definition at line 268 of file link.hpp.

TreeLink& reset_index ( size_t  val)
inline

Reset the internal index of this TreeLink.

This is a helper function that needs to be used with care and only in cases where appropriate. The index is an invariant that needs to be kept, as it needs to match the index in the Tree container.

This function exists to allow building and modifying a Tree without the need for many friend declarations. However, the function should rarely be needed outside of this context.

Definition at line 212 of file link.hpp.

TreeLink& reset_next ( TreeLink val)
inline

Reset the internal pointer to the next TreeLink of this TreeLink.

This is a helper function that needs to be used with care and only in cases where appropriate.

This function exists to allow building and modifying a Tree without the need for many friend declarations. However, the function should rarely be needed outside of this context.

Definition at line 226 of file link.hpp.

TreeLink& reset_node ( TreeNode val)
inline

Reset the internal pointer to the TreeNode of this TreeLink.

This is a helper function that needs to be used with care and only in cases where appropriate.

This function exists to allow building and modifying a Tree without the need for many friend declarations. However, the function should rarely be needed outside of this context.

Definition at line 254 of file link.hpp.

TreeLink& reset_outer ( TreeLink val)
inline

Reset the internal pointer to the outer TreeLink of this TreeLink.

This is a helper function that needs to be used with care and only in cases where appropriate.

This function exists to allow building and modifying a Tree without the need for many friend declarations. However, the function should rarely be needed outside of this context.

Definition at line 240 of file link.hpp.

Friends And Related Function Documentation

friend class Tree
friend

Definition at line 59 of file link.hpp.


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