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
7 // Copyright (C) 2000-2001 Washington University School of Medicine
8 // and Howard Hughes Medical Institute
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
21 // You should have received a copy of the GNU Lesser General Public
22 // License along with this library; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 // Contact: phylosoft @ gmail . com
26 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
28 package org.forester.phylogeny;
30 import java.io.IOException;
31 import java.util.ArrayList;
32 import java.util.Arrays;
33 import java.util.Collection;
34 import java.util.HashMap;
35 import java.util.Iterator;
36 import java.util.List;
38 import java.util.NoSuchElementException;
39 import java.util.Vector;
41 import org.forester.io.parsers.nhx.NHXParser;
42 import org.forester.io.writers.PhylogenyWriter;
43 import org.forester.phylogeny.PhylogenyNode.NH_CONVERSION_SUPPORT_VALUE_STYLE;
44 import org.forester.phylogeny.data.BranchData;
45 import org.forester.phylogeny.data.Confidence;
46 import org.forester.phylogeny.data.Identifier;
47 import org.forester.phylogeny.data.PhylogenyDataUtil;
48 import org.forester.phylogeny.data.Sequence;
49 import org.forester.phylogeny.data.SequenceRelation;
50 import org.forester.phylogeny.data.SequenceRelation.SEQUENCE_RELATION_TYPE;
51 import org.forester.phylogeny.factories.ParserBasedPhylogenyFactory;
52 import org.forester.phylogeny.factories.PhylogenyFactory;
53 import org.forester.phylogeny.iterators.ExternalForwardIterator;
54 import org.forester.phylogeny.iterators.LevelOrderTreeIterator;
55 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
56 import org.forester.phylogeny.iterators.PostorderTreeIterator;
57 import org.forester.phylogeny.iterators.PreorderTreeIterator;
58 import org.forester.util.FailedConditionCheckException;
59 import org.forester.util.ForesterUtil;
61 public class Phylogeny {
63 public final static boolean ALLOW_MULTIPLE_PARENTS_DEFAULT = false;
64 private PhylogenyNode _root;
65 private boolean _rooted;
66 private boolean _allow_multiple_parents;
69 private String _description;
70 private String _distance_unit;
71 private Confidence _confidence;
72 private Identifier _identifier;
73 private boolean _rerootable;
74 private HashMap<Long, PhylogenyNode> _id_to_node_map;
75 private List<PhylogenyNode> _external_nodes_set;
76 private Collection<Sequence> _sequenceRelationQueries;
77 private Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> _relevant_sequence_relation_types;
80 * Default Phylogeny constructor. Constructs an empty Phylogeny.
87 * Adds this Phylogeny to the list of child nodes of PhylogenyNode parent
88 * and sets the parent of this to parent.
91 * the PhylogenyNode to add
93 public void addAsChild( final PhylogenyNode parent ) {
95 throw new IllegalArgumentException( "Attempt to add an empty tree." );
98 throw new IllegalArgumentException( "Attempt to add an unrooted tree." );
100 parent.addAsChild( getRoot() );
101 externalNodesHaveChanged();
104 public void addAsSibling( final PhylogenyNode sibling ) {
106 throw new IllegalArgumentException( "Attempt to add an empty tree." );
109 throw new IllegalArgumentException( "Attempt to add an unrooted tree." );
111 final int sibling_index = sibling.getChildNodeIndex();
112 final PhylogenyNode new_node = new PhylogenyNode();
113 final PhylogenyNode sibling_parent = sibling.getParent();
114 new_node.setChild1( sibling );
115 new_node.setChild2( getRoot() );
116 new_node.setParent( sibling_parent );
117 sibling.setParent( new_node );
118 sibling_parent.setChildNode( sibling_index, new_node );
119 final double new_dist = sibling.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ? PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT
120 : sibling.getDistanceToParent() / 2;
121 new_node.setDistanceToParent( new_dist );
122 sibling.setDistanceToParent( new_dist );
123 externalNodesHaveChanged();
127 * This calculates the height of the subtree emanating at n for rooted,
128 * tree-shaped phylogenies
131 * the root-node of a subtree
132 * @return the height of the subtree emanating at n
134 public double calculateSubtreeHeight( final PhylogenyNode n ) {
135 if ( n.isExternal() || n.isCollapse() ) {
136 return ForesterUtil.isLargerOrEqualToZero( n.getDistanceToParent() );
139 double max = -Double.MAX_VALUE;
140 for( int i = 0; i < n.getNumberOfDescendants(); ++i ) {
141 final double l = calculateSubtreeHeight( n.getChildNode( i ) );
146 return max + ForesterUtil.isLargerOrEqualToZero( n.getDistanceToParent() );
150 public void clearHashIdToNodeMap() {
151 setIdToNodeMap( null );
155 * Returns a deep copy of this Phylogeny.
157 * (The resulting Phylogeny has its references in the external nodes
158 * corrected, if they are lacking/obsolete in this.)
160 public Phylogeny copy() {
161 return copy( _root );
165 * Returns a deep copy of this Phylogeny.
167 * (The resulting Phylogeny has its references in the external nodes
168 * corrected, if they are lacking/obsolete in this.)
170 public Phylogeny copy( final PhylogenyNode source ) {
171 final Phylogeny tree = new Phylogeny();
176 tree._rooted = _rooted;
177 tree._name = new String( _name );
178 tree._description = new String( _description );
179 tree._type = new String( _type );
180 tree._rerootable = _rerootable;
181 tree._distance_unit = new String( _distance_unit );
182 if ( _confidence != null ) {
183 tree._confidence = ( Confidence ) _confidence.copy();
185 if ( _identifier != null ) {
186 tree._identifier = ( Identifier ) _identifier.copy();
188 tree.setAllowMultipleParents( isAllowMultipleParents() );
189 tree._root = PhylogenyMethods.copySubTree( source );
194 * Returns a shallow copy of this Phylogeny.
196 * (The resulting Phylogeny has its references in the external nodes
197 * corrected, if they are lacking/obsolete in this.)
199 public Phylogeny copyShallow() {
200 return copyShallow( _root );
203 public Phylogeny copyShallow( final PhylogenyNode source ) {
204 final Phylogeny tree = new Phylogeny();
209 tree._rooted = _rooted;
211 tree._description = _description;
213 tree._rerootable = _rerootable;
214 tree._distance_unit = _distance_unit;
215 tree._confidence = _confidence;
216 tree._identifier = _identifier;
217 tree.setAllowMultipleParents( isAllowMultipleParents() );
218 tree._root = PhylogenyMethods.copySubTreeShallow( source );
223 * Need to call clearHashIdToNodeMap() afterwards (not done automatically
224 * to allow client multiple deletions in linear time).
225 * Need to call 'recalculateNumberOfExternalDescendants(boolean)' after this
226 * if tree is to be displayed.
228 * @param remove_us the parent node of the subtree to be deleted
230 public void deleteSubtree( final PhylogenyNode remove_us, final boolean collapse_resulting_node_with_one_desc ) {
231 if ( isEmpty() || ( remove_us.isRoot() && ( getNumberOfExternalNodes() != 1 ) ) ) {
234 if ( remove_us.isRoot() && ( getNumberOfExternalNodes() == 1 ) ) {
237 else if ( !collapse_resulting_node_with_one_desc ) {
238 remove_us.getParent().removeChildNode( remove_us );
241 final PhylogenyNode removed_node = remove_us;
242 final PhylogenyNode p = remove_us.getParent();
244 if ( p.getNumberOfDescendants() == 2 ) {
245 if ( removed_node.isFirstChildNode() ) {
246 setRoot( getRoot().getChildNode( 1 ) );
247 getRoot().setParent( null );
250 setRoot( getRoot().getChildNode( 0 ) );
251 getRoot().setParent( null );
255 p.removeChildNode( removed_node.getChildNodeIndex() );
259 final PhylogenyNode pp = removed_node.getParent().getParent();
260 if ( p.getNumberOfDescendants() == 2 ) {
261 final int pi = p.getChildNodeIndex();
262 if ( removed_node.isFirstChildNode() ) {
263 p.getChildNode( 1 ).setDistanceToParent( PhylogenyMethods.addPhylogenyDistances( p
264 .getDistanceToParent(), p.getChildNode( 1 ).getDistanceToParent() ) );
265 pp.setChildNode( pi, p.getChildNode( 1 ) );
268 p.getChildNode( 0 ).setDistanceToParent( PhylogenyMethods.addPhylogenyDistances( p
269 .getDistanceToParent(), p.getChildNode( 0 ).getDistanceToParent() ) );
270 pp.setChildNode( pi, p.getChildNode( 0 ) );
274 p.removeChildNode( removed_node.getChildNodeIndex() );
278 remove_us.removeConnections();
279 externalNodesHaveChanged();
282 public void externalNodesHaveChanged() {
283 _external_nodes_set = null;
286 public String[] getAllExternalNodeNames() {
291 final String[] names = new String[ getNumberOfExternalNodes() ];
292 for( final PhylogenyNodeIterator iter = iteratorExternalForward(); iter.hasNext(); ) {
293 names[ i++ ] = new String( iter.next().getName() );
298 public Confidence getConfidence() {
302 public String getDescription() {
306 public String getDistanceUnit() {
307 return _distance_unit;
310 public final static Phylogeny createInstanceFromNhxString( final String nhx ) throws IOException {
311 final PhylogenyFactory factory = ParserBasedPhylogenyFactory.getInstance();
313 return factory.create( nhx, new NHXParser() )[ 0 ];
322 * Warning. The order of the returned nodes is random
323 * -- and hence cannot be relied on.
325 * @return Unordered set of PhylogenyNode
327 public List<PhylogenyNode> getExternalNodes() {
328 if ( _external_nodes_set == null ) {
329 _external_nodes_set = new ArrayList<PhylogenyNode>();
330 for( final PhylogenyNodeIterator it = iteratorPostorder(); it.hasNext(); ) {
331 final PhylogenyNode n = it.next();
332 if ( n.isExternal() ) {
333 _external_nodes_set.add( n );
337 return _external_nodes_set;
341 * Returns the number of duplications of this Phylogeny (int). A return
342 * value of -1 indicates that the number of duplications is unknown.
344 // public int getNumberOfDuplications() {
345 // return _number_of_duplications;
346 // } // getNumberOfDuplications()
348 * Sets the number of duplications of this Phylogeny (int). A value of -1
349 * indicates that the number of duplications is unknown.
352 * set to true for clean NH format
354 // public void setNumberOfDuplications( int i ) {
356 // _number_of_duplications = -1;
359 // _number_of_duplications = i;
361 // } // setNumberOfDuplications( int )
363 * Returns the first external PhylogenyNode.
365 public PhylogenyNode getFirstExternalNode() {
367 throw new FailedConditionCheckException( "attempt to obtain first external node of empty phylogeney" );
369 PhylogenyNode node = getRoot();
370 while ( node.isInternal() ) {
371 node = node.getFirstChildNode();
377 * This calculates the height for rooted, tree-shaped phylogenies. The
378 * height is the longest distance from the root to an external node. Please
379 * note. Child nodes of collapsed nodes are ignored -- which is useful for
380 * display purposes but might be misleading for other applications.
382 * @return the height for rooted, tree-shaped phylogenies
384 public double getHeight() {
388 return calculateSubtreeHeight( getRoot() );
391 public Identifier getIdentifier() {
396 * Returns the name of this Phylogeny.
398 public String getName() {
403 * Finds the PhylogenyNode of this Phylogeny which has a matching ID number.
404 * @return PhylogenyNode with matching ID, null if not found
406 public PhylogenyNode getNode( final long id ) throws NoSuchElementException {
408 throw new NoSuchElementException( "attempt to get node in an empty phylogeny" );
410 if ( ( getIdToNodeMap() == null ) || getIdToNodeMap().isEmpty() ) {
413 return getIdToNodeMap().get( id );
417 * Returns a PhylogenyNode of this Phylogeny which has a matching name.
418 * Throws an Exception if seqname is not present in this or not unique.
421 * name (String) of PhylogenyNode to find
422 * @return PhylogenyNode with matchin name
424 public PhylogenyNode getNode( final String name ) {
428 final List<PhylogenyNode> nodes = getNodes( name );
429 if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
430 throw new IllegalArgumentException( "node named \"" + name + "\" not found" );
432 if ( nodes.size() > 1 ) {
433 throw new IllegalArgumentException( "node named \"" + name + "\" not unique" );
435 return nodes.get( 0 );
439 * This is time-inefficient since it runs a iterator each time it is called.
442 public int getNodeCount() {
447 for( final PhylogenyNodeIterator it = iteratorPreorder(); it.hasNext(); it.next() ) {
454 * Returns a List with references to all Nodes of this Phylogeny which have
458 * name (String) of Nodes to find
459 * @return Vector of references to Nodes of this Phylogeny with matching
461 * @see #getNodesWithMatchingSpecies(String)
463 public List<PhylogenyNode> getNodes( final String name ) {
467 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
468 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
469 final PhylogenyNode n = iter.next();
470 if ( n.getName().equals( name ) ) {
477 public List<PhylogenyNode> getNodesViaSequenceName( final String seq_name ) {
481 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
482 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
483 final PhylogenyNode n = iter.next();
484 if ( n.getNodeData().isHasSequence() && n.getNodeData().getSequence().getName().equals( seq_name ) ) {
491 public List<PhylogenyNode> getNodesViaSequenceSymbol( final String seq_name ) {
495 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
496 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
497 final PhylogenyNode n = iter.next();
498 if ( n.getNodeData().isHasSequence() && n.getNodeData().getSequence().getSymbol().equals( seq_name ) ) {
505 public List<PhylogenyNode> getNodesViaGeneName( final String seq_name ) {
509 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
510 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
511 final PhylogenyNode n = iter.next();
512 if ( n.getNodeData().isHasSequence() && n.getNodeData().getSequence().getGeneName().equals( seq_name ) ) {
519 public List<PhylogenyNode> getNodesViaTaxonomyCode( final String taxonomy_code ) {
523 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
524 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
525 final PhylogenyNode n = iter.next();
526 if ( n.getNodeData().isHasTaxonomy()
527 && n.getNodeData().getTaxonomy().getTaxonomyCode().equals( taxonomy_code ) ) {
535 * Returns a Vector with references to all Nodes of this Phylogeny which
536 * have a matching species name.
539 * species name (String) of Nodes to find
540 * @return Vector of references to Nodes of this Phylogeny with matching
542 * @see #getNodes(String)
544 public List<PhylogenyNode> getNodesWithMatchingSpecies( final String specname ) {
548 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
549 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
550 final PhylogenyNode n = iter.next();
551 if ( PhylogenyMethods.getSpecies( n ).equals( specname ) ) {
558 public PhylogenyNode getNodeViaSequenceName( final String seq_name ) {
562 final List<PhylogenyNode> nodes = getNodesViaSequenceName( seq_name );
563 if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
564 throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not found" );
566 if ( nodes.size() > 1 ) {
567 throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not unique" );
569 return nodes.get( 0 );
572 public PhylogenyNode getNodeViaTaxonomyCode( final String taxonomy_code ) {
576 final List<PhylogenyNode> nodes = getNodesViaTaxonomyCode( taxonomy_code );
577 if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
578 throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not found" );
580 if ( nodes.size() > 1 ) {
581 throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not unique" );
583 return nodes.get( 0 );
586 public int getNumberOfBranches() {
591 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); iter.next() ) {
600 public int getNumberOfInternalNodes() {
605 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
606 if ( iter.next().isInternal() ) {
617 * Returns the sum of external Nodes of this Phylogeny (int).
619 public int getNumberOfExternalNodes() {
623 return getExternalNodes().size();
627 * Returns all paralogs of the external PhylogenyNode n of this Phylogeny.
628 * paralog are returned as List of node references.
630 * PRECONDITION: This tree must be binary and rooted, and speciation -
631 * duplication need to be assigned for each of its internal Nodes.
633 * Returns null if this Phylogeny is empty or if n is internal.
635 * (Last modified: 11/22/00) Olivier CHABROL :
636 * olivier.chabrol@univ-provence.fr
639 * external PhylogenyNode whose orthologs are to be returned
640 * @return Vector of references to all orthologous Nodes of PhylogenyNode n
641 * of this Phylogeny, null if this Phylogeny is empty or if n is
644 public List<PhylogenyNode> getParalogousNodes( final PhylogenyNode n, final String[] taxonomyCodeRange ) {
645 PhylogenyNode node = n;
646 PhylogenyNode prev = null;
647 final List<PhylogenyNode> v = new ArrayList<PhylogenyNode>();
648 final Map<PhylogenyNode, List<String>> map = new HashMap<PhylogenyNode, List<String>>();
649 getTaxonomyMap( getRoot(), map );
650 if ( !node.isExternal() || isEmpty() ) {
653 final String searchNodeSpeciesId = PhylogenyMethods.getTaxonomyIdentifier( n );
654 if ( !node.isExternal() || isEmpty() ) {
657 List<String> taxIdList = null;
658 final List<String> taxonomyCodeRangeList = Arrays.asList( taxonomyCodeRange );
659 while ( !node.isRoot() ) {
661 node = node.getParent();
662 taxIdList = map.get( node );
663 if ( node.isDuplication() && isContains( taxIdList, taxonomyCodeRangeList ) ) {
664 if ( node.getChildNode1() == prev ) {
665 v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode2()
666 .getAllExternalDescendants() ) );
669 v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode1()
670 .getAllExternalDescendants() ) );
677 public Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> getRelevantSequenceRelationTypes() {
678 if ( _relevant_sequence_relation_types == null ) {
679 _relevant_sequence_relation_types = new Vector<SEQUENCE_RELATION_TYPE>();
681 return _relevant_sequence_relation_types;
685 * Returns the root PhylogenyNode of this Phylogeny.
687 public PhylogenyNode getRoot() {
691 public Collection<Sequence> getSequenceRelationQueries() {
692 return _sequenceRelationQueries;
695 public String getType() {
700 * Deletes this Phylogeny.
709 _id_to_node_map = null;
713 setAllowMultipleParents( Phylogeny.ALLOW_MULTIPLE_PARENTS_DEFAULT );
717 * Returns whether this is a completely binary tree (i.e. all internal nodes
721 public boolean isCompletelyBinary() {
725 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
726 final PhylogenyNode node = iter.next();
727 if ( node.isInternal() && ( node.getNumberOfDescendants() != 2 ) ) {
735 * Checks whether a Phylogeny object is deleted (or empty).
737 * @return true if the tree is deleted (or empty), false otherwise
739 public boolean isEmpty() {
740 return ( getRoot() == null );
743 public boolean isRerootable() {
748 * Returns true is this Phylogeny is rooted.
750 public boolean isRooted() {
754 public boolean isTree() {
758 public PhylogenyNodeIterator iteratorExternalForward() {
759 return new ExternalForwardIterator( this );
762 public PhylogenyNodeIterator iteratorLevelOrder() {
763 return new LevelOrderTreeIterator( this );
766 public PhylogenyNodeIterator iteratorPostorder() {
767 return new PostorderTreeIterator( this );
770 public PhylogenyNodeIterator iteratorPreorder() {
771 return new PreorderTreeIterator( this );
775 * Resets the ID numbers of the nodes of this Phylogeny in level order,
776 * starting with start_label (for the root). <br>
777 * WARNING. After this method has been called, node IDs are no longer
780 public void levelOrderReID() {
784 _id_to_node_map = null;
786 for( final PhylogenyNodeIterator it = iteratorPreorder(); it.hasNext(); ) {
787 final PhylogenyNode node = it.next();
788 if ( node.isRoot() ) {
789 node.setId( PhylogenyNode.getNodeCount() );
792 node.setId( node.getParent().getId() + 1 );
793 if ( node.getId() > max ) {
798 PhylogenyNode.setNodeCount( max + 1 );
802 * Prints descriptions of all external Nodes of this Phylogeny to
805 public void printExtNodes() {
809 for( final PhylogenyNodeIterator iter = iteratorExternalForward(); iter.hasNext(); ) {
810 System.out.println( iter.next() + "\n" );
815 * (Re)counts the number of children for each PhylogenyNode of this
816 * Phylogeny. As an example, this method needs to be called after a
817 * Phylogeny has been reRooted and it is to be displayed.
819 * @param consider_collapsed_nodes
820 * set to true to take into account collapsed nodes (collapsed
821 * nodes have 1 child).
823 public void recalculateNumberOfExternalDescendants( final boolean consider_collapsed_nodes ) {
827 for( final PhylogenyNodeIterator iter = iteratorPostorder(); iter.hasNext(); ) {
828 final PhylogenyNode node = iter.next();
829 if ( node.isExternal() || ( consider_collapsed_nodes && node.isCollapse() ) ) {
830 node.setSumExtNodes( 1 );
834 for( int i = 0; i < node.getNumberOfDescendants(); ++i ) {
835 sum += node.getChildNode( i ).getNumberOfExternalNodes();
837 node.setSumExtNodes( sum );
843 * Places the root of this Phylogeny on the parent branch of the
844 * PhylogenyNode with a corresponding ID. The new root is always placed on
845 * the middle of the branch. If the resulting reRooted Phylogeny is to be
846 * used any further, in most cases the following methods have to be called
847 * on the resulting Phylogeny:
849 * <li>recalculateNumberOfExternalDescendants(boolean)
850 * <li>recalculateAndReset()
853 * ID (int) of PhylogenyNode of this Phylogeny
855 public void reRoot( final long id ) {
856 reRoot( getNode( id ) );
860 * Places the root of this Phylogeny on the parent branch PhylogenyNode n.
861 * The new root is always placed on the middle of the branch.
863 * If the resulting reRooted Phylogeny is to be used any further, in most
864 * cases the following three methods have to be called on the resulting
867 * <li>recalculateNumberOfExternalDescendants(boolean) <li>recalculateAndReset()
870 * (Last modified: 10/01/01)
873 * PhylogenyNode of this Phylogeny\
875 public void reRoot( final PhylogenyNode n ) {
879 public void reRoot( final PhylogenyNode n, final double distance_n_to_parent ) {
880 if ( isEmpty() || ( getNumberOfExternalNodes() < 2 ) ) {
887 else if ( n.getParent().isRoot() ) {
888 if ( ( n.getParent().getNumberOfDescendants() == 2 ) && ( distance_n_to_parent >= 0 ) ) {
889 final double d = n.getParent().getChildNode1().getDistanceToParent()
890 + n.getParent().getChildNode2().getDistanceToParent();
892 if ( n.getChildNodeIndex() == 0 ) {
893 other = n.getParent().getChildNode2();
896 other = n.getParent().getChildNode1();
898 n.setDistanceToParent( distance_n_to_parent );
899 final double dm = d - distance_n_to_parent;
901 other.setDistanceToParent( dm );
904 other.setDistanceToParent( 0 );
907 if ( n.getParent().getNumberOfDescendants() > 2 ) {
908 final int index = n.getChildNodeIndex();
909 final double dn = n.getDistanceToParent();
910 final PhylogenyNode prev_root = getRoot();
911 prev_root.getDescendants().remove( index );
912 final PhylogenyNode new_root = new PhylogenyNode();
913 new_root.setChildNode( 0, n );
914 new_root.setChildNode( 1, prev_root );
915 if ( n.getBranchDataDirectly() != null ) {
916 prev_root.setBranchData( ( BranchData ) n.getBranchDataDirectly().copy() );
919 if ( distance_n_to_parent >= 0 ) {
920 n.setDistanceToParent( distance_n_to_parent );
921 final double d = dn - distance_n_to_parent;
923 prev_root.setDistanceToParent( d );
926 prev_root.setDistanceToParent( 0 );
931 final double d = dn / 2.0;
932 n.setDistanceToParent( d );
933 prev_root.setDistanceToParent( d );
940 PhylogenyNode b = null;
941 PhylogenyNode c = null;
942 final PhylogenyNode new_root = new PhylogenyNode();
943 double distance1 = 0.0;
944 double distance2 = 0.0;
945 BranchData branch_data_1 = null;
946 BranchData branch_data_2 = null;
949 new_root.setChildNode( 0, a );
950 new_root.setChildNode( 1, b );
951 distance1 = c.getDistanceToParent();
952 if ( c.getBranchDataDirectly() != null ) {
953 branch_data_1 = ( BranchData ) c.getBranchDataDirectly().copy();
955 c.setDistanceToParent( b.getDistanceToParent() );
956 if ( b.getBranchDataDirectly() != null ) {
957 c.setBranchData( ( BranchData ) b.getBranchDataDirectly().copy() );
959 if ( a.getBranchDataDirectly() != null ) {
960 b.setBranchData( ( BranchData ) a.getBranchDataDirectly().copy() );
962 // New root is always placed in the middle of the branch:
963 if ( a.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) {
964 b.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
967 if ( distance_n_to_parent >= 0.0 ) {
968 final double diff = a.getDistanceToParent() - distance_n_to_parent;
969 a.setDistanceToParent( distance_n_to_parent );
970 b.setDistanceToParent( diff >= 0.0 ? diff : 0.0 );
973 final double d = a.getDistanceToParent() / 2.0;
974 a.setDistanceToParent( d );
975 b.setDistanceToParent( d );
978 b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
979 // moving to the old root, swapping references:
980 while ( !c.isRoot() ) {
984 b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
986 distance2 = c.getDistanceToParent();
987 branch_data_2 = c.getBranchDataDirectly();
988 c.setDistanceToParent( distance1 );
989 c.setBranchData( branch_data_1 );
990 distance1 = distance2;
991 branch_data_1 = branch_data_2;
993 // removing the old root:
994 if ( c.getNumberOfDescendants() == 2 ) {
995 final PhylogenyNode node = c.getChildNode( 1 - b.getChildNodeIndex( c ) );
997 if ( ( c.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT )
998 && ( node.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) ) {
999 node.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
1002 node.setDistanceToParent( ( c.getDistanceToParent() >= 0.0 ? c.getDistanceToParent() : 0.0 )
1003 + ( node.getDistanceToParent() >= 0.0 ? node.getDistanceToParent() : 0.0 ) );
1005 if ( c.getBranchDataDirectly() != null ) {
1006 node.setBranchData( ( BranchData ) c.getBranchDataDirectly().copy() );
1008 for( int i = 0; i < b.getNumberOfDescendants(); ++i ) {
1009 if ( b.getChildNode( i ) == c ) {
1010 b.setChildNodeOnly( i, node );
1017 c.removeChildNode( b.getChildNodeIndex( c ) );
1019 setRoot( new_root );
1024 * Sets all Nodes of this Phylogeny to not-collapsed.
1026 * In most cases methods adjustNodeCount(false) and recalculateAndReset()
1027 * need to be called after this method has been called.
1029 public void setAllNodesToNotCollapse() {
1033 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1034 final PhylogenyNode node = iter.next();
1035 node.setCollapse( false );
1039 public void setConfidence( final Confidence confidence ) {
1040 _confidence = confidence;
1043 public void setDescription( final String description ) {
1044 _description = description;
1047 public void setDistanceUnit( final String _distance_unit ) {
1048 this._distance_unit = _distance_unit;
1051 public void setIdentifier( final Identifier identifier ) {
1052 _identifier = identifier;
1055 public void setIdToNodeMap( final HashMap<Long, PhylogenyNode> idhash ) {
1056 _id_to_node_map = idhash;
1060 * Sets the indicators of all Nodes of this Phylogeny to 0.
1062 public void setIndicatorsToZero() {
1066 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1067 iter.next().setIndicator( ( byte ) 0 );
1069 } // setIndicatorsToZero()
1072 * Sets the name of this Phylogeny to s.
1074 public void setName( final String s ) {
1078 public void setRelevantSequenceRelationTypes( final Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> types ) {
1079 _relevant_sequence_relation_types = types;
1082 public void setRerootable( final boolean rerootable ) {
1083 _rerootable = rerootable;
1086 public void setRoot( final PhylogenyNode n ) {
1091 * Sets whether this Phylogeny is rooted or not.
1093 public void setRooted( final boolean b ) {
1095 } // setRooted( boolean )
1097 public void setSequenceRelationQueries( final Collection<Sequence> sequencesByName ) {
1098 _sequenceRelationQueries = sequencesByName;
1101 public void setType( final String type ) {
1105 public String toNewHampshire() {
1106 return toNewHampshire( false, NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1109 public String toNewHampshire( final boolean simple_nh,
1110 final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_style ) {
1112 return new PhylogenyWriter().toNewHampshire( this, simple_nh, true, nh_conversion_support_style )
1115 catch ( final IOException e ) {
1116 throw new Error( "this should not have happend: " + e.getMessage() );
1120 public String toNewHampshireX() {
1122 return new PhylogenyWriter().toNewHampshireX( this ).toString();
1124 catch ( final IOException e ) {
1125 throw new Error( "this should not have happend: " + e.getMessage() );
1129 public String toNexus() {
1130 return toNexus( NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1133 public String toNexus( final NH_CONVERSION_SUPPORT_VALUE_STYLE svs ) {
1135 return new PhylogenyWriter().toNexus( this, svs ).toString();
1137 catch ( final IOException e ) {
1138 throw new Error( "this should not have happend: " + e.getMessage() );
1142 public String toPhyloXML( final int phyloxml_level ) {
1144 return new PhylogenyWriter().toPhyloXML( this, phyloxml_level ).toString();
1146 catch ( final IOException e ) {
1147 throw new Error( "this should not have happend: " + e.getMessage() );
1151 // ---------------------------------------------------------
1152 // Writing of Phylogeny to Strings
1153 // ---------------------------------------------------------
1155 * Converts this Phylogeny to a New Hampshire X (String) representation.
1157 * @return New Hampshire X (String) representation of this
1158 * @see #toNewHampshireX()
1161 public String toString() {
1162 return toNewHampshireX();
1166 * Removes the root PhylogenyNode this Phylogeny.
1168 public void unRoot() throws RuntimeException {
1170 throw new FailedConditionCheckException( "Attempt to unroot a phylogeny which is not tree-like." );
1175 setIndicatorsToZero();
1176 if ( !isRooted() || ( getNumberOfExternalNodes() <= 1 ) ) {
1183 private HashMap<Long, PhylogenyNode> getIdToNodeMap() {
1184 return _id_to_node_map;
1188 * Return Node by TaxonomyId Olivier CHABROL :
1189 * olivier.chabrol@univ-provence.fr
1192 * search taxonomy identifier
1194 * sublist node to search
1195 * @return List node with the same taxonomy identifier
1197 private List<PhylogenyNode> getNodeByTaxonomyID( final String taxonomyID, final List<PhylogenyNode> nodes ) {
1198 final List<PhylogenyNode> retour = new ArrayList<PhylogenyNode>();
1199 for( final PhylogenyNode node : nodes ) {
1200 if ( taxonomyID.equals( PhylogenyMethods.getTaxonomyIdentifier( node ) ) ) {
1208 * List all species contains in all leaf under a node Olivier CHABROL :
1209 * olivier.chabrol@univ-provence.fr
1212 * PhylogenyNode whose sub node species are returned
1213 * @return species contains in all leaf under the param node
1215 private List<String> getSubNodeTaxonomy( final PhylogenyNode node ) {
1216 final List<String> taxonomyList = new ArrayList<String>();
1217 final List<PhylogenyNode> childs = node.getAllExternalDescendants();
1218 String speciesId = null;
1219 for( final PhylogenyNode phylogenyNode : childs ) {
1220 // taxId = new Long(phylogenyNode.getTaxonomyID());
1221 speciesId = PhylogenyMethods.getTaxonomyIdentifier( phylogenyNode );
1222 if ( !taxonomyList.contains( speciesId ) ) {
1223 taxonomyList.add( speciesId );
1226 return taxonomyList;
1230 * Create a map [<PhylogenyNode, List<String>], the list contains the
1231 * species contains in all leaf under phylogeny node Olivier CHABROL :
1232 * olivier.chabrol@univ-provence.fr
1235 * the tree root node
1239 private void getTaxonomyMap( final PhylogenyNode node, final Map<PhylogenyNode, List<String>> map ) {
1241 if ( node.isExternal() ) {
1244 map.put( node, getSubNodeTaxonomy( node ) );
1245 getTaxonomyMap( node.getChildNode1(), map );
1246 getTaxonomyMap( node.getChildNode2(), map );
1249 private boolean isAllowMultipleParents() {
1250 return _allow_multiple_parents;
1254 * Util method to check if all element of a list is contains in the
1255 * rangeList. Olivier CHABROL : olivier.chabrol@univ-provence.fr
1260 * the range list to compare
1261 * @return <code>true</code> if all param list element are contains in param
1262 * rangeList, <code>false</code> otherwise.
1264 private boolean isContains( final List<String> list, final List<String> rangeList ) {
1265 if ( list.size() > rangeList.size() ) {
1269 for( final Iterator<String> iterator = list.iterator(); iterator.hasNext(); ) {
1270 l = iterator.next();
1271 if ( !rangeList.contains( l ) ) {
1279 * Hashes the ID number of each PhylogenyNode of this Phylogeny to its
1280 * corresponding PhylogenyNode, in order to make method getNode( id ) run in
1281 * constant time. Important: The user is responsible for calling this method
1282 * (again) after this Phylogeny has been changed/created/renumbered.
1284 private void reHashIdToNodeMap() {
1288 setIdToNodeMap( new HashMap<Long, PhylogenyNode>() );
1289 for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1290 final PhylogenyNode node = iter.next();
1291 getIdToNodeMap().put( node.getId(), node );
1295 private void setAllowMultipleParents( final boolean allow_multiple_parents ) {
1296 _allow_multiple_parents = allow_multiple_parents;