Template Class tree_visitor

Class Documentation

template<typename TableCollectionType>
class fwdpp::ts::tree_visitor

Class that iterates over marginal trees.

Note

This class declares private data whose integrity are tied to the lifetime of the table_collection used to construct a tree_visitor!

Version

0.7.0 Added to fwdpp

Version

0.7.4 Updates tree roots during traversal.

Public Functions

template<typename SAMPLES>
tree_visitor(const TableCollectionType &tables, SAMPLES &&samples, update_samples_list update)
tree_visitor(const TableCollectionType &tables, const std::vector<table_index_t> &samples, const std::vector<table_index_t> &preserved_nodes, update_samples_list update)
const marginal_tree &tree() const

Returns a handle to the current tree.

// Copy-free "view" of
// the stored fwdpp::ts::marginal_tree
auto & tree = tv.tree();
Return

const reference to the current tree.

bool operator()()