forester/java/src/org/forester/sdi/GSDI.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   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.
  13 //
  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.
  18 //
  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
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.sdi;
  27
  28 import java.util.ArrayList;
  29 import java.util.HashMap;
  30 import java.util.HashSet;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34
  35 import org.forester.phylogeny.Phylogeny;
  36 import org.forester.phylogeny.PhylogenyNode;
  37 import org.forester.phylogeny.data.Event;
  38 import org.forester.phylogeny.data.Taxonomy;
  39 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  40 import org.forester.util.ForesterUtil;
  41
  42 /*
  43  * Implements our algorithm for speciation - duplication inference (SDI). <p>
  44  * The initialization is accomplished by: </p> <ul> <li>method
  45  * "linkExtNodesOfG()" of class SDI: setting the links for the external nodes of
  46  * the gene tree <li>"preorderReID(int)" from class Phylogeny: numbering of
  47  * nodes of the species tree in preorder <li>the optional stripping of the
  48  * species tree is accomplished by method "stripTree(Phylogeny,Phylogeny)" of
  49  * class Phylogeny </ul> <p> The recursion part is accomplished by this class'
  50  * method "geneTreePostOrderTraversal(PhylogenyNode)". <p> Requires JDK 1.5 or
  51  * greater.
  52  *
  53  * @see SDI#linkNodesOfG()
  54  *
  55  * @see Phylogeny#preorderReID(int)
  56  *
  57  * @see
  58  * PhylogenyMethods#taxonomyBasedDeletionOfExternalNodes(Phylogeny,Phylogeny)
  59  *
  60  * @see #geneTreePostOrderTraversal(PhylogenyNode)
  61  *
  62  * @author Christian M. Zmasek
  63  */
  64 public final class GSDI extends SDI {
  65
  66     private final HashMap<PhylogenyNode, Integer> _transversal_counts;
  67     private final boolean                         _most_parsimonious_duplication_model;
  68     private final boolean                         _strip_gene_tree;
  69     private final boolean                         _strip_species_tree;
  70     private int                                   _speciation_or_duplication_events_sum;
  71     private int                                   _speciations_sum;
  72     private final List<PhylogenyNode>             _stripped_gene_tree_nodes;
  73     private final List<PhylogenyNode>             _stripped_species_tree_nodes;
  74     private final Set<PhylogenyNode>              _mapped_species_tree_nodes;
  75
  76     /**
  77      * Constructor which sets the gene tree and the species tree to be compared.
  78      * species_tree is the species tree to which the gene tree gene_tree will be
  79      * compared to - with method "infer(boolean)". Both Trees must be completely
  80      * binary and rooted. The actual inference is accomplished with method
  81      * "infer(boolean)". The mapping cost L can then be calculated with method
  82      * "computeMappingCost()".
  83      * <p>
  84      *
  85      * @see #infer(boolean)
  86      * @see SDI#computeMappingCostL()
  87      * @param gene_tree
  88      *            reference to a rooted gene tree to which assign duplication vs
  89      *            speciation, must have species names in the species name fields
  90      *            for all external nodes
  91      * @param species_tree
  92      *            reference to a rooted binary species tree which might get
  93      *            stripped in the process, must have species names in the
  94      *            species name fields for all external nodes
  95      *
  96      * @param most_parsimonious_duplication_model
  97      *            set to true to assign nodes as speciations which would
  98      *            otherwise be assiged as unknown because of polytomies in the
  99      *            species tree.
 100      * @throws SdiException
 101      *
 102      */
 103     public GSDI( final Phylogeny gene_tree,
 104                  final Phylogeny species_tree,
 105                  final boolean most_parsimonious_duplication_model,
 106                  final boolean strip_gene_tree,
 107                  final boolean strip_species_tree ) throws SdiException {
 108         super( gene_tree, species_tree );
 109         _speciation_or_duplication_events_sum = 0;
 110         _speciations_sum = 0;
 111         _most_parsimonious_duplication_model = most_parsimonious_duplication_model;
 112         _transversal_counts = new HashMap<PhylogenyNode, Integer>();
 113         _duplications_sum = 0;
 114         _strip_gene_tree = strip_gene_tree;
 115         _strip_species_tree = strip_species_tree;
 116         _stripped_gene_tree_nodes = new ArrayList<PhylogenyNode>();
 117         _stripped_species_tree_nodes = new ArrayList<PhylogenyNode>();
 118         _mapped_species_tree_nodes = new HashSet<PhylogenyNode>();
 119         getSpeciesTree().preOrderReId();
 120         linkNodesOfG();
 121         geneTreePostOrderTraversal( getGeneTree().getRoot() );
 122     }
 123
 124     GSDI( final Phylogeny gene_tree, final Phylogeny species_tree, final boolean most_parsimonious_duplication_model )
 125             throws SdiException {
 126         this( gene_tree, species_tree, most_parsimonious_duplication_model, false, false );
 127     }
 128
 129     private final Event createDuplicationEvent() {
 130         final Event event = Event.createSingleDuplicationEvent();
 131         ++_duplications_sum;
 132         return event;
 133     }
 134
 135     private final Event createSingleSpeciationOrDuplicationEvent() {
 136         final Event event = Event.createSingleSpeciationOrDuplicationEvent();
 137         ++_speciation_or_duplication_events_sum;
 138         return event;
 139     }
 140
 141     private final Event createSpeciationEvent() {
 142         final Event event = Event.createSingleSpeciationEvent();
 143         ++_speciations_sum;
 144         return event;
 145     }
 146
 147     // s is the node on the species tree g maps to.
 148     private final void determineEvent( final PhylogenyNode s, final PhylogenyNode g ) {
 149         Event event = null;
 150         // Determine how many children map to same node as parent.
 151         int sum_g_childs_mapping_to_s = 0;
 152         for( int i = 0; i < g.getNumberOfDescendants(); ++i ) {
 153             final PhylogenyNode c = g.getChildNode( i );
 154             if ( c.getLink() == s ) {
 155                 ++sum_g_childs_mapping_to_s;
 156             }
 157         }
 158         // Determine the sum of traversals.
 159         int traversals_sum = 0;
 160         int max_traversals = 0;
 161         PhylogenyNode max_traversals_node = null;
 162         if ( !s.isExternal() ) {
 163             for( int i = 0; i < s.getNumberOfDescendants(); ++i ) {
 164                 final PhylogenyNode current_node = s.getChildNode( i );
 165                 final int traversals = getTraversalCount( current_node );
 166                 traversals_sum += traversals;
 167                 if ( traversals > max_traversals ) {
 168                     max_traversals = traversals;
 169                     max_traversals_node = current_node;
 170                 }
 171             }
 172         }
 173         // System.out.println( " sum=" + traversals_sum );
 174         // System.out.println( " max=" + max_traversals );
 175         // System.out.println( " m=" + sum_g_childs_mapping_to_s );
 176         if ( sum_g_childs_mapping_to_s > 0 ) {
 177             if ( traversals_sum == 2 ) {
 178                 event = createDuplicationEvent();
 179                 //  _transversal_counts.clear();
 180             }
 181             else if ( traversals_sum > 2 ) {
 182                 if ( max_traversals <= 1 ) {
 183                     if ( _most_parsimonious_duplication_model ) {
 184                         event = createSpeciationEvent();
 185                     }
 186                     else {
 187                         event = createSingleSpeciationOrDuplicationEvent();
 188                     }
 189                 }
 190                 else {
 191                     event = createDuplicationEvent();
 192                     System.out.println( g.toString() );
 193                     _transversal_counts.put( max_traversals_node, 1 );
 194                     //  _transversal_counts.clear();
 195                 }
 196             }
 197             else {
 198                 event = createDuplicationEvent();
 199                 //   _transversal_counts.clear();
 200             }
 201         }
 202         else {
 203             event = createSpeciationEvent();
 204         }
 205         g.getNodeData().setEvent( event );
 206     }
 207
 208     /**
 209      * Traverses the subtree of PhylogenyNode g in postorder, calculating the
 210      * mapping function M, and determines which nodes represent speciation
 211      * events and which ones duplication events.
 212      * <p>
 213      * Preconditions: Mapping M for external nodes must have been calculated and
 214      * the species tree must be labeled in preorder.
 215      * <p>
 216      *
 217      * @param g
 218      *            starting node of a gene tree - normally the root
 219      */
 220     final void geneTreePostOrderTraversal( final PhylogenyNode g ) {
 221         if ( !g.isExternal() ) {
 222             boolean all_ext = true;
 223             for( int i = 0; i < g.getNumberOfDescendants(); ++i ) {
 224                 if ( g.getChildNode( i ).isInternal() ) {
 225                     all_ext = false;
 226                     break;
 227                 }
 228             }
 229             if ( all_ext ) {
 230                 _transversal_counts.clear();
 231             }
 232             for( int i = 0; i < g.getNumberOfDescendants(); ++i ) {
 233                 geneTreePostOrderTraversal( g.getChildNode( i ) );
 234             }
 235             final PhylogenyNode[] linked_nodes = new PhylogenyNode[ g.getNumberOfDescendants() ];
 236             for( int i = 0; i < linked_nodes.length; ++i ) {
 237                 if ( g.getChildNode( i ).getLink() == null ) {
 238                     System.out.println( "link is null for " + g.getChildNode( i ) );
 239                     System.exit( -1 );
 240                 }
 241                 linked_nodes[ i ] = g.getChildNode( i ).getLink();
 242             }
 243             final int[] min_max = obtainMinMaxIdIndices( linked_nodes );
 244             int min_i = min_max[ 0 ];
 245             int max_i = min_max[ 1 ];
 246             // initTransversalCounts();
 247             while ( linked_nodes[ min_i ] != linked_nodes[ max_i ] ) {
 248                 increaseTraversalCount( linked_nodes[ max_i ] );
 249                 linked_nodes[ max_i ] = linked_nodes[ max_i ].getParent();
 250                 final int[] min_max_ = obtainMinMaxIdIndices( linked_nodes );
 251                 min_i = min_max_[ 0 ];
 252                 max_i = min_max_[ 1 ];
 253             }
 254             final PhylogenyNode s = linked_nodes[ max_i ];
 255             g.setLink( s );
 256             // Determines whether dup. or spec.
 257             determineEvent( s, g );
 258         }
 259     }
 260
 261     public final int getSpeciationOrDuplicationEventsSum() {
 262         return _speciation_or_duplication_events_sum;
 263     }
 264
 265     public final int getSpeciationsSum() {
 266         return _speciations_sum;
 267     }
 268
 269     private final int getTraversalCount( final PhylogenyNode node ) {
 270         if ( _transversal_counts.containsKey( node ) ) {
 271             return _transversal_counts.get( node );
 272         }
 273         return 0;
 274     }
 275
 276     private final void increaseTraversalCount( final PhylogenyNode node ) {
 277         if ( _transversal_counts.containsKey( node ) ) {
 278             _transversal_counts.put( node, _transversal_counts.get( node ) + 1 );
 279         }
 280         else {
 281             _transversal_counts.put( node, 1 );
 282         }
 283         // System.out.println( "count for node " + node.getID() + " is now "
 284         // + getTraversalCount( node ) );
 285     }
 286
 287     /**
 288      * This allows for linking of internal nodes of the species tree (as opposed
 289      * to just external nodes, as in the method it overrides.
 290      * @throws SdiException
 291      *
 292      */
 293     @Override
 294     //    final void linkNodesOfG() {
 295     //        final HashMap<Taxonomy, PhylogenyNode> speciestree_ext_nodes = createTaxonomyToNodeMap();
 296     //        if ( _strip_gene_tree ) {
 297     //            stripGeneTree( speciestree_ext_nodes );
 298     //            if ( ( _gene_tree == null ) || ( _gene_tree.getNumberOfExternalNodes() < 2 ) ) {
 299     //                throw new IllegalArgumentException( "species tree does not contain any"
 300     //                        + " nodes matching species in the gene tree" );
 301     //            }
 302     //        }
 303     //        // Retrieve the reference to the PhylogenyNode with a matching species.
 304     //        for( final PhylogenyNodeIterator iter = _gene_tree.iteratorExternalForward(); iter.hasNext(); ) {
 305     //            final PhylogenyNode g = iter.next();
 306     //            if ( !g.getNodeData().isHasTaxonomy() ) {
 307     //                throw new IllegalArgumentException( "gene tree node " + g + " has no taxonomic data" );
 308     //            }
 309     //            final PhylogenyNode s = speciestree_ext_nodes.get( g.getNodeData().getTaxonomy() );
 310     //            if ( s == null ) {
 311     //                throw new IllegalArgumentException( "species " + g.getNodeData().getTaxonomy()
 312     //                        + " not present in species tree" );
 313     //            }
 314     //            g.setLink( s );
 315     //        }
 316     //    }
 317     final void linkNodesOfG() throws SdiException {
 318         final Map<String, PhylogenyNode> species_to_node_map = new HashMap<String, PhylogenyNode>();
 319         final List<PhylogenyNode> species_tree_ext_nodes = new ArrayList<PhylogenyNode>();
 320         final TaxonomyComparisonBase tax_comp_base = determineTaxonomyComparisonBase( _gene_tree );
 321         // System.out.println( "comp base is: " + tax_comp_base );
 322         // Stringyfied taxonomy is the key, node is the value.
 323         for( final PhylogenyNodeIterator iter = _species_tree.iteratorExternalForward(); iter.hasNext(); ) {
 324             final PhylogenyNode s = iter.next();
 325             species_tree_ext_nodes.add( s );
 326             final String tax_str = taxonomyToString( s, tax_comp_base );
 327             if ( !ForesterUtil.isEmpty( tax_str ) ) {
 328                 if ( species_to_node_map.containsKey( tax_str ) ) {
 329                     throw new SdiException( "taxonomy \"" + s + "\" is not unique in species tree" );
 330                 }
 331                 species_to_node_map.put( tax_str, s );
 332             }
 333         }
 334         // Retrieve the reference to the node with a matching stringyfied taxonomy.
 335         for( final PhylogenyNodeIterator iter = _gene_tree.iteratorExternalForward(); iter.hasNext(); ) {
 336             final PhylogenyNode g = iter.next();
 337             if ( !g.getNodeData().isHasTaxonomy() ) {
 338                 if ( _strip_gene_tree ) {
 339                     _stripped_gene_tree_nodes.add( g );
 340                 }
 341                 else {
 342                     throw new SdiException( "gene tree node \"" + g + "\" has no taxonomic data" );
 343                 }
 344             }
 345             else {
 346                 final String tax_str = taxonomyToString( g, tax_comp_base );
 347                 if ( ForesterUtil.isEmpty( tax_str ) ) {
 348                     if ( _strip_gene_tree ) {
 349                         _stripped_gene_tree_nodes.add( g );
 350                     }
 351                     else {
 352                         throw new SdiException( "gene tree node \"" + g + "\" has no appropriate taxonomic data" );
 353                     }
 354                 }
 355                 else {
 356                     final PhylogenyNode s = species_to_node_map.get( tax_str );
 357                     if ( s == null ) {
 358                         if ( _strip_gene_tree ) {
 359                             _stripped_gene_tree_nodes.add( g );
 360                         }
 361                         else {
 362                             throw new SdiException( "taxonomy \"" + g.getNodeData().getTaxonomy()
 363                                     + "\" not present in species tree" );
 364                         }
 365                     }
 366                     else {
 367                         g.setLink( s );
 368                         _mapped_species_tree_nodes.add( s );
 369                         //  System.out.println( "setting link of " + g + " to " + s );
 370                     }
 371                 }
 372             }
 373         } // for loop
 374         if ( _strip_gene_tree ) {
 375             for( final PhylogenyNode g : _stripped_gene_tree_nodes ) {
 376                 _gene_tree.deleteSubtree( g, true );
 377             }
 378         }
 379         if ( _strip_species_tree ) {
 380             for( final PhylogenyNode s : species_tree_ext_nodes ) {
 381                 if ( !_mapped_species_tree_nodes.contains( s ) ) {
 382                     _species_tree.deleteSubtree( s, true );
 383                 }
 384             }
 385         }
 386     }
 387
 388     public Set<PhylogenyNode> getMappedExternalSpeciesTreeNodes() {
 389         return _mapped_species_tree_nodes;
 390     }
 391
 392     //    final private HashMap<Taxonomy, PhylogenyNode> createTaxonomyToNodeMap() {
 393     //        final HashMap<Taxonomy, PhylogenyNode> speciestree_ext_nodes = new HashMap<Taxonomy, PhylogenyNode>();
 394     //        for( final PhylogenyNodeIterator iter = _species_tree.iteratorLevelOrder(); iter.hasNext(); ) {
 395     //            final PhylogenyNode n = iter.next();
 396     //            if ( n.getNodeData().isHasTaxonomy() ) {
 397     //                if ( speciestree_ext_nodes.containsKey( n.getNodeData().getTaxonomy() ) ) {
 398     //                    throw new IllegalArgumentException( "taxonomy [" + n.getNodeData().getTaxonomy()
 399     //                            + "] is not unique in species phylogeny" );
 400     //                }
 401     //                speciestree_ext_nodes.put( n.getNodeData().getTaxonomy(), n );
 402     //            }
 403     //        }
 404     //        return speciestree_ext_nodes;
 405     //    }
 406     //    private final void stripGeneTree( final HashMap<Taxonomy, PhylogenyNode> speciestree_ext_nodes ) {
 407     //        //  final Set<PhylogenyNode> to_delete = new HashSet<PhylogenyNode>();
 408     //        for( final PhylogenyNodeIterator iter = _gene_tree.iteratorExternalForward(); iter.hasNext(); ) {
 409     //            final PhylogenyNode g = iter.next();
 410     //            if ( !g.getNodeData().isHasTaxonomy() ) {
 411     //                throw new IllegalArgumentException( "gene tree node " + g + " has no taxonomic data" );
 412     //            }
 413     //            if ( !speciestree_ext_nodes.containsKey( g.getNodeData().getTaxonomy() ) ) {
 414     //                _stripped_gene_tree_nodes.add( g );
 415     //            }
 416     //        }
 417     //        for( final PhylogenyNode n : _stripped_gene_tree_nodes ) {
 418     //            _gene_tree.deleteSubtree( n, true );
 419     //        }
 420     //    }
 421     //    private final void stripGeneTree2( final HashMap<Taxonomy, PhylogenyNode> speciestree_ext_nodes ) {
 422     //        //  final Set<PhylogenyNode> to_delete = new HashSet<PhylogenyNode>();
 423     //        for( final PhylogenyNodeIterator iter = _gene_tree.iteratorExternalForward(); iter.hasNext(); ) {
 424     //            final PhylogenyNode g = iter.next();
 425     //            if ( !g.getNodeData().isHasTaxonomy() ) {
 426     //                _stripped_gene_tree_nodes.add( g );
 427     //            }
 428     //            else {
 429     //                if ( !speciestree_ext_nodes.containsKey( g.getNodeData().getTaxonomy() ) ) {
 430     //                    _stripped_gene_tree_nodes.add( g );
 431     //                }
 432     //            }
 433     //        }
 434     //        for( final PhylogenyNode n : _stripped_gene_tree_nodes ) {
 435     //            _gene_tree.deleteSubtree( n, true );
 436     //        }
 437     //    }
 438     public static TaxonomyComparisonBase determineTaxonomyComparisonBase( final Phylogeny gene_tree ) {
 439         int with_id_count = 0;
 440         int with_code_count = 0;
 441         int with_sn_count = 0;
 442         int max = 0;
 443         for( final PhylogenyNodeIterator iter = gene_tree.iteratorExternalForward(); iter.hasNext(); ) {
 444             final PhylogenyNode g = iter.next();
 445             if ( g.getNodeData().isHasTaxonomy() ) {
 446                 final Taxonomy tax = g.getNodeData().getTaxonomy();
 447                 if ( ( tax.getIdentifier() != null ) && !ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) ) {
 448                     if ( ++with_id_count > max ) {
 449                         max = with_id_count;
 450                     }
 451                 }
 452                 if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
 453                     if ( ++with_code_count > max ) {
 454                         max = with_code_count;
 455                     }
 456                 }
 457                 if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 458                     if ( ++with_sn_count > max ) {
 459                         max = with_sn_count;
 460                     }
 461                 }
 462             }
 463         }
 464         if ( max == 0 ) {
 465             throw new IllegalArgumentException( "gene tree has no taxonomic data" );
 466         }
 467         else if ( max == 1 ) {
 468             throw new IllegalArgumentException( "gene tree has only one node with taxonomic data" );
 469         }
 470         else if ( max == with_sn_count ) {
 471             return SDI.TaxonomyComparisonBase.SCIENTIFIC_NAME;
 472         }
 473         else if ( max == with_id_count ) {
 474             return SDI.TaxonomyComparisonBase.ID;
 475         }
 476         else {
 477             return SDI.TaxonomyComparisonBase.CODE;
 478         }
 479     }
 480
 481     public List<PhylogenyNode> getStrippedExternalGeneTreeNodes() {
 482         return _stripped_gene_tree_nodes;
 483     }
 484
 485     @Override
 486     public final String toString() {
 487         final StringBuffer sb = new StringBuffer();
 488         sb.append( "Most parsimonious duplication model: " + _most_parsimonious_duplication_model );
 489         sb.append( ForesterUtil.getLineSeparator() );
 490         sb.append( "Speciations sum                    : " + getSpeciationsSum() );
 491         sb.append( ForesterUtil.getLineSeparator() );
 492         sb.append( "Duplications sum                   : " + getDuplicationsSum() );
 493         sb.append( ForesterUtil.getLineSeparator() );
 494         if ( !_most_parsimonious_duplication_model ) {
 495             sb.append( "Speciation or duplications sum     : " + getSpeciationOrDuplicationEventsSum() );
 496             sb.append( ForesterUtil.getLineSeparator() );
 497         }
 498         sb.append( "mapping cost L                     : " + computeMappingCostL() );
 499         return sb.toString();
 500     }
 501
 502     static final int[] obtainMinMaxIdIndices( final PhylogenyNode[] linked_nodes ) {
 503         int max_i = 0;
 504         int min_i = 0;
 505         int max_i_id = -Integer.MAX_VALUE;
 506         int min_i_id = Integer.MAX_VALUE;
 507         for( int i = 0; i < linked_nodes.length; ++i ) {
 508             final int id_i = linked_nodes[ i ].getId();
 509             if ( id_i > max_i_id ) {
 510                 max_i = i;
 511                 max_i_id = linked_nodes[ max_i ].getId();
 512             }
 513             if ( id_i < min_i_id ) {
 514                 min_i = i;
 515                 min_i_id = linked_nodes[ min_i ].getId();
 516             }
 517         }
 518         return new int[] { min_i, max_i };
 519     }
 520     /**
 521      * Updates the mapping function M after the root of the gene tree has been
 522      * moved by one branch. It calculates M for the root of the gene tree and
 523      * one of its two children.
 524      * <p>
 525      * To be used ONLY by method "SDIunrooted.fastInfer(Phylogeny,Phylogeny)".
 526      * <p>
 527      * (Last modfied: )
 528      *
 529      * @param prev_root_was_dup
 530      *            true if the previous root was a duplication, false otherwise
 531      * @param prev_root_c1
 532      *            child 1 of the previous root
 533      * @param prev_root_c2
 534      *            child 2 of the previous root
 535      * @return number of duplications which have been assigned in gene tree
 536      */
 537     // int updateM( final boolean prev_root_was_dup,
 538     // final PhylogenyNode prev_root_c1, final PhylogenyNode prev_root_c2 ) {
 539     // final PhylogenyNode root = getGeneTree().getRoot();
 540     // if ( ( root.getChildNode1() == prev_root_c1 )
 541     // || ( root.getChildNode2() == prev_root_c1 ) ) {
 542     // calculateMforNode( prev_root_c1 );
 543     // }
 544     // else {
 545     // calculateMforNode( prev_root_c2 );
 546     // }
 547     // Event event = null;
 548     // if ( prev_root_was_dup ) {
 549     // event = Event.createSingleDuplicationEvent();
 550     // }
 551     // else {
 552     // event = Event.createSingleSpeciationEvent();
 553     // }
 554     // root.getPhylogenyNodeData().setEvent( event );
 555     // calculateMforNode( root );
 556     // return getDuplications();
 557     // } // updateM( boolean, PhylogenyNode, PhylogenyNode )
 558     // Helper method for updateM( boolean, PhylogenyNode, PhylogenyNode )
 559     // Calculates M for PhylogenyNode n, given that M for the two children
 560     // of n has been calculated.
 561     // (Last modified: 10/02/01)
 562     // private void calculateMforNode( final PhylogenyNode n ) {
 563     // if ( !n.isExternal() ) {
 564     // boolean was_duplication = n.isDuplication();
 565     // PhylogenyNode a = n.getChildNode1().getLink(), b = n
 566     // .getChildNode2().getLink();
 567     // while ( a != b ) {
 568     // if ( a.getID() > b.getID() ) {
 569     // a = a.getParent();
 570     // }
 571     // else {
 572     // b = b.getParent();
 573     // }
 574     // }
 575     // n.setLink( a );
 576     // Event event = null;
 577     // if ( ( a == n.getChildNode1().getLink() )
 578     // || ( a == n.getChildNode2().getLink() ) ) {
 579     // event = Event.createSingleDuplicationEvent();
 580     // if ( !was_duplication ) {
 581     // increaseDuplications();
 582     // }
 583     // }
 584     // else {
 585     // event = Event.createSingleSpeciationEvent();
 586     // if ( was_duplication ) {
 587     // decreaseDuplications();
 588     // }
 589     // }
 590     // n.getPhylogenyNodeData().setEvent( event );
 591     // }
 592     // } // calculateMforNode( PhylogenyNode )
 593 }