2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2008-2009 Christian M. Zmasek
6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 // Contact: phylosoft @ gmail . com
24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
26 package org.forester.phylogeny.iterators;
28 import java.util.NoSuchElementException;
29 import java.util.Stack;
31 import org.forester.phylogeny.Phylogeny;
32 import org.forester.phylogeny.PhylogenyNode;
34 public final class PreorderTreeIterator implements PhylogenyNodeIterator {
36 final private Phylogeny _tree;
37 final private Stack<PhylogenyNode> _stack;
41 * Phylogeny for which a Iterator is to be constructed.
43 public PreorderTreeIterator( final Phylogeny tree ) throws IllegalArgumentException {
44 if ( tree.isEmpty() ) {
45 throw new IllegalArgumentException( "Attempt to use PreorderTreeIterator on empty tree." );
47 _stack = new Stack<PhylogenyNode>();
52 public PreorderTreeIterator( final PhylogenyNode node ) throws IllegalArgumentException {
53 _stack = new Stack<PhylogenyNode>();
61 * @see java.util.Iterator#hasNext()
64 public final boolean hasNext() {
65 return !_stack.isEmpty();
69 * Advances the Iterator by one.
72 public final PhylogenyNode next() throws NoSuchElementException {
74 throw new NoSuchElementException( "Attempt to call \"next()\" on iterator which has no more next elements." );
76 final PhylogenyNode node = _stack.pop();
77 if ( !node.isExternal() ) {
78 for( int i = node.getNumberOfDescendants() - 1; i >= 0; --i ) {
79 _stack.push( node.getChildNode( i ) );
90 public final void remove() {
91 throw new UnsupportedOperationException();
95 public final void reset() {
97 _stack.push( _tree.getRoot() );
100 private final void reset( final PhylogenyNode node ) {