element.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_FORMATS_NEWICK_ELEMENT_H_
#define GENESIS_TREE_FORMATS_NEWICK_ELEMENT_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 <stdexcept>
#include <string>
#include <vector>
 
namespace genesis {
namespace tree {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class NewickBroker;
 
// =================================================================================================
//     NewickBrokerElement
// =================================================================================================
 
struct NewickBrokerElement
{
    friend NewickBroker;
 
    // -------------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------------
 
public:
 
    NewickBrokerElement()
        : depth( -1 )
        , rank_( -1 )
    {}
 
    explicit NewickBrokerElement( long depth )
        : depth( depth )
        , rank_( -1 )
    {}
 
    NewickBrokerElement( std::string const& name, long depth )
        : name( name )
        , depth( depth )
        , rank_( -1 )
    {}
 
    ~NewickBrokerElement() = default;
 
    NewickBrokerElement(NewickBrokerElement const&) = default;
    NewickBrokerElement(NewickBrokerElement&&)      = default;
 
    NewickBrokerElement& operator= (NewickBrokerElement const&) = default;
    NewickBrokerElement& operator= (NewickBrokerElement&&)      = default;
 
    // -------------------------------------------------------------------------
    //     Public Data Members
    // -------------------------------------------------------------------------
 
    std::string name;
 
    std::vector<std::string> values;
 
    std::vector<std::string> tags;
 
    std::vector<std::string> comments;
 
    long depth;
 
    // -------------------------------------------------------------------------
    //     Additional Members
    // -------------------------------------------------------------------------
 
    long rank() const
    {
        if (rank_ < 0) {
            throw std::logic_error("NewickBroker::assign_ranks() was not called before.");
        }
        return rank_;
    }
 
    bool is_root() const
    {
        return depth == 0;
    }
 
    bool is_leaf() const
    {
        if (rank_ < 0) {
            throw std::logic_error("NewickBroker::is_leaf() was not called before.");
        }
        return rank_ == 0;
    }
 
    bool is_inner() const
    {
        if (rank_ < 0) {
            throw std::logic_error("NewickBroker::is_leaf() was not called before.");
        }
        return rank_ != 0;
    }
 
private:
 
    mutable long rank_;
};
 
} // namespace tree
} // namespace genesis
 
#endif // include guard