placement_tree.hpp

Go to the documentation of this file.

#ifndef GENESIS_PLACEMENT_PLACEMENT_TREE_H_
#define GENESIS_PLACEMENT_PLACEMENT_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 <string>
 
#include "genesis/tree/common_tree/tree.hpp"
#include "genesis/tree/tree.hpp"
 
namespace genesis {
namespace placement {
 
// =================================================================================================
//     Typedefs
// =================================================================================================
 
using PlacementTree = tree::Tree;
 
using PlacementTreeNode = tree::TreeNode;
 
using PlacementTreeEdge = tree::TreeEdge;
 
using PlacementTreeLink = tree::TreeLink;
 
// =================================================================================================
//     Placement Tree Node Data
// =================================================================================================
 
class PlacementNodeData : public tree::CommonNodeData
{
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------
 
public:
 
    virtual ~PlacementNodeData() override = default;
 
    // Move ctor and assignment.
    PlacementNodeData( PlacementNodeData&& )             = delete;
    PlacementNodeData& operator= ( PlacementNodeData&& ) = delete;
 
protected:
 
    PlacementNodeData() = default;
 
    // Copy ctor and assignment.
    PlacementNodeData( PlacementNodeData const& )             = default;
    PlacementNodeData& operator= ( PlacementNodeData const& ) = default;
 
public:
 
    static std::unique_ptr< PlacementNodeData > create()
    {
        return std::unique_ptr< PlacementNodeData >( new PlacementNodeData() );
    }
 
    virtual std::unique_ptr< BaseNodeData > recreate() const override
    {
        return std::unique_ptr< PlacementNodeData >( new PlacementNodeData() );
    }
 
    virtual std::unique_ptr< BaseNodeData > clone() const override
    {
        return std::unique_ptr< PlacementNodeData >( new PlacementNodeData( *this ));
    }
 
};
 
// =================================================================================================
//     Placement Tree Edge Data
// =================================================================================================
 
class PlacementEdgeData : public tree::CommonEdgeData
{
public:
 
    // -------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------
 
    using EdgeNumType = int;
 
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------
 
    virtual ~PlacementEdgeData() override = default;
 
    // Move ctor and assignment.
    PlacementEdgeData( PlacementEdgeData&& )             = delete;
    PlacementEdgeData& operator= ( PlacementEdgeData&& ) = delete;
 
protected:
 
    PlacementEdgeData() = default;
 
    // Copy ctor and assignment.
    PlacementEdgeData( PlacementEdgeData const& )             = default;
    PlacementEdgeData& operator= ( PlacementEdgeData const& ) = default;
 
public:
 
    static std::unique_ptr< PlacementEdgeData > create()
    {
        return std::unique_ptr< PlacementEdgeData >( new PlacementEdgeData() );
    }
 
    virtual std::unique_ptr< BaseEdgeData > recreate() const override
    {
        return std::unique_ptr< PlacementEdgeData >( new PlacementEdgeData() );
    }
 
    virtual std::unique_ptr< BaseEdgeData > clone() const override
    {
        return std::unique_ptr< PlacementEdgeData >( new PlacementEdgeData( *this ));
    }
 
    // -----------------------------------------------------
    //     Data Functions
    // -----------------------------------------------------
 
    EdgeNumType edge_num() const
    {
        return edge_num_;
    }
 
    void reset_edge_num( EdgeNumType val )
    {
        edge_num_ = val;
    }
 
    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------
 
private:
 
    EdgeNumType edge_num_;
};
 
} // namespace placement
} // namespace genesis
 
#endif // include guard