function/tree_set.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_FUNCTION_TREE_SET_H_
#define GENESIS_TREE_FUNCTION_TREE_SET_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 Lucas Czech and HITS gGmbH

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include <functional>
#include <string>

namespace genesis {
namespace tree {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

class Tree;
class TreeNode;
class TreeEdge;
class TreeSet;

// =================================================================================================
//     Tree Set Functions
// =================================================================================================

Tree      * find_tree ( TreeSet      & tree_set, std::string const& name);

Tree const* find_tree ( TreeSet const& tree_set, std::string const& name);

// =================================================================================================
//     Comparators
// =================================================================================================

bool equal(
    TreeSet const& tree_set,
    std::function<bool( TreeNode const&, TreeNode const& )> node_comparator,
    std::function<bool( TreeEdge const&, TreeEdge const& )> edge_comparator
);

// /**
//  * @brief Compare whether all Tree%s in a TreeSet are equal using their default comparision
//  * operators for nodes and edges.
//  */
// bool all_equal( TreeSet const& tree_set );

bool identical_topology( TreeSet const& tree_set );

} // namespace tree
} // namespace genesis

#endif // include guard