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