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-2018 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 <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 );
    explicit Taxopath( std::vector< std::string > &&     elements );

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

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

    void swap( Taxopath& other );

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

    bool empty() const;
    size_t size() const;

    std::string const& at ( size_t index ) const;
    std::string&       at ( size_t index );

    std::string const& operator [] ( size_t index ) const;
    std::string&       operator [] ( size_t index );

    std::vector< std::string > const& elements() const;
    std::vector< std::string > &      elements();

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

    void assign( std::vector< std::string > const& from );

    void push_back( std::string const& value );
    void push_back( std::string&& value );

    std::string pop_back();

    void clear();

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

    iterator begin();
    iterator end();

    const_iterator begin() const;
    const_iterator end() const;

    reverse_iterator rbegin();
    reverse_iterator rend();

    const_reverse_iterator rbegin() const;
    const_reverse_iterator rend() const;

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

private:

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

} // namespace taxonomy
} // namespace genesis

#endif // include guard