forester/java/src/org/forester/sdi/SDIR.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 // Copyright (C) 2000-2001 Washington University School of Medicine
   8 // and Howard Hughes Medical Institute
   9 // All rights reserved
  10 //
  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.
  15 //
  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.
  20 //
  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
  24 //
  25 // Contact: phylosoft @ gmail . com
  26 // WWW: www.phylosoft.org/forester
  27
  28 package org.forester.sdi;
  29
  30 import java.util.ArrayList;
  31 import java.util.HashSet;
  32 import java.util.List;
  33 import java.util.Set;
  34
  35 import org.forester.phylogeny.Phylogeny;
  36 import org.forester.phylogeny.PhylogenyBranch;
  37 import org.forester.phylogeny.PhylogenyNode;
  38 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  39
  40 /*
  41  * Allows to infer duplications - speciations on a unrooted gene tree. It
  42  * reroots the gene trees on each of its branches and performs SDIse on each of
  43  * the resulting trees. Trees which minimize a certain criterion are returned as
  44  * the "correctly" rooted ones. The criterions are: <ul> <li>Sum of duplications
  45  * <li>Mapping cost L <li>Phylogeny height - which is the largest distance from
  46  * root to external node (minimizing of which is the same as "midpoint rooting")
  47  * </ul>
  48  *
  49  * @see SDIse
  50  *
  51  * @see SDI
  52  *
  53  * @author Christian M. Zmasek
  54  */
  55 public class SDIR {
  56
  57     private final static double ZERO_DIFF = 1.0E-6; // Due to inaccurate
  58     // calculations on
  59     // Java's side, not
  60     // everything that should
  61     // be 0.0 is 0.0.
  62     private int                 _count;
  63     private int                 _min_dup;
  64     private int                 _min_cost;
  65     private double              _min_height;
  66     private double              _min_diff;
  67     private long                _time_sdi;
  68
  69     /**
  70      * Default contructor which creates an "empty" object..
  71      */
  72     public SDIR() {
  73         init();
  74     }
  75
  76     /**
  77      * Returns the number of differently rooted trees which minimize the
  78      * (rooting) "criterion" - as determined by method "infer".
  79      *
  80      * @see #infer(Phylogeny,Phylogeny,boolean,boolean,boolean,boolean,int,boolean)
  81      * @return number of differently rooted trees which minimized the criterion
  82      */
  83     public int getCount() {
  84         return _count;
  85     }
  86
  87     /**
  88      * Returns the (absolue value of the) minimal difference in tree heights of
  89      * the two subtrees at the root (of the (re)rooted gene tree) - as
  90      * determined by method "infer" - if minimize_height is set to true.
  91      * <p>
  92      * If a tree is midpoint rooted this number is zero.
  93      * <p>
  94      * <B>IMPORTANT </B>: If minimize_mapping_cost or minimize_sum_of_dup are
  95      * also set to true, then this returns the minimal difference in tree
  96      * heights of the trees which minimize the first criterion, and is therefore
  97      * not necessarily zero.
  98      * <p>
  99      * (Last modified: 01/22/00)
 100      *
 101      * @see #infer(Phylogeny,Phylogeny,boolean,boolean,boolean,boolean,int,boolean)
 102      * @return the minimal difference in tree heights -- IF calculated by
 103      *         "infer"
 104      */
 105     public double getMinimalDiffInSubTreeHeights() {
 106         return _min_diff;
 107     }
 108
 109     /**
 110      * Returns the minimal number of duplications - as determined by method
 111      * "infer".
 112      * <p>
 113      * <B>IMPORTANT </B>: If the tree is not rooted by minimizing the sum of
 114      * duplications or the mapping cost L, then this number is NOT NECESSARILY
 115      * the MINIMAL number of duplications.
 116      *
 117      * @see #infer(Phylogeny,Phylogeny,boolean,boolean,boolean,boolean,int,boolean)
 118      * @return (minimal) number of duplications
 119      */
 120     public int getMinimalDuplications() {
 121         return _min_dup;
 122     }
 123
 124     /**
 125      * Returns the minimal mapping cost L - as determined by method "infer" - if
 126      * minimize_mapping_cost is set to true.
 127      * <p>
 128      * (Last modified: 11/07/00)
 129      *
 130      * @see #infer(Phylogeny,Phylogeny,boolean,boolean,boolean,boolean,int,boolean)
 131      * @return the minimal mapping cost "L" -- IF calculated by "infer"
 132      */
 133     public int getMinimalMappingCost() {
 134         return _min_cost;
 135     }
 136
 137     /**
 138      * Returns the minimal tree height - as determined by method "infer" - if
 139      * minimize_height is set to true. <B>IMPORTANT </B>: If
 140      * minimize_mapping_cost or minimize_sum_of_dup are also set to true, then
 141      * this returns the minimal tree height of the trees which minimize the
 142      * first criterion.
 143      * <p>
 144      * (Last modified: 01/12/00)
 145      *
 146      * @see #infer(Phylogeny,Phylogeny,boolean,boolean,boolean,boolean,int,boolean)
 147      * @return the minimal tree height -- IF calculated by "infer"
 148      */
 149     public double getMinimalTreeHeight() {
 150         return _min_height;
 151     }
 152
 153     /**
 154      * Returns the sum of times (in ms) needed to run method infer of class SDI.
 155      * Final variable TIME needs to be set to true.
 156      *
 157      * @return sum of times (in ms) needed to run method infer of class SDI
 158      */
 159     public long getTimeSumSDI() {
 160         return _time_sdi;
 161     }
 162
 163     /**
 164      * Infers gene duplications on a possibly unrooted gene Phylogeny gene_tree.
 165      * The tree is rooted be minimizing either the sum of duplications, the
 166      * mapping cost L, or the tree height (or combinations thereof). If
 167      * return_trees is set to true, it returns an array of possibly more than
 168      * one differently rooted Trees. <br>
 169      * The maximal number of returned trees is set with max_trees_to_return.
 170      * <br>
 171      * Phylogeny species_tree is a species Phylogeny to which the gene Phylogeny
 172      * gene_tree is compared to. <br>
 173      * If both minimize_sum_of_dup and minimize_mapping_cost are true, the tree
 174      * is rooted by minimizing the mapping cost L.<br>
 175      * If minimize_sum_of_dup, minimize_mapping_cost, and minimize_height are
 176      * false tree gene_tree is assumed to be alreadty rooted and no attempts at
 177      * rooting are made, and only one tree is returned. <br>
 178      * <p>
 179      * Conditions:
 180      * </p>
 181      * <ul>
 182      * <li>Both Trees must be completely binary (except deepest node of gene
 183      * tree)
 184      * <li>The species Phylogeny must be rooted
 185      * <li>Both Trees must have species names in the species name fields of
 186      * their nodes
 187      * <li>Both Trees must not have any collapses nodes
 188      * </ul>
 189      * <p>
 190      * (Last modified: 10/01/01)
 191      *
 192      * @param gene_tree
 193      *            a binary (except deepest node) gene Phylogeny
 194      * @param species_tree
 195      *            a rooted binary species Phylogeny
 196      * @param minimize_mapping_cost
 197      *            set to true to root by minimizing the mapping cost L (and also
 198      *            the sum of duplications)
 199      * @param minimize_sum_of_dup
 200      *            set to true to root by minimizing the sum of duplications
 201      * @param minimize_height
 202      *            set to true to root by minimizing the tree height - if
 203      *            minimize_mapping_cost is set to true or minimize_sum_of_dup is
 204      *            set to true, then out of the resulting trees with minimal
 205      *            mapping cost or minimal number of duplications the tree with
 206      *            the minimal height is chosen
 207      * @param return_trees
 208      *            set to true to return Array of Trees, otherwise null is
 209      *            returned
 210      * @param max_trees_to_return
 211      *            maximal number of Trees to return (=maximal size of returned
 212      *            Array) must be no lower than 1
 213      * @return array of rooted Trees with duplication vs. speciation assigned if
 214      *         return_trees is set to true, null otherwise
 215      * @throws SDIException
 216      */
 217     public Phylogeny[] infer( final Phylogeny gene_tree,
 218                               final Phylogeny species_tree,
 219                               final boolean minimize_mapping_cost,
 220                               boolean minimize_sum_of_dup,
 221                               final boolean minimize_height,
 222                               final boolean return_trees,
 223                               int max_trees_to_return ) throws SDIException {
 224         init();
 225         SDIse sdise = null;
 226         final ArrayList<Phylogeny> trees = new ArrayList<Phylogeny>();
 227         Phylogeny[] tree_array = null;
 228         List<PhylogenyBranch> branches = null;
 229         Phylogeny g = null;
 230         PhylogenyNode prev_root = null;
 231         PhylogenyNode prev_root_c1 = null;
 232         PhylogenyNode prev_root_c2 = null;
 233         int duplications = 0;
 234         int cost = 0;
 235         int counter = 0;
 236         int min_duplications = Integer.MAX_VALUE;
 237         int min_cost = Integer.MAX_VALUE;
 238         int j = 0;
 239         double height = 0.0;
 240         double diff = 0.0;
 241         double min_height = Double.MAX_VALUE;
 242         double min_diff = 0.0;
 243         double[] height__diff = new double[ 2 ];
 244         boolean smaller = false;
 245         boolean equal = false;
 246         boolean prev_root_was_dup = false;
 247         if ( max_trees_to_return < 1 ) {
 248             max_trees_to_return = 1;
 249         }
 250         if ( minimize_mapping_cost && minimize_sum_of_dup ) {
 251             minimize_sum_of_dup = false;
 252         }
 253         if ( !minimize_mapping_cost && !minimize_sum_of_dup && !minimize_height ) {
 254             throw new IllegalArgumentException( "parameter to minimize not given for rooting of phylogeny" );
 255         }
 256         g = gene_tree.copy();
 257         if ( g.getNumberOfExternalNodes() <= 1 ) {
 258             g.setRooted( true );
 259             setMinimalDuplications( 0 );
 260             setMinimalTreeHeight( 0.0 );
 261             tree_array = new Phylogeny[ 1 ];
 262             tree_array[ 0 ] = g;
 263             return tree_array;
 264         }
 265         for( final PhylogenyNodeIterator iter = g.iteratorPostorder(); iter.hasNext(); ) {
 266             final PhylogenyNode n = iter.next();
 267             if ( n.isRoot() ) {
 268                 if ( ( n.getNumberOfDescendants() != 2 ) && ( n.getNumberOfDescendants() != 3 ) ) {
 269                     throw new SDIException( "gene tree has " + n.getNumberOfDescendants() + " descendents at its root" );
 270                 }
 271             }
 272             else if ( !n.isExternal() && ( n.getNumberOfDescendants() != 2 ) ) {
 273                 throw new SDIException( "gene tree is not completely binary" );
 274             }
 275         }
 276         for( final PhylogenyNodeIterator iter = species_tree.iteratorPostorder(); iter.hasNext(); ) {
 277             final PhylogenyNode n = iter.next();
 278             if ( !n.isExternal() && ( n.getNumberOfDescendants() != 2 ) ) {
 279                 throw new SDIException( "species tree (after stripping) is not completely binary" );
 280             }
 281         }
 282         g.reRoot( g.getFirstExternalNode() );
 283         branches = SDIR.getBranchesInPreorder( g );
 284         if ( minimize_mapping_cost || minimize_sum_of_dup ) {
 285             sdise = new SDIse( g, species_tree );
 286             duplications = sdise.getDuplicationsSum();
 287         }
 288         final Set<PhylogenyBranch> used_root_placements = new HashSet<PhylogenyBranch>();
 289         F: for( j = 0; j < branches.size(); ++j ) {
 290             prev_root = g.getRoot();
 291             prev_root_c1 = prev_root.getChildNode1();
 292             prev_root_c2 = prev_root.getChildNode2();
 293             prev_root_was_dup = prev_root.isDuplication();
 294             final PhylogenyBranch current_branch = branches.get( j );
 295             g.reRoot( current_branch );
 296             if ( minimize_mapping_cost || minimize_sum_of_dup ) {
 297                 duplications = sdise.updateM( prev_root_was_dup, prev_root_c1, prev_root_c2 );
 298             }
 299             if ( !used_root_placements.contains( current_branch ) ) {
 300                 if ( minimize_mapping_cost ) {
 301                     cost = sdise.computeMappingCostL();
 302                     if ( minimize_height && ( cost <= min_cost ) ) {
 303                         height__diff = SDIR.moveRootOnBranchToMinHeight( g );
 304                         height = height__diff[ 0 ];
 305                         diff = height__diff[ 1 ];
 306                     }
 307                     if ( cost == min_cost ) {
 308                         if ( minimize_height ) {
 309                             smaller = equal = false;
 310                             if ( height < min_height ) {
 311                                 min_height = height;
 312                                 counter = 1;
 313                                 smaller = true;
 314                             }
 315                             else if ( height == min_height ) {
 316                                 counter++;
 317                                 equal = true;
 318                             }
 319                             if ( Math.abs( diff ) < min_diff ) {
 320                                 min_diff = Math.abs( diff );
 321                             }
 322                         }
 323                         if ( return_trees ) {
 324                             if ( minimize_height ) {
 325                                 if ( smaller ) {
 326                                     trees.clear();
 327                                     trees.add( g.copy() );
 328                                 }
 329                                 else if ( equal && ( trees.size() < max_trees_to_return ) ) {
 330                                     trees.add( g.copy() );
 331                                 }
 332                             }
 333                             else {
 334                                 counter++;
 335                                 if ( trees.size() < max_trees_to_return ) {
 336                                     trees.add( g.copy() );
 337                                 }
 338                             }
 339                         }
 340                         else if ( !minimize_height ) {
 341                             counter++;
 342                         }
 343                     }
 344                     else if ( cost < min_cost ) {
 345                         if ( minimize_height ) {
 346                             min_height = height;
 347                             min_diff = Math.abs( diff );
 348                         }
 349                         if ( return_trees ) {
 350                             trees.clear();
 351                             trees.add( g.copy() );
 352                         }
 353                         counter = 1;
 354                         min_cost = cost;
 355                     }
 356                     if ( duplications < min_duplications ) {
 357                         min_duplications = duplications;
 358                     }
 359                 }
 360                 else if ( minimize_sum_of_dup ) {
 361                     if ( minimize_height && ( duplications <= min_duplications ) ) {
 362                         height__diff = SDIR.moveRootOnBranchToMinHeight( g );
 363                         height = height__diff[ 0 ];
 364                         diff = height__diff[ 1 ];
 365                     }
 366                     if ( duplications == min_duplications ) {
 367                         if ( minimize_height ) {
 368                             smaller = equal = false;
 369                             if ( height < min_height ) {
 370                                 min_height = height;
 371                                 counter = 1;
 372                                 smaller = true;
 373                             }
 374                             else if ( height == min_height ) {
 375                                 counter++;
 376                                 equal = true;
 377                             }
 378                             if ( Math.abs( diff ) < min_diff ) {
 379                                 min_diff = Math.abs( diff );
 380                             }
 381                         }
 382                         if ( return_trees ) {
 383                             if ( minimize_height ) {
 384                                 if ( smaller ) {
 385                                     trees.clear();
 386                                     trees.add( g.copy() );
 387                                 }
 388                                 else if ( equal && ( trees.size() < max_trees_to_return ) ) {
 389                                     trees.add( g.copy() );
 390                                 }
 391                             }
 392                             else {
 393                                 counter++;
 394                                 if ( trees.size() < max_trees_to_return ) {
 395                                     trees.add( g.copy() );
 396                                 }
 397                             }
 398                         }
 399                         else if ( !minimize_height ) {
 400                             counter++;
 401                         }
 402                     }
 403                     else if ( duplications < min_duplications ) {
 404                         if ( minimize_height ) {
 405                             min_height = height;
 406                             min_diff = Math.abs( diff );
 407                         }
 408                         if ( return_trees ) {
 409                             trees.clear();
 410                             trees.add( g.copy() );
 411                         }
 412                         counter = 1;
 413                         min_duplications = duplications;
 414                     }
 415                 }
 416                 else if ( minimize_height ) {
 417                     height__diff = SDIR.moveRootOnBranchToMinHeight( g );
 418                     height = height__diff[ 0 ];
 419                     diff = height__diff[ 1 ];
 420                     if ( Math.abs( diff ) < SDIR.ZERO_DIFF ) {
 421                         sdise = new SDIse( g, species_tree );
 422                         min_duplications = sdise.getDuplicationsSum();
 423                         min_height = height;
 424                         min_diff = Math.abs( diff );
 425                         counter = 1;
 426                         if ( return_trees ) {
 427                             trees.add( g.copy() );
 428                         }
 429                         break F;
 430                     }
 431                 }
 432             } // if ( used_root_placements.containsKey( current_branch ) )
 433             used_root_placements.add( current_branch );
 434         } // End of huge for loop "F".
 435         if ( return_trees ) {
 436             trees.trimToSize();
 437             tree_array = new Phylogeny[ trees.size() ];
 438             for( int i = 0; i < trees.size(); ++i ) {
 439                 tree_array[ i ] = trees.get( i );
 440                 tree_array[ i ].recalculateNumberOfExternalDescendants( false );
 441             }
 442         }
 443         setCount( counter );
 444         setMinimalDuplications( min_duplications );
 445         setMinimalMappingCost( min_cost );
 446         setMinimalTreeHeight( min_height );
 447         setMinimalDiffInSubTreeHeights( Math.abs( min_diff ) );
 448         return tree_array;
 449     }
 450
 451     private void init() {
 452         _count = -1;
 453         _min_dup = Integer.MAX_VALUE;
 454         _min_cost = Integer.MAX_VALUE;
 455         _min_height = Double.MAX_VALUE;
 456         _min_diff = Double.MAX_VALUE;
 457         _time_sdi = -1;
 458     }
 459
 460     private void setCount( final int i ) {
 461         _count = i;
 462     }
 463
 464     private void setMinimalDiffInSubTreeHeights( final double d ) {
 465         _min_diff = d;
 466     }
 467
 468     private void setMinimalDuplications( final int i ) {
 469         _min_dup = i;
 470     }
 471
 472     private void setMinimalMappingCost( final int i ) {
 473         _min_cost = i;
 474     }
 475
 476     private void setMinimalTreeHeight( final double d ) {
 477         _min_height = d;
 478     }
 479
 480     // This was totally changed on 2006/10/03.
 481     // Places references to all Branches of Phylogeny t into a List.
 482     // The order is preorder.
 483     // Trees are treated as if they were unrooted (i.e. child 1 and
 484     // child 2 of the root are treated as if they were connected
 485     // directly).
 486     // The resulting List allows to visit all branches without ever
 487     // traversing more than one node at a time.
 488     public static List<PhylogenyBranch> getBranchesInPreorder( final Phylogeny t ) {
 489         final ArrayList<PhylogenyBranch> branches = new ArrayList<PhylogenyBranch>();
 490         if ( t.isEmpty() || ( t.getNumberOfExternalNodes() <= 1 ) ) {
 491             return branches;
 492         }
 493         if ( t.getNumberOfExternalNodes() == 2 ) {
 494             branches.add( new PhylogenyBranch( t.getRoot().getChildNode1(), t.getRoot().getChildNode2() ) );
 495             return branches;
 496         }
 497         final Set<Integer> one = new HashSet<Integer>();
 498         final Set<Integer> two = new HashSet<Integer>();
 499         PhylogenyNode node = t.getRoot();
 500         while ( !node.isRoot() || !two.contains( node.getId() ) ) {
 501             if ( !node.isExternal() && !two.contains( node.getId() ) ) {
 502                 if ( !one.contains( node.getId() ) && !two.contains( node.getId() ) ) {
 503                     one.add( node.getId() );
 504                     node = node.getChildNode1();
 505                 }
 506                 else {
 507                     two.add( node.getId() );
 508                     node = node.getChildNode2();
 509                 }
 510                 if ( !node.getParent().isRoot() ) {
 511                     branches.add( new PhylogenyBranch( node, node.getParent() ) );
 512                 }
 513                 else if ( !node.isExternal() ) {
 514                     branches.add( new PhylogenyBranch( t.getRoot().getChildNode1(), t.getRoot().getChildNode2() ) );
 515                 }
 516             }
 517             else {
 518                 if ( !node.getParent().isRoot() && !node.isExternal() ) {
 519                     branches.add( new PhylogenyBranch( node, node.getParent() ) );
 520                 }
 521                 node = node.getParent();
 522             }
 523         }
 524         return branches;
 525     }
 526
 527     // This places the root of t on its branch in such a way that it
 528     // minimizes the tree height as good as possible.
 529     // Returns the height and the difference in heights of the resulting
 530     // modified Phylogeny t.
 531     private static double[] moveRootOnBranchToMinHeight( final Phylogeny t ) {
 532         final PhylogenyNode root = t.getRoot();
 533         if ( root.getNumberOfDescendants() != 2 ) {
 534             throw new IllegalArgumentException( "attempt to move root to minimize height on root where number of child nodes does not equal two" );
 535         }
 536         final PhylogenyNode child0 = root.getChildNode( 0 );
 537         final PhylogenyNode child1 = root.getChildNode( 1 );
 538         final double newdist = 0.5 * ( ( child0.getDistanceToParent() > 0 ? child0.getDistanceToParent() : 0 ) + ( child1
 539                 .getDistanceToParent() > 0 ? child1.getDistanceToParent() : 0 ) );
 540         child0.setDistanceToParent( newdist );
 541         child1.setDistanceToParent( newdist );
 542         final double d = child0.getDistanceToParent();
 543         double diff = 0.0;
 544         double height = 0.0;
 545         final double[] height_diff = new double[ 2 ];
 546         final double l0 = t.calculateSubtreeHeight( t.getRoot().getChildNode( 0 ) );
 547         final double l1 = t.calculateSubtreeHeight( t.getRoot().getChildNode( 1 ) );
 548         diff = l0 - l1;
 549         height = t.getHeight();
 550         if ( d > 0.0 ) {
 551             if ( ( 2 * d ) > Math.abs( diff ) ) {
 552                 child0.setDistanceToParent( d - ( diff / 2.0 ) );
 553                 child1.setDistanceToParent( d + ( diff / 2.0 ) );
 554                 height_diff[ 0 ] = height - Math.abs( diff / 2 );
 555                 height_diff[ 1 ] = 0.0;
 556             }
 557             else {
 558                 if ( diff > 0 ) {
 559                     child0.setDistanceToParent( 0.0 );
 560                     child1.setDistanceToParent( 2 * d );
 561                     height_diff[ 1 ] = diff - ( 2 * d );
 562                 }
 563                 else {
 564                     child0.setDistanceToParent( 2 * d );
 565                     child1.setDistanceToParent( 0.0 );
 566                     height_diff[ 1 ] = diff + ( 2 * d );
 567                 }
 568                 height_diff[ 0 ] = height - d;
 569             }
 570         }
 571         else {
 572             height_diff[ 0 ] = height;
 573             height_diff[ 1 ] = diff;
 574         }
 575         return height_diff;
 576     }
 577 }