subtree.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_TREE_SUBTREE_H_
#define GENESIS_TREE_TREE_SUBTREE_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"

namespace genesis {
namespace tree {

// =============================================================================
//     Subtree
// =============================================================================

class Subtree
{
public:

    // -------------------------------------------------------------
    //     Declarations and Constructor
    // -------------------------------------------------------------

    // /* *
    //  * @ brief Default construct a subtree that does .
    //  */
    // Subtree() = default;

    explicit Subtree( TreeLink const& link )
        : link_( &link )
    {}

    explicit Subtree( TreeNode const& node )
        : link_( &node.primary_link() )
    {}

    Subtree( TreeEdge const& edge, bool use_primary = false )
        : link_( use_primary ? &edge.primary_link() : &edge.secondary_link() )
    {}

    ~Subtree() = default;

    Subtree( Subtree const& ) = default;
    Subtree( Subtree&& )      = default;

    Subtree& operator= ( Subtree const& ) = default;
    Subtree& operator= ( Subtree&& )      = default;

    // -------------------------------------------------------------
    //     Member Functions
    // -------------------------------------------------------------

    TreeLink const& link() const
    {
        return *link_;
    }

    TreeNode const& node() const
    {
        return link_->node();
    }

    TreeEdge const& edge() const
    {
        return link_->edge();
    }

    void invert()
    {
        link_ = &link_->outer();
    }

    // /**
    //  * @brief Return whether this subtree points to something, or was default constructed.
    //  */
    // operator bool() const
    // {
    //     return link_ == nullptr;
    // }

    // -------------------------------------------------------------
    //     Member Variables
    // -------------------------------------------------------------

protected:

    TreeLink const*  link_ = nullptr;

};

} // namespace tree
} // namespace genesis

#endif // include guard