forester/java/src/org/forester/pccx/ModelingUtils.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.pccx;
  27
  28 import java.util.SortedMap;
  29 import java.util.TreeMap;
  30
  31 import org.forester.phylogeny.Phylogeny;
  32 import org.forester.phylogeny.PhylogenyMethods;
  33 import org.forester.phylogeny.PhylogenyNode;
  34 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  35
  36 /*
  37  * @author Christian M. Zmasek
  38  */
  39 public final class ModelingUtils {
  40
  41     static double calculateBranchLengthSum( final PhylogenyNode n1, final PhylogenyNode n2 ) {
  42         final PhylogenyNode lca = PhylogenyMethods.getInstance().obtainLCA( n1, n2 );
  43         return ModelingUtils.calculateBranchLengthSumHelper( n1, lca )
  44                 + ModelingUtils.calculateBranchLengthSumHelper( n2, lca );
  45     }
  46
  47     private static double calculateBranchLengthSumHelper( final PhylogenyNode outer, final PhylogenyNode inner ) {
  48         PhylogenyNode my_outer = outer;
  49         double l = 0;
  50         while ( my_outer != inner ) {
  51             if ( my_outer.getDistanceToParent() > 0.0 ) {
  52                 l += my_outer.getDistanceToParent();
  53             }
  54             my_outer = my_outer.getParent();
  55         }
  56         return l;
  57     }
  58
  59     static int calculateBranchSum( final PhylogenyNode n1, final PhylogenyNode n2 ) {
  60         final PhylogenyNode lca = PhylogenyMethods.getInstance().obtainLCA( n1, n2 );
  61         return ModelingUtils.calculateBranchSumHelper( n1, lca ) + ModelingUtils.calculateBranchSumHelper( n2, lca );
  62     }
  63
  64     private static int calculateBranchSumHelper( final PhylogenyNode outer, final PhylogenyNode inner ) {
  65         PhylogenyNode my_outer = outer;
  66         int s = 0;
  67         while ( my_outer != inner ) {
  68             s++;
  69             my_outer = my_outer.getParent();
  70         }
  71         return s;
  72     }
  73
  74     static SortedMap<PhylogenyNode, Double> setUpExternalCoverageHashMap( final Phylogeny phylogeny ) {
  75         final SortedMap<PhylogenyNode, Double> external_node_coverage = new TreeMap<PhylogenyNode, Double>();
  76         for( final PhylogenyNodeIterator iter = phylogeny.iteratorExternalForward(); iter.hasNext(); ) {
  77             external_node_coverage.put( iter.next(), 0.0 );
  78         }
  79         return external_node_coverage;
  80     }
  81 }