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