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             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 double d = _d_values[ otu1 ][ _mappings[ otu2 ] ];
  90             final double d1 = ( d / 2 ) + ( ( _r[  _rev_mappings[ otu1 ] ] - _r[ otu2 ] ) / ( 2 * ( _n - 2 ) ) );
  91             final double 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 double d = getDvalue( 0, 1 ) / 2;
 118         if ( _df == null ) {
 119             getExternalPhylogenyNode( 0 ).setDistanceToParent( d );
 120             getExternalPhylogenyNode( 1 ).setDistanceToParent( d );
 121         }
 122         else {
 123             final double dd = Double.parseDouble( _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 double d ) {
 147         System.out.print( "new D values: " );
 148         for( int j = 0; j < _n; ++j ) {
 149             if ( j == otu2 ) {
 150                 continue;
 151             }
 152             if ( otu1  < _mappings[ j ] ) {
 153                 updateDvalue( otu1, otu2, j, d );
 154             }
 155         }
 156         System.out.println();
 157     }
 158
 159     private final void updateDvalue( final int otu1, final int otu2, final int j, final double d ) {
 160         final double new_d = ( getDvalueUnmapped( otu1, _mappings[ j ] ) + getDvalue( j, otu2 ) - d ) / 2;
 161         System.out.print( DF.format( new_d ) + " " );
 162        // System.out.println( "going to remove: " + getDvalueUnmapped( otu1, _mappings[ j ] ) + ", " + otu1 + ", "
 163        //         + _mappings[ j ] );
 164
 165         if (  otu1< _mappings[ j ] ) {
 166             _s.removePairing( getDvalueUnmapped( otu1, _mappings[ j ] ), otu1, _mappings[ j ] );
 167         }
 168         else {
 169             _s.removePairing( getDvalueUnmapped( otu1, _mappings[ j ] ), _mappings[ j ] ,  otu1 );
 170         }
 171
 172
 173       //  System.out.println( "going to remove: " + getDvalue( j, otu2 ) + ", " +_mappings[ otu2 ] + ", "
 174       //          + _mappings[ j ] );
 175
 176         if (   _mappings[ otu2  ] < _mappings[ j ] ) {
 177             _s.removePairing( getDvalue( j, otu2 ),    _mappings[ otu2  ] , _mappings[ j ] );
 178         }
 179         else {
 180             _s.removePairing( getDvalue( j, otu2 )   , _mappings[ j ],   _mappings[ otu2  ] );
 181
 182         }
 183
 184         _s.addPairing( new_d, otu1, _mappings[ j ] );
 185         setDvalueU( otu1, j, new_d );
 186     }
 187
 188     private void setDvalueU( final int i, final int j, final double d ) {
 189         if ( i < _mappings[ j ] ) {
 190             _d_values[ i ][ _mappings[ j ] ] = d;
 191         }
 192         _d_values[_mappings[ j] ][  i  ] = d;
 193     }
 194
 195     private double getDvalue( final int i, final int j ) {
 196         if ( i < j ) {
 197             return _d_values[ _mappings[ i ] ][ _mappings[ j ] ];
 198         }
 199         return _d_values[ _mappings[ j ] ][ _mappings[ i ] ];
 200     }
 201
 202     private double getDvalueUnmapped( final int i, final int j ) {
 203         if ( i < j ) {
 204             return _d_values[ i ][ j ];
 205         }
 206         return _d_values[ j ][ i ];
 207     }
 208
 209     private final void calculateNetDivergences() {
 210         for( int i = 0; i < _n; ++i ) {
 211             _r[ i ] = calculateNetDivergence( i );
 212         }
 213     }
 214
 215     private double calculateNetDivergence( final int i ) {
 216         double 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 = _d.getValues();
 277         _s = new S();
 278         _s.initialize( distances );
 279         initExternalNodes();
 280         System.out.println();
 281         printM();
 282         System.out.println( "----------------------------------------------------------------------------------" );
 283         System.out.println();
 284         System.out.println();
 285     }
 286
 287     final private void printM() {
 288         for( int j = 0; j < _d_values.length; ++j ) {
 289             System.out.print( _external_nodes[ j ] );
 290             System.out.print( "\t\t" );
 291             for( int i = 0; i < _d_values[ j ].length; ++i ) {
 292                 System.out.print( DF.format( _d_values[ i ][ j ] ) );
 293                 System.out.print( " " );
 294             }
 295             System.out.println();
 296         }
 297         for( int j = 0; j < _n; ++j ) {
 298             System.out.print( getExternalPhylogenyNode( j ) );
 299             System.out.print( "\t\t" );
 300             for( int i = 0; i < _n; ++i ) {
 301                 System.out.print( DF.format( _d_values[ _mappings[ i ] ][ _mappings[ j ] ] ) );
 302                 System.out.print( " " );
 303             }
 304             System.out.print( "\t\t" );
 305             for( final Entry<Integer, SortedSet<Integer>> entry : _s.getSentrySet( _mappings[ j ] ) ) {
 306                 System.out.print( DF.format( ( double ) entry.getKey() / S.FACTOR ) + "=" );
 307                 boolean first = true;
 308                 for( final int v : entry.getValue() ) {
 309                     if ( !first ) {
 310                         System.out.print( "," );
 311                     }
 312                     first = false;
 313                     System.out.print( v );
 314                 }
 315                 System.out.print( "  " );
 316             }
 317             System.out.println();
 318         }
 319     }
 320
 321     private final double updateM() {
 322         calculateNetDivergences();
 323         Double min_m = Double.MAX_VALUE;
 324         _min_i = -1;
 325         _min_j = -1;
 326         final int n_minus_2 = _n - 2;
 327         printM();
 328         for( int j = 1; j < _n; ++j ) {
 329             final double r_j = _r[ j ];
 330             final int m_j = _mappings[ j ];
 331             System.out.print( "j=" + j + "  mj=" + m_j + ":  " );
 332             for( final Entry<Integer, SortedSet<Integer>> entry : _s.getSentrySet( m_j ) ) {
 333                 for( final int sorted_i : entry.getValue() ) {
 334                     System.out.print( sorted_i + " " );
 335                     System.out.print( "(" + DF.format( getDvalueUnmapped( sorted_i, m_j ) ) + ") " );
 336                     final double m = getDvalueUnmapped( sorted_i, m_j )
 337                             - ( ( _r[ _rev_mappings[ sorted_i ] ] + r_j ) / n_minus_2 );
 338                     if ( ( m < min_m ) ) {
 339                         _d_min = getDvalueUnmapped( sorted_i, m_j );
 340                         min_m = m;
 341                         _min_i = sorted_i;
 342                         _min_j = j;
 343                     }
 344                 }
 345             }
 346             System.out.println();
 347             for( final Entry<Integer, SortedSet<Integer>> entry : _s.getSentrySet( m_j ) ) {
 348                 for( final int sorted_i : entry.getValue() ) {
 349                     System.out.print( sorted_i );
 350                     System.out.print( "->" );
 351                     System.out.print( DF.format( _r[ sorted_i ] ) );
 352                     System.out.print( "  " );
 353                 }
 354             }
 355             System.out.println();
 356             /*
 357             for( int i = 0; i < j; ++i ) {
 358                 final double m = getDvalue( i, j ) - ( ( _r[ i ] + r_j ) / n_minus_2 );
 359                 if ( m < min ) {
 360                     min = m;
 361                     _d_min = getDvalue( i, j );
 362                     _min_i = i;
 363                     _min_j = j;
 364                 }
 365             }*/
 366         }
 367         System.out.println();
 368         return min_m;
 369     }
 370
 371     // otu2 will, in effect, be "deleted" from the matrix.
 372     private final void updateMappings( final int otu2 ) {
 373         for( int i = otu2; i < ( _mappings.length - 1 ); ++i ) {
 374             System.out.print( _mappings[ i ] );
 375             _mappings[ i ] = _mappings[ i + 1 ];
 376             System.out.println( "----->" + _mappings[ i ] );
 377         }
 378         for( int i = 0; i < _mappings.length; ++i ) {
 379             System.out.println( i + "-->" + _mappings[ i ] );
 380         }
 381         for( int i = 0; i < _n; ++i ) {
 382             _rev_mappings[ _mappings[ i ] ] = i;
 383         }
 384     }
 385
 386     public final static NeighborJoiningR createInstance() {
 387         return new NeighborJoiningR();
 388     }
 389
 390     public final static NeighborJoiningR createInstance( final boolean verbose,
 391                                                          final int maximum_fraction_digits_for_distances ) {
 392         return new NeighborJoiningR( verbose, maximum_fraction_digits_for_distances );
 393     }
 394 }