2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2014 Christian M. Zmasek
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.
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.
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
22 // Contact: phylosoft @ gmail . com
23 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
25 package org.forester.evoinference.distance;
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;
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;
39 public final class NeighborJoiningR {
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;
49 private final boolean _verbose;
53 private double _d_min; //TODO remove me
54 private int[] _rev_mappings;
56 private NeighborJoiningR() {
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 );
67 _df = new DecimalFormat();
68 _df.setMaximumFractionDigits( maximum_fraction_digits_for_distances );
69 _df.setRoundingMode( RoundingMode.HALF_UP );
72 public final Phylogeny execute( final BasicSymmetricalDistanceMatrix distance ) {
74 final Phylogeny phylogeny = new Phylogeny();
77 System.out.println( "N=" + _n );
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;
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 ] );
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;
97 _external_nodes[ otu1 ].setDistanceToParent( d1 );
98 getExternalPhylogenyNode( otu2 ).setDistanceToParent( d2 );
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 ) ) );
105 node.addAsChild( _external_nodes[ otu1 ] );
106 node.addAsChild( getExternalPhylogenyNode( otu2 ) );
108 printProgress( otu1, otu2, node );
111 System.out.println( "otu1=" + otu1 );
112 System.out.println( "otu2=" + otu2 );
114 calculateDistancesFromNewNode( otu1, otu2, d );
115 // _external_nodes[ _mappings[ otu1 ] ] = node;
116 _external_nodes[ otu1 ] = node;
117 updateMappings( otu2 );
120 System.out.println( "" );
122 .println( "----------------------------------------------------------------------------------" );
123 System.out.println( "" );
126 final double d = getDvalue( 0, 1 ) / 2;
128 getExternalPhylogenyNode( 0 ).setDistanceToParent( d );
129 getExternalPhylogenyNode( 1 ).setDistanceToParent( d );
132 final double dd = Double.parseDouble( _df.format( d ) );
133 getExternalPhylogenyNode( 0 ).setDistanceToParent( dd );
134 getExternalPhylogenyNode( 1 ).setDistanceToParent( dd );
136 final PhylogenyNode root = new PhylogenyNode();
137 root.addAsChild( getExternalPhylogenyNode( 0 ) );
138 root.addAsChild( getExternalPhylogenyNode( 1 ) );
140 printProgress( 0, 1, root );
142 phylogeny.setRoot( root );
143 phylogeny.setRooted( false );
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 ) );
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 ] ) ) {
160 updateDvalue( otu1, otu2, j, d );
163 System.out.println();
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 ) );
172 _s.removePairing( getDvalueUnmapped( otu1, mj ), otu1, mj );
175 _s.removePairing( getDvalueUnmapped( otu1, mj ), mj, otu1 );
177 if ( _mappings[ otu2 ] < mj ) {
178 _s.removePairing( getDvalue( j, otu2 ), _mappings[ otu2 ], mj );
181 _s.removePairing( getDvalue( j, otu2 ), mj, _mappings[ otu2 ] );
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;
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;
196 private double getDvalue( final int i, final int j ) {
198 return _d_values[ _mappings[ i ] ][ _mappings[ j ] ];
200 return _d_values[ _mappings[ j ] ][ _mappings[ i ] ];
203 private double getDvalueUnmapped( final int i, final int j ) {
205 return _d_values[ i ][ j ];
207 return _d_values[ j ][ i ];
210 private final void calculateNetDivergences() {
211 for( int i = 0; i < _n; ++i ) {
212 _r[ i ] = calculateNetDivergence( i );
216 private double calculateNetDivergence( final int i ) {
218 for( int n = 0; n < _n; ++n ) {
220 d += getDvalue( n, i );
226 private final PhylogenyNode getExternalPhylogenyNode( final int i ) {
227 return _external_nodes[ _mappings[ i ] ];
230 private final void initExternalNodes() {
231 _external_nodes = new PhylogenyNode[ _n ];
233 for( int i = 0; i < _n; ++i ) {
234 _external_nodes[ i ] = new PhylogenyNode();
235 id = _d.getIdentifier( i );
237 _external_nodes[ i ].setName( id );
240 _external_nodes[ i ].setName( Integer.toString( i ) );
243 _rev_mappings[ i ] = i;
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 ) ) + "]" );
253 private final String printProgressNodeToString( final PhylogenyNode n ) {
254 if ( n.isExternal() ) {
255 if ( ForesterUtil.isEmpty( n.getName() ) ) {
256 return Long.toString( n.getId() );
262 + ( ForesterUtil.isEmpty( n.getChildNode1().getName() ) ? n.getChildNode1().getId() : n.getChildNode1()
265 + ( ForesterUtil.isEmpty( n.getChildNode2().getName() ) ? n.getChildNode2().getId() : n.getChildNode2()
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();
274 _r = new double[ _n ];
275 _mappings = new int[ _n ];
276 _rev_mappings = new int[ _n ];
277 _d_values = distances.getValues();
279 _s.initialize( distances );
282 System.out.println();
284 System.out.println( "----------------------------------------------------------------------------------" );
285 System.out.println();
286 System.out.println();
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( " " );
298 System.out.println();
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( " " );
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() ) {
313 System.out.print( "," );
316 System.out.print( v );
318 System.out.print( " " );
320 System.out.println();
324 private final double updateM() {
325 calculateNetDivergences();
326 Double min_m = Double.MAX_VALUE;
329 final int n_minus_2 = _n - 2;
333 for( int j = 1; j < _n; ++j ) {
334 final double r_j = _r[ j ];
335 final int m_j = _mappings[ j ];
337 System.out.print( "j=" + j + " mj=" + m_j + ": " );
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 );
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( " " );
363 System.out.println();
367 System.out.println();
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 ] );
379 // for( int i = 0; i < _mappings.length; ++i ) {
380 // System.out.println( i + "-->" + _mappings[ i ] );
382 for( int i = 0; i < _n; ++i ) {
383 _rev_mappings[ _mappings[ i ] ] = i;
387 public final static NeighborJoiningR createInstance() {
388 return new NeighborJoiningR();
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 );