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