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