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