jade::basic_tree_path< TValue > Class Template Reference

A template for a class that maintains a table of nodes indicating a distance to the root of the tree. More...

#include <jade.tree_path.hpp>

Inheritance diagram for jade::basic_tree_path< TValue >:

Collaboration diagram for jade::basic_tree_path< TValue >:

Public Types
typedef TValue	value_type
	The value type. More...
typedef basic_newick_node< value_type >	node_type
	The Newick node type. More...

Public Member Functions
	basic_tree_path (const node_type &node)
	Initializes a new instance of the class by computing the set of nodes in the path to the root. The specified node is included in the result, but the root node is not. For example, computing a tree path for node 'D' for the tree, "((B:2,(C:4,D:5)n1:3)n2:1)A;" results in the container (D, n1, n2). More...
value_type	get_length () const
basic_tree_path	operator& (const basic_tree_path &rhs) const
	Computes the overlapped tree path of this instance and another instance. This method returns only the nodes that exist in both containers. More...

Detailed Description

template<typename TValue>
class jade::basic_tree_path< TValue >

A template for a class that maintains a table of nodes indicating a distance to the root of the tree.

Definition at line 19 of file jade.tree_path.hpp.

Member Typedef Documentation

node_type

template<typename TValue >

typedef basic_newick_node<value_type> jade::basic_tree_path< TValue >::node_type

The Newick node type.

Definition at line 26 of file jade.tree_path.hpp.

value_type

template<typename TValue >

typedef TValue jade::basic_tree_path< TValue >::value_type

The value type.

Definition at line 23 of file jade.tree_path.hpp.

Constructor & Destructor Documentation

basic_tree_path()

template<typename TValue >

jade::basic_tree_path< TValue >::basic_tree_path ( const node_type &  node )

inlineexplicit

Initializes a new instance of the class by computing the set of nodes in the path to the root. The specified node is included in the result, but the root node is not. For example, computing a tree path for node 'D' for the tree, "((B:2,(C:4,D:5)n1:3)n2:1)A;" results in the container (D, n1, n2).

Parameters

node	The node to measure.

Definition at line 43 of file jade.tree_path.hpp.

            : _map ()
        {
            //
            // Loop toward the root node, starting at the specified node, but
            // do not include the root node in the result; in each iteration,
            // accumulate the nodes traversed.
            //
            for (auto n = &node; !n->is_root(); n = n->get_parent())
                _map[n->get_id()] = n;
        }

Member Function Documentation

get_length()

template<typename TValue >

value_type jade::basic_tree_path< TValue >::get_length ( ) const

inline

Returns

The sum of the lengths for all nodes of this instance.

Definition at line 59 of file jade.tree_path.hpp.

        {
            auto sum = value_type(0);
            for (const auto & pair : _map)
                sum += pair.second->get_length();
            return sum;
        }

Here is the caller graph for this function:

operator&()

template<typename TValue >

basic_tree_path jade::basic_tree_path< TValue >::operator& ( const basic_tree_path< TValue > &  rhs ) const

inline

Computes the overlapped tree path of this instance and another instance. This method returns only the nodes that exist in both containers.

Returns

A new tree path.

Parameters

rhs	The other tree path.

Definition at line 74 of file jade.tree_path.hpp.

        {
            basic_tree_path p;
 
            for (const auto & pair: rhs._map)
                if (_map.find(pair.first) != _map.end())
                    p._map[pair.first] = pair.second;
 
            return p;
        }

---

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

• jade.tree_path.hpp