forester/java/src/org/forester/sdi/GSDIR.java

   1 // $Id:\r
   2 // FORESTER -- software libraries and applications\r
   3 // for evolutionary biology research and applications.\r
   4 //\r
   5 // Copyright (C) 2008-2013 Christian M. Zmasek\r
   6 // All rights reserved\r
   7 //\r
   8 // This library is free software; you can redistribute it and/or\r
   9 // modify it under the terms of the GNU Lesser General Public\r
  10 // License as published by the Free Software Foundation; either\r
  11 // version 2.1 of the License, or (at your option) any later version.\r
  12 //\r
  13 // This library is distributed in the hope that it will be useful,\r
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
  16 // Lesser General Public License for more details.\r
  17 //\r
  18 // You should have received a copy of the GNU Lesser General Public\r
  19 // License along with this library; if not, write to the Free Software\r
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
  21 //\r
  22 // Contact: phylosoft @ gmail . com\r
  23 // WWW: www.phylosoft.org\r
  24 \r
  25 package org.forester.sdi;\r
  26 \r
  27 import java.util.ArrayList;\r
  28 import java.util.List;\r
  29 import java.util.Set;\r
  30 import java.util.SortedSet;\r
  31 \r
  32 import org.forester.phylogeny.Phylogeny;\r
  33 import org.forester.phylogeny.PhylogenyBranch;\r
  34 import org.forester.phylogeny.PhylogenyMethods;\r
  35 import org.forester.phylogeny.PhylogenyNode;\r
  36 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;\r
  37 import org.forester.sdi.SDIutil.TaxonomyComparisonBase;\r
  38 import org.forester.util.BasicDescriptiveStatistics;\r
  39 \r
  40 public class GSDIR implements GSDII {\r
  41 \r
  42     private final int                        _min_duplications_sum;\r
  43     private final int                        _speciations_sum;\r
  44     private final BasicDescriptiveStatistics _duplications_sum_stats;\r
  45     private Phylogeny                        _min_duplications_sum_gene_tree;\r
  46     private final List<PhylogenyNode>        _stripped_gene_tree_nodes;\r
  47     private final List<PhylogenyNode>        _stripped_species_tree_nodes;\r
  48     private final Set<PhylogenyNode>         _mapped_species_tree_nodes;\r
  49     private final TaxonomyComparisonBase     _tax_comp_base;\r
  50     private final SortedSet<String>          _scientific_names_mapped_to_reduced_specificity;\r
  51 \r
  52     public GSDIR( final Phylogeny gene_tree,\r
  53                   final Phylogeny species_tree,\r
  54                   final boolean strip_gene_tree,\r
  55                   final boolean strip_species_tree ) throws SDIException {\r
  56         final NodesLinkingResult nodes_linking_result = GSDI.linkNodesOfG( gene_tree,\r
  57                                                                            species_tree,\r
  58                                                                            strip_gene_tree,\r
  59                                                                            strip_species_tree );\r
  60         _stripped_gene_tree_nodes = nodes_linking_result.getStrippedGeneTreeNodes();\r
  61         _stripped_species_tree_nodes = nodes_linking_result.getStrippedSpeciesTreeNodes();\r
  62         _mapped_species_tree_nodes = nodes_linking_result.getMappedSpeciesTreeNodes();\r
  63         _scientific_names_mapped_to_reduced_specificity = nodes_linking_result\r
  64                 .getScientificNamesMappedToReducedSpecificity();\r
  65         _tax_comp_base = nodes_linking_result.getTaxCompBase();\r
  66         final List<PhylogenyBranch> gene_tree_branches_post_order = new ArrayList<PhylogenyBranch>();\r
  67         for( final PhylogenyNodeIterator it = gene_tree.iteratorPostorder(); it.hasNext(); ) {\r
  68             final PhylogenyNode n = it.next();\r
  69             if ( !n.isRoot() && !( n.getParent().isRoot() && ( gene_tree.getRoot().getNumberOfDescendants() == 2 ) ) ) {\r
  70                 gene_tree_branches_post_order.add( new PhylogenyBranch( n, n.getParent() ) );\r
  71             }\r
  72         }\r
  73         if ( gene_tree.getRoot().getNumberOfDescendants() == 2 ) {\r
  74             gene_tree_branches_post_order.add( new PhylogenyBranch( gene_tree.getRoot().getChildNode1(), gene_tree\r
  75                     .getRoot().getChildNode2() ) );\r
  76         }\r
  77         int min_duplications_sum = Integer.MAX_VALUE;\r
  78         int speciations_sum = 0;\r
  79         _duplications_sum_stats = new BasicDescriptiveStatistics();\r
  80         for( final PhylogenyBranch branch : gene_tree_branches_post_order ) {\r
  81             reRoot( branch, gene_tree );\r
  82             PhylogenyMethods.preOrderReId( species_tree );\r
  83           \r
  84             final GSDIsummaryResult gsdi_result = GSDI.geneTreePostOrderTraversal( gene_tree,\r
  85                                                                                    true,\r
  86                                                                                    min_duplications_sum );\r
  87             if ( gsdi_result == null ) {\r
  88                 continue;\r
  89             }\r
  90             if ( gsdi_result.getDuplicationsSum() < min_duplications_sum ) {\r
  91                 min_duplications_sum = gsdi_result.getDuplicationsSum();\r
  92                 speciations_sum = gsdi_result.getSpeciationsSum();\r
  93                 _min_duplications_sum_gene_tree = gene_tree.copy();\r
  94             }\r
  95             else if ( gsdi_result.getDuplicationsSum() == min_duplications_sum ) {\r
  96                 final List<Phylogeny> l = new ArrayList<Phylogeny>();\r
  97                 l.add( _min_duplications_sum_gene_tree );\r
  98                 l.add( gene_tree );\r
  99                 final int index = getIndexesOfShortestTree( l ).get( 0 );\r
 100                 if ( index == 1 ) {\r
 101                     _min_duplications_sum_gene_tree = gene_tree.copy();\r
 102                 }\r
 103             }\r
 104             _duplications_sum_stats.addValue( gsdi_result.getDuplicationsSum() );\r
 105         }\r
 106         _min_duplications_sum = min_duplications_sum;\r
 107         _speciations_sum = speciations_sum;\r
 108     }\r
 109 \r
 110     public BasicDescriptiveStatistics getDuplicationsSumStats() {\r
 111         return _duplications_sum_stats;\r
 112     }\r
 113 \r
 114     @Override\r
 115     public Set<PhylogenyNode> getMappedExternalSpeciesTreeNodes() {\r
 116         return _mapped_species_tree_nodes;\r
 117     }\r
 118 \r
 119     public int getMinDuplicationsSum() {\r
 120         return _min_duplications_sum;\r
 121     }\r
 122 \r
 123     public Phylogeny getMinDuplicationsSumGeneTree() {\r
 124         return _min_duplications_sum_gene_tree;\r
 125     }\r
 126 \r
 127     @Override\r
 128     public final SortedSet<String> getReMappedScientificNamesFromGeneTree() {\r
 129         return _scientific_names_mapped_to_reduced_specificity;\r
 130     }\r
 131 \r
 132     @Override\r
 133     public int getSpeciationsSum() {\r
 134         return _speciations_sum;\r
 135     }\r
 136 \r
 137     @Override\r
 138     public List<PhylogenyNode> getStrippedExternalGeneTreeNodes() {\r
 139         return _stripped_gene_tree_nodes;\r
 140     }\r
 141 \r
 142     @Override\r
 143     public List<PhylogenyNode> getStrippedSpeciesTreeNodes() {\r
 144         return _stripped_species_tree_nodes;\r
 145     }\r
 146 \r
 147     @Override\r
 148     public TaxonomyComparisonBase getTaxCompBase() {\r
 149         return _tax_comp_base;\r
 150     }\r
 151 \r
 152     public final static List<Integer> getIndexesOfShortestTree( final List<Phylogeny> assigned_trees ) {\r
 153         final List<Integer> shortests = new ArrayList<Integer>();\r
 154         boolean depth = true;\r
 155         double x = Double.MAX_VALUE;\r
 156         for( int i = 0; i < assigned_trees.size(); ++i ) {\r
 157             final Phylogeny phy = assigned_trees.get( i );\r
 158             if ( i == 0 ) {\r
 159                 if ( PhylogenyMethods.calculateMaxDistanceToRoot( phy ) > 0 ) {\r
 160                     depth = false;\r
 161                 }\r
 162             }\r
 163             final double d;\r
 164             if ( depth ) {\r
 165                 d = PhylogenyMethods.calculateMaxDepth( phy );\r
 166             }\r
 167             else {\r
 168                 d = PhylogenyMethods.calculateMaxDistanceToRoot( phy );\r
 169             }\r
 170             if ( d < x ) {\r
 171                 x = d;\r
 172                 shortests.clear();\r
 173                 shortests.add( i );\r
 174             }\r
 175             else if ( d == x ) {\r
 176                 shortests.add( i );\r
 177             }\r
 178         }\r
 179         return shortests;\r
 180     }\r
 181 \r
 182     /**\r
 183      * Places the root of this Phylogeny on Branch b. The new root is always\r
 184      * placed on the middle of the branch b.\r
 185      * \r
 186      */\r
 187     static final void reRoot( final PhylogenyBranch b, final Phylogeny phy ) {\r
 188         final PhylogenyNode n1 = b.getFirstNode();\r
 189         final PhylogenyNode n2 = b.getSecondNode();\r
 190         if ( n1.isExternal() ) {\r
 191             phy.reRoot( n1 );\r
 192         }\r
 193         else if ( n2.isExternal() ) {\r
 194             phy.reRoot( n2 );\r
 195         }\r
 196         else if ( ( n2 == n1.getChildNode1() ) || ( n2 == n1.getChildNode2() ) ) {\r
 197             phy.reRoot( n2 );\r
 198         }\r
 199         else if ( ( n1 == n2.getChildNode1() ) || ( n1 == n2.getChildNode2() ) ) {\r
 200             phy.reRoot( n1 );\r
 201         }\r
 202         //        else if ( ( n1.getParent() != null ) && n1.getParent().isRoot()\r
 203         //                && ( ( n1.getParent().getChildNode1() == n2 ) || ( n1.getParent().getChildNode2() == n2 ) ) ) {\r
 204         //            phy.reRoot( n1 );\r
 205         //           \r
 206         //        }\r
 207         else {\r
 208             throw new IllegalArgumentException( "reRoot( Branch b ): b is not a branch." );\r
 209         }\r
 210     }\r
 211 }\r