3 // FORESTER -- software libraries and applications
4 // for evolutionary biology research and applications.
6 // Copyright (C) 2008-2009 Christian M. Zmasek
7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Lesser General Public
12 // License as published by the Free Software Foundation; either
13 // version 2.1 of the License, or (at your option) any later version.
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 // Contact: phylosoft @ gmail . com
25 // WWW: www.phylosoft.org/forester
27 package org.forester.evoinference.matrix.distance;
29 import java.io.IOException;
30 import java.io.Writer;
31 import java.text.DecimalFormat;
32 import java.text.NumberFormat;
33 import java.util.StringTokenizer;
35 import org.forester.util.ForesterUtil;
36 import org.forester.util.IllegalFormatUseException;
38 public final class BasicSymmetricalDistanceMatrix implements DistanceMatrix {
40 // NumberFormat nf1 = NumberFormat.getInstance();
41 private final static NumberFormat PHYLIP_FORMATTER = new DecimalFormat( "0.000000" );
42 final double[][] _values;
43 final String[] _identifiers;
45 public BasicSymmetricalDistanceMatrix( final int size ) {
46 _values = new double[ size ][ size ];
47 _identifiers = new String[ size ];
50 public final double[][] getValues() {
55 public final String getIdentifier( final int i ) {
56 return _identifiers[ i ];
60 public final int getIndex( final String identifier ) {
61 for( int i = 0; i < _identifiers.length; i++ ) {
62 if ( getIdentifier( i ).equals( identifier ) ) {
66 throw new IllegalArgumentException( "identifier [" + identifier + "] not found in distance matrix" );
70 public final int getSize() {
71 return _values.length;
75 public final double getValue( final int col, final int row ) {
77 if ( col >= _values.length ) {
78 throw new IndexOutOfBoundsException( "" );
82 else if ( col > row ) {
83 return _values[ row ][ col ];
85 return _values[ col ][ row ];
88 public final void randomize( final long seed ) {
89 final java.util.Random r = new java.util.Random( seed );
90 for( int j = 0; j < getSize(); ++j ) {
91 for( int i = 0; i < j; ++i ) {
92 setValue( i, j, r.nextDouble() );
98 public final void setIdentifier( final int i, final String identifier ) {
99 _identifiers[ i ] = identifier;
102 public final void setRow( final String s, final int row ) {
103 final StringTokenizer tk = new StringTokenizer( s );
105 while ( tk.hasMoreElements() ) {
106 setValue( i, row, new Double( tk.nextToken() ).doubleValue() );
112 public final void setValue( final int col, final int row, final double d ) {
113 if ( ( col == row ) && ( d != 0.0 ) ) {
114 throw new IllegalArgumentException( "attempt to set a non-zero value on the diagonal of a symmetrical distance matrix" );
116 else if ( col > row ) {
117 _values[ row ][ col ] = d;
119 _values[ col ][ row ] = d;
122 public final void write( final Writer w ) throws IOException {
124 w.write( getSize() + "" );
125 w.write( ForesterUtil.LINE_SEPARATOR );
126 for( int row = 0; row < getSize(); ++row ) {
127 if ( !ForesterUtil.isEmpty( getIdentifier( row ) ) ) {
128 w.write( ForesterUtil.pad( getIdentifier( row ), 10, ' ', false ).toString() );
133 throw new IllegalFormatUseException( "Phylip format does not allow empty identifiers" );
135 for( int col = 0; col < getSize(); ++col ) {
136 w.write( PHYLIP_FORMATTER.format( getValue( col, row ) ) );
137 if ( col < getSize() - 1 ) {
142 if ( row < getSize() - 1 ) {
143 w.write( ForesterUtil.LINE_SEPARATOR );
148 private final StringBuffer toPhylip() {
149 final StringBuffer sb = new StringBuffer();
154 sb.append( getSize() );
155 sb.append( ForesterUtil.LINE_SEPARATOR );
156 for( int row = 0; row < getSize(); ++row ) {
157 if ( !ForesterUtil.isEmpty( getIdentifier( row ) ) ) {
158 sb.append( ForesterUtil.pad( getIdentifier( row ), 10, ' ', false ) );
163 throw new IllegalFormatUseException( "Phylip format does not allow empty identifiers" );
166 for( int col = 0; col < getSize(); ++col ) {
167 sb.append( PHYLIP_FORMATTER.format( getValue( col, row ) ) );
168 if ( col < getSize() - 1 ) {
173 if ( row < getSize() - 1 ) {
174 sb.append( ForesterUtil.LINE_SEPARATOR );
181 public final String toString() {
182 return toPhylip().toString();
186 public final StringBuffer toStringBuffer( final Format format ) {
191 throw new IllegalArgumentException( "Unknown format:" + format );