forester/java/src/org/forester/evoinference/distance/NeighborJoining.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2014 Christian M. Zmasek
   6 // All rights reserved
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Lesser General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2.1 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 // Lesser General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Lesser General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  21 //
  22 // Contact: phylosoft @ gmail . com
  23 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  24
  25 package org.forester.evoinference.distance;
  26
  27 import java.math.RoundingMode;
  28 import java.text.DecimalFormat;
  29 import java.util.ArrayList;
  30 import java.util.List;
  31
  32 import org.forester.evoinference.matrix.distance.BasicSymmetricalDistanceMatrix;
  33 import org.forester.phylogeny.Phylogeny;
  34 import org.forester.phylogeny.PhylogenyNode;
  35 import org.forester.util.ForesterUtil;
  36
  37 public final class NeighborJoining {
  38
  39     private BasicSymmetricalDistanceMatrix _d;
  40     private double[][]                     _d_values;
  41     private final DecimalFormat            _df;
  42     private PhylogenyNode[]                _external_nodes;
  43     private int[]                          _mappings;
  44     private int                            _n;
  45     private double[]                       _r;
  46     private final boolean                  _verbose;
  47     private int                            _min_i;
  48     private int                            _min_j;
  49
  50     private NeighborJoining() {
  51         _verbose = false;
  52         _df = null;
  53     }
  54
  55     private NeighborJoining( final boolean verbose, final int maximum_fraction_digits_for_distances ) {
  56         if ( ( maximum_fraction_digits_for_distances < 1 ) || ( maximum_fraction_digits_for_distances > 9 ) ) {
  57             throw new IllegalArgumentException( "maximum fraction digits for distances is out of range: "
  58                     + maximum_fraction_digits_for_distances );
  59         }
  60         _verbose = verbose;
  61         _df = new DecimalFormat();
  62         _df.setMaximumFractionDigits( maximum_fraction_digits_for_distances );
  63         _df.setRoundingMode( RoundingMode.HALF_UP );
  64     }
  65
  66     public final Phylogeny execute( final BasicSymmetricalDistanceMatrix distance ) {
  67         reset( distance );
  68         final Phylogeny phylogeny = new Phylogeny();
  69         while ( _n > 2 ) {
  70             // Calculates the minimal distance.
  71             // If more than one minimal distances, always the first found is used
  72             updateM();
  73             final int otu1 = _min_i;
  74             final int otu2 = _min_j;
  75             System.out.println( _min_i + " " + _min_j );
  76             // It is a condition that otu1 < otu2.
  77             final PhylogenyNode node = new PhylogenyNode();
  78             final double d = _d_values[ _mappings[ otu1 ] ][ _mappings[ otu2 ] ];
  79             final double d1 = ( d / 2 ) + ( ( _r[ otu1 ] - _r[ otu2 ] ) / ( 2 * ( _n - 2 ) ) );
  80             final double d2 = d - d1;
  81             if ( _df == null ) {
  82                 getExternalPhylogenyNode( otu1 ).setDistanceToParent( d1 );
  83                 getExternalPhylogenyNode( otu2 ).setDistanceToParent( d2 );
  84             }
  85             else {
  86                 // yes, yes, slow but only grows with n (and not n^2 or worse)...
  87                 getExternalPhylogenyNode( otu1 ).setDistanceToParent( Double.parseDouble( _df.format( d1 ) ) );
  88                 getExternalPhylogenyNode( otu2 ).setDistanceToParent( Double.parseDouble( _df.format( d2 ) ) );
  89             }
  90             node.addAsChild( getExternalPhylogenyNode( otu1 ) );
  91             node.addAsChild( getExternalPhylogenyNode( otu2 ) );
  92             if ( _verbose ) {
  93                 printProgress( otu1, otu2 );
  94             }
  95             calculateDistancesFromNewNode( otu1, otu2, d );
  96             _external_nodes[ _mappings[ otu1 ] ] = node;
  97             updateMappings( otu2 );
  98             --_n;
  99         }
 100         final double d = _d_values[ _mappings[ 0 ] ][ _mappings[ 1 ] ] / 2;
 101         if ( _df == null ) {
 102             getExternalPhylogenyNode( 0 ).setDistanceToParent( d );
 103             getExternalPhylogenyNode( 1 ).setDistanceToParent( d );
 104         }
 105         else {
 106             final double dd = Double.parseDouble( _df.format( d ) );
 107             getExternalPhylogenyNode( 0 ).setDistanceToParent( dd );
 108             getExternalPhylogenyNode( 1 ).setDistanceToParent( dd );
 109         }
 110         final PhylogenyNode root = new PhylogenyNode();
 111         root.addAsChild( getExternalPhylogenyNode( 0 ) );
 112         root.addAsChild( getExternalPhylogenyNode( 1 ) );
 113         if ( _verbose ) {
 114             printProgress( 0, 1 );
 115         }
 116         phylogeny.setRoot( root );
 117         phylogeny.setRooted( false );
 118         return phylogeny;
 119     }
 120
 121     public final List<Phylogeny> execute( final List<BasicSymmetricalDistanceMatrix> distances_list ) {
 122         final List<Phylogeny> pl = new ArrayList<Phylogeny>();
 123         for( final BasicSymmetricalDistanceMatrix distances : distances_list ) {
 124             pl.add( execute( distances ) );
 125         }
 126         return pl;
 127     }
 128
 129     private final void calculateDistancesFromNewNode( final int otu1, final int otu2, final double d ) {
 130         final int m_otu1 = _mappings[ otu1 ];
 131         final int m_otu2 = _mappings[ otu2 ];
 132         for( int i = 0; i < _n; ++i ) {
 133             if ( ( i == otu1 ) || ( i == otu2 ) ) {
 134                 continue;
 135             }
 136             final int m_i = _mappings[ i ];
 137             if ( otu1 < i ) {
 138                 if ( otu2 > i ) {
 139                     _d_values[ m_otu1 ][ m_i ] = ( _d_values[ m_otu1 ][ m_i ] + _d_values[ m_i ][ m_otu2 ] - d ) / 2;
 140                 }
 141                 else {
 142                     _d_values[ m_otu1 ][ m_i ] = ( _d_values[ m_otu1 ][ m_i ] + _d_values[ m_otu2 ][ m_i ] - d ) / 2;
 143                 }
 144             }
 145             else {
 146                 if ( otu2 > i ) {
 147                     _d_values[ m_i ][ m_otu1 ] = ( _d_values[ m_i ][ m_otu1 ] + _d_values[ m_i ][ m_otu2 ] - d ) / 2;
 148                 }
 149                 else {
 150                     _d_values[ m_i ][ m_otu1 ] = ( _d_values[ m_i ][ m_otu1 ] + _d_values[ m_otu2 ][ m_i ] - d ) / 2;
 151                 }
 152             }
 153         }
 154     }
 155
 156     private final void calculateNetDivergences() {
 157         double d;
 158         for( int i = 0; i < _n; ++i ) {
 159             d = 0;
 160             final int m_i = _mappings[ i ];
 161             for( int n = 0; n < _n; ++n ) {
 162                 if ( i != n ) {
 163                     if ( i > n ) {
 164                         d += _d_values[ _mappings[ n ] ][ m_i ];
 165                     }
 166                     else {
 167                         d += _d_values[ m_i ][ _mappings[ n ] ];
 168                     }
 169                 }
 170             }
 171             _r[ i ] = d;
 172         }
 173     }
 174
 175     private final PhylogenyNode getExternalPhylogenyNode( final int i ) {
 176         return _external_nodes[ _mappings[ i ] ];
 177     }
 178
 179     private final void initExternalNodes() {
 180         _external_nodes = new PhylogenyNode[ _n ];
 181         String id;
 182         for( int i = 0; i < _n; ++i ) {
 183             _external_nodes[ i ] = new PhylogenyNode();
 184             id = _d.getIdentifier( i );
 185             if ( id != null ) {
 186                 _external_nodes[ i ].setName( id );
 187             }
 188             else {
 189                 _external_nodes[ i ].setName( Integer.toString( i ) );
 190             }
 191             _mappings[ i ] = i;
 192         }
 193     }
 194
 195     private final void printProgress( final int otu1, final int otu2 ) {
 196         System.out.println( "Node " + printProgressNodeToString( getExternalPhylogenyNode( otu1 ) ) + " joins "
 197                 + ( printProgressNodeToString( getExternalPhylogenyNode( otu2 ) ) ) );
 198     }
 199
 200     private final String printProgressNodeToString( final PhylogenyNode n ) {
 201         if ( n.isExternal() ) {
 202             if ( ForesterUtil.isEmpty( n.getName() ) ) {
 203                 return Long.toString( n.getId() );
 204             }
 205             return n.getName();
 206         }
 207         return n.getId()
 208                 + " ("
 209                 + ( ForesterUtil.isEmpty( n.getChildNode1().getName() ) ? n.getChildNode1().getId() : n.getChildNode1()
 210                         .getName() )
 211                 + "+"
 212                 + ( ForesterUtil.isEmpty( n.getChildNode2().getName() ) ? n.getChildNode2().getId() : n.getChildNode2()
 213                         .getName() ) + ")";
 214     }
 215
 216     // only the values in the lower triangle are used.
 217     // !matrix values will be changed!
 218     private final void reset( final BasicSymmetricalDistanceMatrix distances ) {
 219         _n = distances.getSize();
 220         _d = distances;
 221         _r = new double[ _n ];
 222         _mappings = new int[ _n ];
 223         _d_values = _d.getValues();
 224         initExternalNodes();
 225     }
 226
 227     private final void updateM() {
 228         calculateNetDivergences();
 229         Double min = Double.MAX_VALUE;
 230         _min_i = -1;
 231         _min_j = -1;
 232         final int n_minus_2 = _n - 2;
 233         for( int j = 1; j < _n; ++j ) {
 234             final double r_j = _r[ j ];
 235             final int m_j = _mappings[ j ];
 236             for( int i = 0; i < j; ++i ) {
 237                 final double m = _d_values[ _mappings[ i ] ][ m_j ] - ( ( _r[ i ] + r_j ) / n_minus_2 );
 238                 if ( m < min ) {
 239                     min = m;
 240                     _min_i = i;
 241                     _min_j = j;
 242                 }
 243             }
 244         }
 245     }
 246
 247     // otu2 will, in effect, be "deleted" from the matrix.
 248     private final void updateMappings( final int otu2 ) {
 249         for( int i = otu2; i < ( _mappings.length - 1 ); ++i ) {
 250             _mappings[ i ] = _mappings[ i + 1 ];
 251         }
 252     }
 253
 254     public final static NeighborJoining createInstance() {
 255         return new NeighborJoining();
 256     }
 257
 258     public final static NeighborJoining createInstance( final boolean verbose,
 259                                                         final int maximum_fraction_digits_for_distances ) {
 260         return new NeighborJoining( verbose, maximum_fraction_digits_for_distances );
 261     }
 262 }