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: www.phylosoft.org/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;
37 public class PostorderTreeIterator implements PhylogenyNodeIterator {
39 final private Phylogeny _tree;
40 final private PhylogenyNode _root;
41 private boolean _has_next;
42 final private Stack<PostOrderStackObject> _stack;
46 * Phylogeny for which a Iterator is to be constructed.
48 public PostorderTreeIterator( final Phylogeny tree ) throws IllegalArgumentException {
49 if ( tree.isEmpty() ) {
50 throw new IllegalArgumentException( "Attempt to use PostorderTreeIterator on an empty phylogeny." );
53 _root = getTree().getRoot();
54 _stack = new Stack<PostOrderStackObject>();
58 private PhylogenyNode getRoot() {
62 private Stack<PostOrderStackObject> getStack() {
66 private Phylogeny getTree() {
73 * @return DOCUMENT ME!
76 public boolean hasNext() {
81 * Advances the Iterator by one.
84 public PhylogenyNode next() throws NoSuchElementException {
86 throw new NoSuchElementException( "Attempt to call \"next()\" on iterator which has no more next elements." );
89 final PostOrderStackObject si = getStack().pop();
90 final PhylogenyNode node = si.getNode();
91 final int phase = si.getPhase();
92 // if ( node != null ) {
93 if ( phase > node.getNumberOfDescendants() ) {
94 setHasNext( node != getRoot() );
98 getStack().push( new PostOrderStackObject( node, ( phase + 1 ) ) );
99 if ( node.isInternal() ) {
100 getStack().push( new PostOrderStackObject( node.getChildNode( phase - 1 ), 1 ) );
103 // getStack().push( new PostOrderStackObject( null, 1 ) );
115 public void remove() {
116 throw new UnsupportedOperationException();
123 public void reset() {
126 getStack().push( new PostOrderStackObject( getTree().getRoot(), 1 ) );
129 private void setHasNext( final boolean has_next ) {
130 _has_next = has_next;
132 } // End of class PostorderTreeIterator.