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