taxonomy/iterator/levelorder.hpp

Go to the documentation of this file.

#ifndef GENESIS_TAXONOMY_ITERATOR_LEVELORDER_H_
#define GENESIS_TAXONOMY_ITERATOR_LEVELORDER_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 Lucas Czech
 
    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/taxonomy/taxonomy.hpp"
#include "genesis/taxonomy/taxon.hpp"
#include "genesis/utils/containers/range.hpp"
 
#include <functional>
#include <queue>
 
namespace genesis {
namespace taxonomy {
 
// =================================================================================================
//     Levelorder For Each
// =================================================================================================
 
inline void levelorder_for_each(
    Taxonomy& tax,
    std::function< void( Taxon& )> fn,
    bool include_inner_taxa = true
) {
    std::queue< Taxon* > taxa_queue;
    for( auto& t : tax ) {
        taxa_queue.push( &t );
    }
 
    while( ! taxa_queue.empty() ) {
        auto& cur = *taxa_queue.front();
 
        if( include_inner_taxa || cur.size() == 0 ) {
            fn( cur );
        }
 
        for( auto& t : cur ) {
            taxa_queue.push( &t );
        }
        taxa_queue.pop();
    }
}
 
inline void levelorder_for_each(
    Taxonomy const& tax,
    std::function< void( Taxon const& )> fn,
    bool include_inner_taxa = true
) {
    std::queue< Taxon const* > taxa_queue;
    for( auto& t : tax ) {
        taxa_queue.push( &t );
    }
 
    while( ! taxa_queue.empty() ) {
        auto const& cur = *taxa_queue.front();
 
        if( include_inner_taxa || cur.size() == 0 ) {
            fn( cur );
        }
 
        for( auto const& t : cur ) {
            taxa_queue.push( &t );
        }
        taxa_queue.pop();
    }
}
 
} // namespace taxonomy
} // namespace genesis
 
#endif // include guard