tree/mass_tree/tree.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_MASS_TREE_TREE_H_
#define GENESIS_TREE_MASS_TREE_TREE_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 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 "genesis/tree/tree.hpp"
#include "genesis/tree/common_tree/tree.hpp"
#include "genesis/tree/function/operators.hpp"
 
#include <map>
 
namespace genesis {
namespace tree {
 
// =================================================================================================
//     Typedefs
// =================================================================================================
 
using MassTree = Tree;
 
using MassTreeEdge = TreeEdge;
 
using MassTreeLink = TreeLink;
 
using MassTreeNode = TreeNode;
 
// =================================================================================================
//     Mass Tree Node Data
// =================================================================================================
 
class MassTreeNodeData : public CommonNodeData
{
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------
 
public:
 
    virtual ~MassTreeNodeData() override = default;
 
    // Move ctor and assignment.
    MassTreeNodeData( MassTreeNodeData&& )             = delete;
    MassTreeNodeData& operator= ( MassTreeNodeData&& ) = delete;
 
protected:
 
    MassTreeNodeData() = default;
 
    // Copy ctor and assignment.
    MassTreeNodeData( MassTreeNodeData const& )             = default;
    MassTreeNodeData& operator= ( MassTreeNodeData const& ) = default;
 
public:
 
    static std::unique_ptr< MassTreeNodeData > create()
    {
        return std::unique_ptr< MassTreeNodeData >( new MassTreeNodeData() );
    }
 
    virtual std::unique_ptr< BaseNodeData > recreate() const override
    {
        return std::unique_ptr< MassTreeNodeData >( new MassTreeNodeData() );
    }
 
    virtual std::unique_ptr< BaseNodeData > clone() const override
    {
        return std::unique_ptr< MassTreeNodeData >( new MassTreeNodeData( *this ));
    }
 
};
 
// =================================================================================================
//     Mass Tree Edge Data
// =================================================================================================
 
class MassTreeEdgeData : public CommonEdgeData
{
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------
 
public:
 
    virtual ~MassTreeEdgeData() override = default;
 
    // Move ctor and assignment.
    MassTreeEdgeData( MassTreeEdgeData&& )             = delete;
    MassTreeEdgeData& operator= ( MassTreeEdgeData&& ) = delete;
 
protected:
 
    MassTreeEdgeData() = default;
 
    // Copy ctor and assignment.
    MassTreeEdgeData( MassTreeEdgeData const& )             = default;
    MassTreeEdgeData& operator= ( MassTreeEdgeData const& ) = default;
 
public:
 
    static std::unique_ptr< MassTreeEdgeData > create()
    {
        return std::unique_ptr< MassTreeEdgeData >( new MassTreeEdgeData() );
    }
 
    virtual std::unique_ptr< BaseEdgeData > recreate() const override
    {
        return std::unique_ptr< MassTreeEdgeData >( new MassTreeEdgeData() );
    }
 
    virtual std::unique_ptr< BaseEdgeData > clone() const override
    {
        return std::unique_ptr< MassTreeEdgeData >( new MassTreeEdgeData( *this ));
    }
 
    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------
 
    std::map<double, double> masses;
 
};
 
// =================================================================================================
//     Common Converter
// =================================================================================================
 
inline MassTree convert_common_tree_to_mass_tree( CommonTree const& source )
{
    return convert(
        source,
        [] ( tree::BaseNodeData const& node_data ) {
            auto mass_node = tree::MassTreeNodeData::create();
            auto const& orig_node = dynamic_cast< CommonNodeData const& >( node_data );
            mass_node->name = orig_node.name;
 
            return mass_node;
        },
        [] ( tree::BaseEdgeData const& edge_data ) {
            auto mass_edge = tree::MassTreeEdgeData::create();
            auto const& orig_edge = dynamic_cast< CommonEdgeData const& >( edge_data );
            mass_edge->branch_length = orig_edge.branch_length;
 
            return mass_edge;
        }
    );
}
 
} // namespace tree
} // namespace genesis
 
#endif // include guard