forester/java/src/org/forester/evoinference/distance/NeighborJoiningR.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 import java.util.Map.Entry;
  32 import java.util.Set;
  33
  34 import org.forester.evoinference.matrix.distance.BasicSymmetricalDistanceMatrix;
  35 import org.forester.phylogeny.Phylogeny;
  36 import org.forester.phylogeny.PhylogenyNode;
  37 import org.forester.util.ForesterUtil;
  38
  39 public final class NeighborJoiningR {
  40
  41     private final static DecimalFormat     DF = new DecimalFormat( "0.00000" );
  42     private BasicSymmetricalDistanceMatrix _d;
  43     private double[][]                     _d_values;
  44     private final DecimalFormat            _df;
  45     private PhylogenyNode[]                _external_nodes;
  46     private int[]                          _mappings;
  47     private int                            _n;
  48     private double[]                       _r;
  49     private final boolean                  _verbose;
  50     private int                            _min_i;
  51     private int                            _min_j;
  52     private S                              _s;
  53     private double                         _d_min;                             //TODO remove me
  54     private int[]                          _rev_mappings;
  55     private double                         _umax;
  56     private double                         _rmax;
  57
  58     private NeighborJoiningR() {
  59         _verbose = false;
  60         _df = null;
  61     }
  62
  63     private NeighborJoiningR( final boolean verbose, final int maximum_fraction_digits_for_distances ) {
  64         if ( ( maximum_fraction_digits_for_distances < 1 ) || ( maximum_fraction_digits_for_distances > 9 ) ) {
  65             throw new IllegalArgumentException( "maximum fraction digits for distances is out of range: "
  66                     + maximum_fraction_digits_for_distances );
  67         }
  68         _verbose = verbose;
  69         _df = new DecimalFormat();
  70         _df.setMaximumFractionDigits( maximum_fraction_digits_for_distances );
  71         _df.setRoundingMode( RoundingMode.HALF_UP );
  72     }
  73
  74     public final Phylogeny execute( final BasicSymmetricalDistanceMatrix distance ) {
  75         reset( distance );
  76         final Phylogeny phylogeny = new Phylogeny();
  77         while ( _n > 2 ) {
  78             if ( _verbose ) {
  79                 System.out.println( "N=" + _n );
  80                 System.out.println();
  81             }
  82             // Calculates the minimal distance.
  83             // If more than one minimal distances, always the first found is used
  84             updateM();
  85             final int otu1 = _min_i;
  86             final int otu2 = _min_j;
  87             //if ( _verbose ) {
  88             //   System.out.println( _min_i + " " + _min_j + " => " + DF.format( m ) + " (" + DF.format( _d_min ) + ")" );
  89             // It is a condition that otu1 < otu2.
  90             //System.out.println( "mapped 1 " + _mappings[ otu1 ] );
  91             //  System.out.println( "mapped otu 2 " + _mappings[ otu2 ] );
  92             //  }
  93             final PhylogenyNode node = new PhylogenyNode();
  94             //final double d = getDvalueUnmapped( otu1, _mappings[ otu2 ] );
  95             final double d = _d_values[ otu1 ][ _mappings[ otu2 ] ];
  96             final double d1 = ( d / 2 ) + ( ( _r[ _rev_mappings[ otu1 ] ] - _r[ otu2 ] ) / ( 2 * ( _n - 2 ) ) );
  97             final double d2 = d - d1;
  98             if ( _df == null ) {
  99                 _external_nodes[ otu1 ].setDistanceToParent( d1 );
 100                 getExternalPhylogenyNode( otu2 ).setDistanceToParent( d2 );
 101             }
 102             else {
 103                 // yes, yes, slow but only grows with n (and not n^2 or worse)...
 104                 _external_nodes[ otu1 ].setDistanceToParent( Double.parseDouble( _df.format( d1 ) ) );
 105                 getExternalPhylogenyNode( otu2 ).setDistanceToParent( Double.parseDouble( _df.format( d2 ) ) );
 106             }
 107             node.addAsChild( _external_nodes[ otu1 ] );
 108             node.addAsChild( getExternalPhylogenyNode( otu2 ) );
 109             if ( _verbose ) {
 110                 printProgress( otu1, otu2, node );
 111             }
 112             if ( _verbose ) {
 113                 System.out.println( "otu1=" + otu1 );
 114                 System.out.println( "otu2=" + otu2 );
 115             }
 116             calculateDistancesFromNewNode( otu1, otu2, d );
 117             // _external_nodes[ _mappings[ otu1 ] ] = node;
 118             _external_nodes[ otu1 ] = node;
 119             updateMappings( otu2 );
 120             --_n;
 121             if ( _verbose ) {
 122                 System.out.println( "" );
 123                 System.out
 124                         .println( "----------------------------------------------------------------------------------" );
 125                 System.out.println( "" );
 126             }
 127         }
 128         final double d = getDvalue( 0, 1 ) / 2;
 129         if ( _df == null ) {
 130             getExternalPhylogenyNode( 0 ).setDistanceToParent( d );
 131             getExternalPhylogenyNode( 1 ).setDistanceToParent( d );
 132         }
 133         else {
 134             final double dd = Double.parseDouble( _df.format( d ) );
 135             getExternalPhylogenyNode( 0 ).setDistanceToParent( dd );
 136             getExternalPhylogenyNode( 1 ).setDistanceToParent( dd );
 137         }
 138         final PhylogenyNode root = new PhylogenyNode();
 139         root.addAsChild( getExternalPhylogenyNode( 0 ) );
 140         root.addAsChild( getExternalPhylogenyNode( 1 ) );
 141         if ( _verbose ) {
 142             printProgress( 0, 1, root );
 143         }
 144         phylogeny.setRoot( root );
 145         phylogeny.setRooted( false );
 146         return phylogeny;
 147     }
 148
 149     public final List<Phylogeny> execute( final List<BasicSymmetricalDistanceMatrix> distances_list ) {
 150         final List<Phylogeny> pl = new ArrayList<Phylogeny>();
 151         for( final BasicSymmetricalDistanceMatrix distances : distances_list ) {
 152             pl.add( execute( distances ) );
 153         }
 154         return pl;
 155     }
 156
 157     private final void calculateDistancesFromNewNode( final int otu1, final int otu2, final double d ) {
 158         for( int j = 0; j < _n; ++j ) {
 159             if ( ( j == otu2 ) || ( j == _rev_mappings[ otu1 ] ) ) {
 160                 continue;
 161             }
 162             updateDvalue( otu1, otu2, j, d );
 163         }
 164         if ( _verbose ) {
 165             System.out.println();
 166         }
 167     }
 168
 169     private final void updateDvalue( final int otu1, final int otu2, final int j, final double d ) {
 170         final int mj = _mappings[ j ];
 171         //  final double new_d = ( getDvalueUnmapped( otu1, _mappings[ j ] ) + getDvalue( j, otu2 ) - d ) / 2;
 172         // System.out.println( "\nnew d value: " + DF.format( new_d ) );
 173         if ( otu1 < mj ) {
 174             _s.removePairing( _d_values[ otu1 ][ mj ], otu1, mj );
 175         }
 176         else {
 177             _s.removePairing( _d_values[ mj ][ otu1 ], mj, otu1 );
 178         }
 179         if ( _mappings[ otu2 ] < mj ) {
 180             _s.removePairing( getDvalue( j, otu2 ), _mappings[ otu2 ], mj );
 181         }
 182         else {
 183             _s.removePairing( getDvalue( j, otu2 ), mj, _mappings[ otu2 ] );
 184         }
 185         double new_d;
 186         if ( otu1 < mj ) {
 187             new_d = ( _d_values[ otu1 ][ mj ] + getDvalue( j, otu2 ) - d ) / 2;
 188             _s.addPairing( new_d, otu1, mj );
 189             _d_values[ otu1 ][ mj ] = new_d;
 190         }
 191         else {
 192             new_d = ( _d_values[ mj ][ otu1 ] + getDvalue( j, otu2 ) - d ) / 2;
 193             _s.addPairing( new_d, mj, otu1 );
 194             _d_values[ mj ][ otu1 ] = new_d;
 195         }
 196     }
 197
 198     private double getDvalue( final int i, final int j ) {
 199         if ( i < j ) {
 200             return _d_values[ _mappings[ i ] ][ _mappings[ j ] ];
 201         }
 202         return _d_values[ _mappings[ j ] ][ _mappings[ i ] ];
 203     }
 204
 205     private final void calculateNetDivergences() {
 206         _rmax = -Double.MAX_VALUE;
 207         for( int i = 0; i < _n; ++i ) {
 208             _r[ i ] = calculateNetDivergence( i );
 209             if ( _r[ i ] > _rmax ) {
 210                 _rmax = _r[ i ];
 211             }
 212         }
 213     }
 214
 215     private double calculateNetDivergence( final int i ) {
 216         float d = 0;
 217         for( int n = 0; n < _n; ++n ) {
 218             if ( i != n ) {
 219                 d += getDvalue( n, i );
 220             }
 221         }
 222         return d;
 223     }
 224
 225     private final PhylogenyNode getExternalPhylogenyNode( final int i ) {
 226         return _external_nodes[ _mappings[ i ] ];
 227     }
 228
 229     private final void initExternalNodes() {
 230         _external_nodes = new PhylogenyNode[ _n ];
 231         String id;
 232         for( int i = 0; i < _n; ++i ) {
 233             _external_nodes[ i ] = new PhylogenyNode();
 234             id = _d.getIdentifier( i );
 235             if ( id != null ) {
 236                 _external_nodes[ i ].setName( id );
 237             }
 238             else {
 239                 _external_nodes[ i ].setName( Integer.toString( i ) );
 240             }
 241             _mappings[ i ] = i;
 242             _rev_mappings[ i ] = i;
 243         }
 244     }
 245
 246     private final void printProgress( final int otu1, final int otu2, final PhylogenyNode node ) {
 247         System.out.println( "Node " + printProgressNodeToString( _external_nodes[ otu1 ] ) + " joins "
 248                 + ( printProgressNodeToString( getExternalPhylogenyNode( otu2 ) ) ) + " [resulting in node "
 249                 + ( printProgressNodeToString( node ) ) + "]" );
 250     }
 251
 252     private final String printProgressNodeToString( final PhylogenyNode n ) {
 253         if ( n.isExternal() ) {
 254             if ( ForesterUtil.isEmpty( n.getName() ) ) {
 255                 return Long.toString( n.getId() );
 256             }
 257             return n.getName();
 258         }
 259         return n.getId()
 260                 + " ("
 261                 + ( ForesterUtil.isEmpty( n.getChildNode1().getName() ) ? n.getChildNode1().getId() : n.getChildNode1()
 262                         .getName() )
 263                 + "+"
 264                 + ( ForesterUtil.isEmpty( n.getChildNode2().getName() ) ? n.getChildNode2().getId() : n.getChildNode2()
 265                         .getName() ) + ")";
 266     }
 267
 268     // only the values in the lower triangle are used.
 269     // !matrix values will be changed!
 270     private final void reset( final BasicSymmetricalDistanceMatrix distances ) {
 271         _n = distances.getSize();
 272         _d = distances;
 273         _r = new double[ _n ];
 274         _mappings = new int[ _n ];
 275         _rev_mappings = new int[ _n ];
 276         _d_values = distances.getValues();
 277         _s = new S();
 278         _s.initialize( distances );
 279         initExternalNodes();
 280         if ( _verbose ) {
 281             System.out.println();
 282             printM();
 283             System.out.println( "----------------------------------------------------------------------------------" );
 284             System.out.println();
 285             System.out.println();
 286         }
 287     }
 288
 289     final private void printM() {
 290         for( int j = 0; j < _d_values.length; ++j ) {
 291             System.out.print( _external_nodes[ j ] );
 292             System.out.print( "\t\t" );
 293             for( int i = 0; i < _d_values[ j ].length; ++i ) {
 294                 System.out.print( DF.format( _d_values[ i ][ j ] ) );
 295                 System.out.print( " " );
 296             }
 297             System.out.println();
 298         }
 299         for( int j = 0; j < _n; ++j ) {
 300             System.out.print( getExternalPhylogenyNode( j ) );
 301             System.out.print( "\t\t" );
 302             for( int i = 0; i < _n; ++i ) {
 303                 System.out.print( DF.format( _d_values[ _mappings[ i ] ][ _mappings[ j ] ] ) );
 304                 System.out.print( " " );
 305             }
 306             System.out.print( "\t\t" );
 307             for( final Entry<Integer, Set<Integer>> entry : _s.getSentrySet( _mappings[ j ] ) ) {
 308                 System.out.print( DF.format( ( double ) entry.getKey() / S.FACTOR ) + "=" );
 309                 boolean first = true;
 310                 for( final int v : entry.getValue() ) {
 311                     if ( !first ) {
 312                         System.out.print( "," );
 313                     }
 314                     first = false;
 315                     System.out.print( v );
 316                 }
 317                 System.out.print( "  " );
 318             }
 319             System.out.println();
 320         }
 321     }
 322
 323     private final void updateM() {
 324         calculateNetDivergences();
 325         Double min_m = Double.MAX_VALUE;
 326         _min_i = -1;
 327         _min_j = -1;
 328         final int n_minus_2 = _n - 2;
 329         if ( _verbose ) {
 330             printM();
 331         }
 332         //
 333         X: for( int j = 1; j < _n; ++j ) {
 334             final double r_j = _r[ j ];
 335             final int m_j = _mappings[ j ];
 336             for( final Entry<Integer, Set<Integer>> entry : _s.getSentrySet( m_j ) ) {
 337                 for( final int sorted_i : entry.getValue() ) {
 338                     final double m = _d_values[ sorted_i ][ m_j ]
 339                             - ( ( _r[ _rev_mappings[ sorted_i ] ] + r_j ) / n_minus_2 );
 340                     if ( ( m < min_m ) ) {
 341                         min_m = m;
 342                         _min_i = sorted_i;
 343                         _min_j = j;
 344                     }
 345                 }
 346                 continue X;
 347             }
 348         }
 349         //
 350         J: for( int j = 1; j < _n; ++j ) {
 351             //System.out.println( "~~~~~~~~~~~~~  min_m=" + min_m );
 352             final double r_j = _r[ j ];
 353             final int m_j = _mappings[ j ];
 354             boolean first = true;
 355             for( final Entry<Integer, Set<Integer>> entry : _s.getSentrySet( m_j ) ) {
 356                 if ( first ) {
 357                     first = false;
 358                     continue;
 359                 }
 360                 for( final int sorted_i : entry.getValue() ) {
 361                     final double d = _d_values[ sorted_i ][ m_j ];
 362                     if ( ( d - ( ( _umax + r_j ) / n_minus_2 ) ) > min_m ) {
 363                         continue J;
 364                     }
 365                     final double m = d - ( ( _r[ _rev_mappings[ sorted_i ] ] + r_j ) / n_minus_2 );
 366                     if ( ( m < min_m ) ) {
 367                         min_m = m;
 368                         _min_i = sorted_i;
 369                         _min_j = j;
 370                     }
 371                 }
 372             }
 373             if ( _verbose ) {
 374                 System.out.println();
 375                 for( final Entry<Integer, Set<Integer>> entry : _s.getSentrySet( m_j ) ) {
 376                     for( final int sorted_i : entry.getValue() ) {
 377                         System.out.print( sorted_i );
 378                         System.out.print( "->" );
 379                         System.out.print( DF.format( _r[ sorted_i ] ) );
 380                         System.out.print( "  " );
 381                     }
 382                 }
 383                 System.out.println();
 384             }
 385         }
 386         if ( _verbose ) {
 387             System.out.println();
 388         }
 389     }
 390
 391     // otu2 will, in effect, be "deleted" from the matrix.
 392     private final void updateMappings( final int otu2 ) {
 393         for( int i = otu2; i < ( _mappings.length - 1 ); ++i ) {
 394             //System.out.print( _mappings[ i ] );
 395             _mappings[ i ] = _mappings[ i + 1 ];
 396             //System.out.println( "----->" + _mappings[ i ] );
 397         }
 398         // for( int i = 0; i < _mappings.length; ++i ) {
 399         //     System.out.println( i + "-->" + _mappings[ i ] );
 400         // }
 401         for( int i = 0; i < _n; ++i ) {
 402             _rev_mappings[ _mappings[ i ] ] = i;
 403         }
 404     }
 405
 406     public final static NeighborJoiningR createInstance() {
 407         return new NeighborJoiningR();
 408     }
 409
 410     public final static NeighborJoiningR createInstance( final boolean verbose,
 411                                                          final int maximum_fraction_digits_for_distances ) {
 412         return new NeighborJoiningR( verbose, maximum_fraction_digits_for_distances );
 413     }
 414 }