taxopath.hpp

Go to the documentation of this file.

#ifndef GENESIS_TAXONOMY_TAXOPATH_H_
#define GENESIS_TAXONOMY_TAXOPATH_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 <functional>
#include <stdexcept>
#include <string>
#include <vector>

namespace genesis {
namespace taxonomy {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

class Taxon;
class Taxonomy;

// =================================================================================================
//     Taxopath
// =================================================================================================

class Taxopath
{
public:

    // -------------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------------

    typedef std::vector< std::string >::iterator               iterator;
    typedef std::vector< std::string >::const_iterator         const_iterator;
    typedef std::vector< std::string >::reverse_iterator       reverse_iterator;
    typedef std::vector< std::string >::const_reverse_iterator const_reverse_iterator;

    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------

    Taxopath()  = default;
    ~Taxopath() = default;

    explicit Taxopath( std::vector< std::string > const& elements )
        : elements_( elements )
    {}

    explicit Taxopath( std::vector< std::string > &&     elements )
        : elements_( std::move( elements ))
    {}


    Taxopath( Taxopath const& ) = default;
    Taxopath( Taxopath&& )      = default;

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

    void swap( Taxopath& other )
    {
        using std::swap;
        swap( elements_, other.elements_ );
    }

    // -------------------------------------------------------------------------
    //     Accessors
    // -------------------------------------------------------------------------

    bool empty() const
    {
        return elements_.empty();
    }

    size_t size() const
    {
        return elements_.size();
    }

    std::string const& at ( size_t index ) const
    {
        return elements_.at( index );
    }

    std::string& at ( size_t index )
    {
        return elements_.at( index );
    }

    std::string const& operator [] ( size_t index ) const
    {
        return elements_[ index ];
    }

    std::string& operator [] ( size_t index )
    {
        return elements_[ index ];
    }

    std::vector< std::string > const& elements() const
    {
        return elements_;
    }

    std::vector< std::string > & elements()
    {
        return elements_;
    }


    // -------------------------------------------------------------------------
    //     Modifiers
    // -------------------------------------------------------------------------

    void assign( std::vector< std::string > const& from )
    {
        elements_ = from;
    }

    void push_back( std::string const& value )
    {
        elements_.push_back( value );
    }

    void push_back( std::string&& value )
    {
        elements_.push_back( std::move( value ));
    }

    std::string pop_back()
    {
        if( elements_.empty() ) {
            throw std::out_of_range( "Cannot pop last element of empty Taxopath." );
        }
        auto last = elements_.back();
        elements_.pop_back();
        return last;
    }

    void clear()
    {
        elements_.clear();
    }

    // -------------------------------------------------------------------------
    //     Comparison
    // -------------------------------------------------------------------------

    friend bool operator == ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ == rhs.elements_;
    }

    friend bool operator != ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ != rhs.elements_;
    }

    friend bool operator < ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ < rhs.elements_;
    }

    friend bool operator <= ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ <= rhs.elements_;
    }

    friend bool operator > ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ > rhs.elements_;
    }

    friend bool operator >= ( Taxopath const & lhs, Taxopath const & rhs )
    {
        return lhs.elements_ >= rhs.elements_;
    }

    // -------------------------------------------------------------------------
    //     Iterators
    // -------------------------------------------------------------------------

    iterator begin()
    {
        return elements_.begin();
    }

    iterator end()
    {
        return elements_.end();
    }

    const_iterator begin() const
    {
        return elements_.cbegin();
    }

    const_iterator end() const
    {
        return elements_.cend();
    }

    reverse_iterator rbegin()
    {
        return elements_.rbegin();
    }

    reverse_iterator rend()
    {
        return elements_.rend();
    }

    const_reverse_iterator rbegin() const
    {
        return elements_.crbegin();
    }

    const_reverse_iterator rend() const
    {
        return elements_.crend();
    }

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

private:

    std::vector< std::string > elements_;
};

} // namespace taxonomy
} // namespace genesis

// ================================================================================================
//     Standard Hash Function
// ================================================================================================

namespace std
{
    template<>
    struct hash<genesis::taxonomy::Taxopath>
    {
        using argument_type = genesis::taxonomy::Taxopath;
        using result_type   = std::size_t;

        result_type operator()( argument_type const& t ) const {
            result_type result = 0;
            for( auto const& e : t ) {
                result ^= std::hash<std::string>{}( e );
            }
            return result;
        }
    };
}

#endif // include guard