tree/attribute_tree/tree.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_ATTRIBUTE_TREE_TREE_H_
#define GENESIS_TREE_ATTRIBUTE_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>
#include <string>

namespace genesis {
namespace tree {

// =================================================================================================
//     Typedefs
// =================================================================================================

using AttributeTree = Tree;

using AttributeTreeEdge = TreeEdge;

using AttributeTreeLink = TreeLink;

using AttributeTreeNode = TreeNode;

using AttributeTreeMap = std::map<std::string, std::string>;

// =================================================================================================
//     Attribute Tree Node Data
// =================================================================================================

class AttributeTreeNodeData : public CommonNodeData
{
public:

    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------

    virtual ~AttributeTreeNodeData() override = default;

    // Move ctor and assignment.
    AttributeTreeNodeData( AttributeTreeNodeData&& )             = delete;
    AttributeTreeNodeData& operator= ( AttributeTreeNodeData&& ) = delete;

protected:

    AttributeTreeNodeData() = default;

    // Copy ctor and assignment.
    AttributeTreeNodeData( AttributeTreeNodeData const& )             = default;
    AttributeTreeNodeData& operator= ( AttributeTreeNodeData const& ) = default;

public:

    static std::unique_ptr< AttributeTreeNodeData > create()
    {
        return std::unique_ptr< AttributeTreeNodeData >( new AttributeTreeNodeData() );
    }

    virtual std::unique_ptr< BaseNodeData > recreate() const override
    {
        return std::unique_ptr< AttributeTreeNodeData >( new AttributeTreeNodeData() );
    }

    virtual std::unique_ptr< BaseNodeData > clone() const override
    {
        return std::unique_ptr< AttributeTreeNodeData >( new AttributeTreeNodeData( *this ));
    }

    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------

    AttributeTreeMap attributes;

};

// =================================================================================================
//     Attribute Tree Edge Data
// =================================================================================================

class AttributeTreeEdgeData : public CommonEdgeData
{
public:

    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------

    virtual ~AttributeTreeEdgeData() override = default;

    // Move ctor and assignment.
    AttributeTreeEdgeData( AttributeTreeEdgeData&& )             = delete;
    AttributeTreeEdgeData& operator= ( AttributeTreeEdgeData&& ) = delete;

protected:

    AttributeTreeEdgeData() = default;

    // Copy ctor and assignment.
    AttributeTreeEdgeData( AttributeTreeEdgeData const& )             = default;
    AttributeTreeEdgeData& operator= ( AttributeTreeEdgeData const& ) = default;

public:

    static std::unique_ptr< AttributeTreeEdgeData > create()
    {
        return std::unique_ptr< AttributeTreeEdgeData >( new AttributeTreeEdgeData() );
    }

    virtual std::unique_ptr< BaseEdgeData > recreate() const override
    {
        return std::unique_ptr< AttributeTreeEdgeData >( new AttributeTreeEdgeData() );
    }

    virtual std::unique_ptr< BaseEdgeData > clone() const override
    {
        return std::unique_ptr< AttributeTreeEdgeData >( new AttributeTreeEdgeData( *this ));
    }

    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------

    AttributeTreeMap attributes;

};

// =================================================================================================
//     Common Converter
// =================================================================================================

inline AttributeTree convert_common_tree_to_attribute_tree( CommonTree const& source )
{
    return convert(
        source,
        [] ( tree::BaseNodeData const& node_data ) {
            auto attr_node = tree::AttributeTreeNodeData::create();
            auto const& orig_node = dynamic_cast< CommonNodeData const& >( node_data );
            attr_node->name = orig_node.name;

            return attr_node;
        },
        [] ( tree::BaseEdgeData const& edge_data ) {
            auto attr_edge = tree::AttributeTreeEdgeData::create();
            auto const& orig_edge = dynamic_cast< CommonEdgeData const& >( edge_data );
            attr_edge->branch_length = orig_edge.branch_length;

            return attr_edge;
        }
    );
}

} // namespace tree
} // namespace genesis

#endif // include guard