/*
Copyright � 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose
is hereby granted without fee, provided that the above copyright notice appear in all copies and
that both that copyright notice and this permission notice appear in supporting documentation.
CERN makes no representations about the suitability of this software for any purpose.
It is provided "as is" without expressed or implied warranty.
*/
package cern.colt.matrix.doublealgo;
import cern.colt.matrix.DoubleMatrix1D;
import cern.colt.matrix.DoubleMatrix2D;
import cern.colt.matrix.DoubleMatrix3D;
import cern.colt.matrix.impl.AbstractFormatter;
import cern.colt.matrix.impl.AbstractMatrix1D;
import cern.colt.matrix.impl.AbstractMatrix2D;
import cern.colt.matrix.impl.DenseDoubleMatrix1D;
import cern.colt.matrix.impl.Former;
/**
Flexible, well human readable matrix print formatting; By default decimal point aligned. Build on top of the C-like <i>sprintf</i> functionality
provided by the {@link corejava.Format} class written by Cay Horstmann.
Currenly works on 1-d, 2-d and 3-d matrices.
Note that in most cases you will not need to get familiar with this class; just call <tt>matrix.toString()</tt> and be happy with the default formatting.
This class is for advanced requirements.
<p> Can't exactly remember the syntax of printf format strings? See {@link corejava.Format}
or <a href="http://www.braju.com/docs/index.html">Henrik
Nordberg's documentation</a>, or the <a href="http://www.dinkumware.com/htm_cl/lib_prin.html#Print%20Functions">Dinkumware's
C Library Reference</a>.
<p><b>Examples:</b>
<p>
Examples demonstrate usage on 2-d matrices. 1-d and 3-d matrices formatting works very similar.
<table border="1" cellspacing="0">
<tr align="center">
<td>Original matrix</td>
</tr>
<tr>
<td>
<p><tt>double[][] values = {<br>
{3, 0, -3.4, 0},<br>
{5.1 ,0, +3.0123456789, 0}, <br>
{16.37, 0.0, 2.5, 0}, <br>
{-16.3, 0, -3.012345678E-4, -1},<br>
{1236.3456789, 0, 7, -1.2}<br>
};<br>
matrix = new DenseDoubleMatrix2D(values);</tt></p>
</td>
</tr>
</table>
<p> </p>
<table border="1" cellspacing="0">
<tr align="center">
<td><tt>format</tt></td>
<td valign="top"><tt>Formatter.toString(matrix);</tt></td>
<td valign="top"><tt>Formatter.toSourceCode(matrix);</tt></td>
</tr>
<tr>
<td><tt>%G </tt><br>
(default)</td>
<td align="left" valign="top"><tt>5 x 4 matrix<br>
3 0 -3.4 0 <br>
5.1 0 3.012346 0 <br>
16.37 0 2.5 0 <br>
-16.3 0 -0.000301 -1 <br>
1236.345679 0 7 -1.2
</tt></td>
<td align="left" valign="top"><tt>{<br>
{ 3 , 0, -3.4 , 0 },<br>
{ 5.1 , 0, 3.012346, 0 },<br>
{ 16.37 , 0, 2.5 , 0 },<br>
{ -16.3 , 0, -0.000301, -1 },<br>
{1236.345679, 0, 7 , -1.2}<br>
}; </tt></td>
</tr>
<tr>
<td><tt>%1.10G</tt></td>
<td align="left" valign="top"><tt>5 x 4 matrix<br>
3 0 -3.4 0 <br>
5.1 0 3.0123456789 0 <br>
16.37 0 2.5 0 <br>
-16.3 0 -0.0003012346 -1 <br>
1236.3456789 0 7 -1.2
</tt></td>
<td align="left" valign="top"><tt>{<br>
{ 3 , 0, -3.4 , 0 },<br>
{ 5.1 , 0, 3.0123456789, 0 },<br>
{ 16.37 , 0, 2.5 , 0 },<br>
{ -16.3 , 0, -0.0003012346, -1 },<br>
{1236.3456789, 0, 7 , -1.2}<br>
}; </tt></td>
</tr>
<tr>
<td><tt>%f</tt></td>
<td align="left" valign="top"> <tt> 5 x 4 matrix<br>
3.000000 0.000000 -3.400000 0.000000<br>
5.100000 0.000000 3.012346 0.000000<br>
16.370000 0.000000 2.500000 0.000000<br>
-16.300000 0.000000 -0.000301 -1.000000<br>
1236.345679 0.000000 7.000000 -1.200000 </tt> </td>
<td align="left" valign="top"><tt> {<br>
{ 3.000000, 0.000000, -3.400000, 0.000000},<br>
{ 5.100000, 0.000000, 3.012346, 0.000000},<br>
{ 16.370000, 0.000000, 2.500000, 0.000000},<br>
{ -16.300000, 0.000000, -0.000301, -1.000000},<br>
{1236.345679, 0.000000, 7.000000, -1.200000}<br>
}; </tt> </td>
</tr>
<tr>
<td><tt>%1.2f</tt></td>
<td align="left" valign="top"><tt>5 x 4 matrix<br>
3.00 0.00 -3.40 0.00<br>
5.10 0.00 3.01 0.00<br>
16.37 0.00 2.50 0.00<br>
-16.30 0.00 -0.00 -1.00<br>
1236.35 0.00 7.00 -1.20 </tt></td>
<td align="left" valign="top"><tt>{<br>
{ 3.00, 0.00, -3.40, 0.00},<br>
{ 5.10, 0.00, 3.01, 0.00},<br>
{ 16.37, 0.00, 2.50, 0.00},<br>
{ -16.30, 0.00, -0.00, -1.00},<br>
{1236.35, 0.00, 7.00, -1.20}<br>
}; </tt></td>
</tr>
<tr>
<td><tt>%0.2e</tt></td>
<td align="left" valign="top"><tt>5 x 4 matrix<br>
3.00e+000 0.00e+000 -3.40e+000 0.00e+000<br>
5.10e+000 0.00e+000 3.01e+000 0.00e+000<br>
1.64e+001 0.00e+000 2.50e+000 0.00e+000<br>
-1.63e+001 0.00e+000 -3.01e-004 -1.00e+000<br>
1.24e+003 0.00e+000 7.00e+000 -1.20e+000 </tt></td>
<td align="left" valign="top"><tt>{<br>
{ 3.00e+000, 0.00e+000, -3.40e+000, 0.00e+000},<br>
{ 5.10e+000, 0.00e+000, 3.01e+000, 0.00e+000},<br>
{ 1.64e+001, 0.00e+000, 2.50e+000, 0.00e+000},<br>
{-1.63e+001, 0.00e+000, -3.01e-004, -1.00e+000},<br>
{ 1.24e+003, 0.00e+000, 7.00e+000, -1.20e+000}<br>
}; </tt></td>
</tr>
<tr>
<td><tt>null</tt></td>
<td align="left" valign="top"><tt>5 x 4 matrix <br>
3.0 0.0 -3.4 0.0<br>
5.1 0.0 3.0123456789 0.0<br>
16.37 0.0 2.5 0.0<br>
-16.3 0.0 -3.012345678E-4 -1.0<br>
1236.3456789 0.0 7.0 -1.2
</tt> <tt> </tt></td>
<td align="left" valign="top"><tt> {<br>
{ 3.0 , 0.0, -3.4 , 0.0},<br>
{ 5.1 , 0.0, 3.0123456789 , 0.0},<br>
{ 16.37 , 0.0, 2.5 , 0.0},<br>
{ -16.3 , 0.0, -3.012345678E-4, -1.0},<br>
{1236.3456789, 0.0, 7.0 , -1.2}<br>
}; </tt> </td>
</tr>
</table>
<p>Here are some more elaborate examples, adding labels for axes, rows, columns,
title and some statistical aggregations.</p>
<table border="1" cellspacing="0">
<tr>
<td nowrap>
<p><tt> double[][] values = {<br>
{5 ,10, 20, 40 },<br>
{ 7, 8 , 6 , 7 },<br>
{12 ,10, 20, 19 },<br>
{ 3, 1 , 5 , 6 }<br>
}; <br>
</tt><tt>String title = "CPU performance over time [nops/sec]";<br>
String columnAxisName = "Year";<br>
String rowAxisName = "CPU"; <br>
String[] columnNames = {"1996", "1997", "1998", "1999"};<br>
String[] rowNames = { "PowerBar", "Benzol", "Mercedes", "Sparcling"};<br>
hep.aida.bin.BinFunctions1D F = hep.aida.bin.BinFunctions1D.functions; // alias<br>
hep.aida.bin.BinFunction1D[] aggr = {F.mean, F.rms, F.quantile(0.25), F.median, F.quantile(0.75), F.stdDev, F.min, F.max};<br>
String format = "%1.2G";<br>
DoubleMatrix2D matrix = new DenseDoubleMatrix2D(values); <br>
new Formatter(format).toTitleString(<br>
matrix,rowNames,columnNames,rowAxisName,columnAxisName,title,aggr); </tt>
</p>
</td>
</tr>
<tr>
<td><tt>
CPU performance over time [nops/sec]<br>
| Year<br>
| 1996 1997 1998 1999 | Mean RMS 25% Q. Median 75% Q. StdDev Min Max<br>
---------------------------------------------------------------------------------------<br>
C PowerBar | 5 10 20 40 | 18.75 23.05 8.75 15 25 15.48 5 40 <br>
P Benzol | 7 8 6 7 | 7 7.04 6.75 7 7.25 0.82 6 8 <br>
U Mercedes | 12 10 20 19 | 15.25 15.85 11.5 15.5 19.25 4.99 10 20 <br>
Sparcling | 3 1 5 6 | 3.75 4.21 2.5 4 5.25 2.22 1 6 <br>
---------------------------------------------------------------------------------------<br>
Mean | 6.75 7.25 12.75 18 | <br>
RMS | 7.53 8.14 14.67 22.62 | <br>
25% Q. | 4.5 6.25 5.75 6.75 | <br>
Median | 6 9 13 13 | <br>
75% Q. | 8.25 10 20 24.25 | <br>
StdDev | 3.86 4.27 8.38 15.81 | <br>
Min | 3 1 5 6 | <br>
Max | 12 10 20 19 |
</tt>
</td>
</tr>
<tr>
<td nowrap><tt> same as above, but now without aggregations<br>
aggr=null; </tt> </td>
</tr>
<tr>
<td><tt> CPU performance over time [nops/sec]<br>
| Year<br>
| 1996 1997 1998 1999<br>
---------------------------------<br>
C PowerBar | 5 10 20 40 <br>
P Benzol | 7 8 6 7 <br>
U Mercedes | 12 10 20 19 <br>
Sparcling | 3 1 5 6
</tt> </td>
</tr>
<tr>
<td nowrap>
<p><tt> same as above, but now without rows labeled<br>
aggr=null;<br>
rowNames=null;<br>
rowAxisName=null; </tt> </p>
</td>
</tr>
<tr>
<td><tt>
CPU performance over time [nops/sec]<br>
Year<br>
1996 1997 1998 1999<br>
-------------------<br>
5 10 20 40 <br>
7 8 6 7 <br>
12 10 20 19 <br>
3 1 5 6
</tt>
</td>
</tr>
</table>
<p>A column can be broader than specified by the parameter <tt>minColumnWidth</tt>
(because a cell may not fit into that width) but a column is never smaller than
<tt>minColumnWidth</tt>. Normally one does not need to specify <tt>minColumnWidth</tt>
(default is <tt>1</tt>). This parameter is only interesting when wanting to
print two distinct matrices such that both matrices have the same column width,
for example, to make it easier to see which column of matrix A corresponds to
which column of matrix B.</p>
<p><b>Implementation:</b></p>
<p>Note that this class is by no means ment to be used for high performance I/O (serialization is much quicker).
It is ment to produce well human readable output.</p>
<p>Analyzes the entire matrix before producing output. Each cell is converted
to a String as indicated by the given C-like format string. If <tt>null</tt>
is passed as format string, {@link java.lang.Double#toString(double)} is used
instead, yielding full precision.</p>
<p>Next, leading and trailing whitespaces are removed. For each column the maximum number of characters before
and after the decimal point is determined. (No problem if decimal points are
missing). Each cell is then padded with leading and trailing blanks, as necessary
to achieve decimal point aligned, left justified formatting.</p>
@author wolfgang.hoschek@cern.ch
@version 1.2, 11/30/99
*/
public class Formatter extends AbstractFormatter {
/**
* Constructs and returns a matrix formatter with format <tt>"%G"</tt>.
*/
public Formatter() {
this("%G");
}
/**
* Constructs and returns a matrix formatter.
* @param format the given format used to convert a single cell value.
*/
public Formatter(String format) {
setFormat(format);
setAlignment(DECIMAL);
}
/**
* Demonstrates how to use this class.
*/
public static void demo1() {
// parameters
double[][] values = {
{3, 0, -3.4, 0},
{5.1 ,0, +3.0123456789, 0},
{16.37, 0.0, 2.5, 0},
{-16.3, 0, -3.012345678E-4, -1},
{1236.3456789, 0, 7, -1.2}
};
String[] formats = {"%G", "%1.10G", "%f", "%1.2f", "%0.2e", null};
// now the processing
int size = formats.length;
DoubleMatrix2D matrix = cern.colt.matrix.DoubleFactory2D.dense.make(values);
String[] strings = new String[size];
String[] sourceCodes = new String[size];
String[] htmlStrings = new String[size];
String[] htmlSourceCodes = new String[size];
for (int i=0; i<size; i++) {
String format = formats[i];
strings[i] = new Formatter(format).toString(matrix);
sourceCodes[i] = new Formatter(format).toSourceCode(matrix);
// may not compile because of packages not included in the distribution
//htmlStrings[i] = cern.colt.matrixpattern.Converting.toHTML(strings[i]);
//htmlSourceCodes[i] = cern.colt.matrixpattern.Converting.toHTML(sourceCodes[i]);
}
System.out.println("original:\n"+new Formatter().toString(matrix));
// may not compile because of packages not included in the distribution
for (int i=0; i<size; i++) {
//System.out.println("\nhtmlString("+formats[i]+"):\n"+htmlStrings[i]);
//System.out.println("\nhtmlSourceCode("+formats[i]+"):\n"+htmlSourceCodes[i]);
}
for (int i=0; i<size; i++) {
System.out.println("\nstring("+formats[i]+"):\n"+strings[i]);
System.out.println("\nsourceCode("+formats[i]+"):\n"+sourceCodes[i]);
}
}
/**
* Demonstrates how to use this class.
*/
public static void demo2() {
// parameters
double[] values = {
//5, 0.0, -0.0, -Double.NaN, Double.NaN, 0.0/0.0, Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, Double.MIN_VALUE, Double.MAX_VALUE
5, 0.0, -0.0, -Double.NaN, Double.NaN, 0.0/0.0, Double.MIN_VALUE, Double.MAX_VALUE , Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY
//Double.MIN_VALUE, Double.MAX_VALUE //, Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY
};
//String[] formats = {"%G", "%1.10G", "%f", "%1.2f", "%0.2e"};
String[] formats = {"%G", "%1.19G"};
// now the processing
int size = formats.length;
DoubleMatrix1D matrix = new DenseDoubleMatrix1D(values);
String[] strings = new String[size];
//String[] javaStrings = new String[size];
for (int i=0; i<size; i++) {
String format = formats[i];
strings[i] = new Formatter(format).toString(matrix);
for (int j=0; j<matrix.size(); j++) {
System.out.println(String.valueOf(matrix.get(j)));
}
}
System.out.println("original:\n"+new Formatter().toString(matrix));
for (int i=0; i<size; i++) {
System.out.println("\nstring("+formats[i]+"):\n"+strings[i]);
}
}
/**
* Demonstrates how to use this class.
*/
public static void demo3(int size, double value) {
cern.colt.Timer timer = new cern.colt.Timer();
String s;
StringBuffer buf;
DoubleMatrix2D matrix = cern.colt.matrix.DoubleFactory2D.dense.make(size,size, value);
timer.reset().start();
buf = new StringBuffer();
for (int i=size; --i >= 0; ) {
for (int j=size; --j >= 0; ) {
buf.append(matrix.getQuick(i,j));
}
}
buf = null;
timer.stop().display();
timer.reset().start();
cern.colt.matrix.impl.Former format = new cern.colt.matrix.impl.FormerFactory().create("%G");
buf = new StringBuffer();
for (int i=size; --i >= 0; ) {
for (int j=size; --j >= 0; ) {
buf.append(format.form(matrix.getQuick(i,j)));
}
}
buf = null;
timer.stop().display();
timer.reset().start();
s = new Formatter(null).toString(matrix);
//System.out.println(s);
s = null;
timer.stop().display();
timer.reset().start();
s = new Formatter("%G").toString(matrix);
//System.out.println(s);
s = null;
timer.stop().display();
}
/**
* Demonstrates how to use this class.
*/
public static void demo4() {
// parameters
double[][] values = {
{3, 0, -3.4, 0},
{5.1 ,0, +3.0123456789, 0},
{16.37, 0.0, 2.5, 0},
{-16.3, 0, -3.012345678E-4, -1},
{1236.3456789, 0, 7, -1.2}
};
/*
double[][] values = {
{3, 1, },
{5.1 ,16.37, }
};
*/
//String[] columnNames = { "he", "", "he", "four" };
//String[] rowNames = { "hello", "du", null, "abcdef", "five" };
String[] columnNames = { "0.1", "0.3", "0.5", "0.7" };
String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8", "SunJDK1.3 Hotspot", "other1", "other2" };
//String[] columnNames = { "0.1", "0.3" };
//String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8"};
DoubleMatrix2D matrix = cern.colt.matrix.DoubleFactory2D.dense.make(values);
System.out.println("\n\n"+new Formatter("%G").toTitleString(matrix,rowNames,columnNames,"rowAxis","colAxis","VM Performance: Provider vs. matrix density"));
}
/**
* Demonstrates how to use this class.
*/
public static void demo5() {
// parameters
double[][] values = {
{3, 0, -3.4, 0},
{5.1 ,0, +3.0123456789, 0},
{16.37, 0.0, 2.5, 0},
{-16.3, 0, -3.012345678E-4, -1},
{1236.3456789, 0, 7, -1.2}
};
/*
double[][] values = {
{3, 1, },
{5.1 ,16.37, }
};
*/
//String[] columnNames = { "he", "", "he", "four" };
//String[] rowNames = { "hello", "du", null, "abcdef", "five" };
String[] columnNames = { "0.1", "0.3", "0.5", "0.7" };
String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8", "SunJDK1.3 Hotspot", "other1", "other2" };
//String[] columnNames = { "0.1", "0.3" };
//String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8"};
System.out.println(cern.colt.matrix.DoubleFactory2D.dense.make(values));
System.out.println(new Formatter("%G").toTitleString(cern.colt.matrix.DoubleFactory2D.dense.make(values),rowNames,columnNames,"vendor","density","title"));
}
/**
* Demonstrates how to use this class.
*/
public static void demo6() {
// parameters
double[][] values = {
{3, 0, -3.4, 0},
{5.1 ,0, +3.0123456789, 0},
{16.37, 0.0, 2.5, 0},
{-16.3, 0, -3.012345678E-4, -1},
{1236.3456789, 0, 7, -1.2}
};
/*
double[][] values = {
{3, 1, },
{5.1 ,16.37, }
};
*/
//String[] columnNames = { "he", "", "he", "four" };
//String[] rowNames = { "hello", "du", null, "abcdef", "five" };
//String[] columnNames = { "0.1", "0.3", "0.5", "0.7" };
String[] columnNames = { "W", "X", "Y", "Z"};
String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8", "SunJDK1.3 Hotspot", "other1", "other2" };
//String[] columnNames = { "0.1", "0.3" };
//String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8"};
//System.out.println(cern.colt.matrix.DoubleFactory2D.dense.make(values));
//System.out.println(new Formatter().toSourceCode(cern.colt.matrix.DoubleFactory2D.dense.make(values)));
System.out.println(new Formatter().toString(cern.colt.matrix.DoubleFactory2D.dense.make(values)));
System.out.println(new Formatter().toTitleString(cern.colt.matrix.DoubleFactory2D.dense.make(values),rowNames,columnNames,"vendor","density","title"));
}
/**
* Demonstrates how to use this class.
*/
public static void demo7() {
// parameters
/*
double[][] values = {
{3, 0, -3.4, 0},
{5.1 ,0, +3.0123456789, 0},
{16.37, 0.0, 2.5, 0},
{-16.3, 0, -3.012345678E-4, -1},
{1236.3456789, 0, 7, -1.2}
};
*/
double[][] values = {
{5 ,10, 20, 40 },
{ 7, 8 , 6 , 7 },
{12 ,10, 20, 19 },
{ 3, 1 , 5 , 6 }
};
String[] columnNames = {"1996", "1997", "1998", "1999"};
String[] rowNames = { "PowerBar", "Benzol", "Mercedes", "Sparcling"};
String rowAxisName = "CPU";
String columnAxisName = "Year";
String title = "CPU performance over time [nops/sec]";
hep.aida.bin.BinFunctions1D F = hep.aida.bin.BinFunctions1D.functions;
hep.aida.bin.BinFunction1D[] aggr = {F.mean, F.rms, F.quantile(0.25), F.median,F.quantile(0.75), F.stdDev, F.min, F.max};
String format = "%1.2G";
//String[] columnNames = { "W", "X", "Y", "Z", "mean", "median", "sum"};
//String[] rowNames = { "SunJDK1.2.2 classic", "IBMJDK1.1.8", "SunJDK1.3 Hotspot", "other1", "other2", "mean", "median", "sum" };
//hep.aida.bin.BinFunction1D[] aggr = {F.mean, F.median, F.sum};
//System.out.println(cern.colt.matrix.DoubleFactory2D.dense.make(values));
//System.out.println(new Formatter().toSourceCode(cern.colt.matrix.DoubleFactory2D.dense.make(values)));
//System.out.println(new Formatter().toString(cern.colt.matrix.DoubleFactory2D.dense.make(values)));
//System.out.println(new Formatter().toTitleString(cern.colt.matrix.DoubleFactory2D.dense.make(values),rowNames,columnNames,rowAxisName,columnAxisName,title));
System.out.println(new Formatter(format).toTitleString(cern.colt.matrix.DoubleFactory2D.dense.make(values),rowNames,columnNames,rowAxisName,columnAxisName,title, aggr));
//System.out.println(cern.colt.matrixpattern.Converting.toHTML(new Formatter(format).toTitleString(cern.colt.matrix.DoubleFactory2D.dense.make(values),rowNames,columnNames,rowAxisName,columnAxisName,title, aggr)));
}
/**
* Converts a given cell to a String; no alignment considered.
*/
protected String form(DoubleMatrix1D matrix, int index, Former formatter) {
return formatter.form(matrix.get(index));
}
/**
* Converts a given cell to a String; no alignment considered.
*/
protected String form(AbstractMatrix1D matrix, int index, Former formatter) {
return this.form((DoubleMatrix1D) matrix, index, formatter);
}
/**
* Returns a string representations of all cells; no alignment considered.
*/
public String[][] format(DoubleMatrix2D matrix) {
String[][] strings = new String[matrix.rows()][matrix.columns()];
for (int row=matrix.rows(); --row >= 0; ) strings[row] = formatRow(matrix.viewRow(row));
return strings;
}
/**
* Returns a string representations of all cells; no alignment considered.
*/
protected String[][] format(AbstractMatrix2D matrix) {
return this.format((DoubleMatrix2D) matrix);
}
/**
* Returns the index of the decimal point.
*/
protected int indexOfDecimalPoint(String s) {
int i = s.lastIndexOf('.');
if (i<0) i = s.lastIndexOf('e');
if (i<0) i = s.lastIndexOf('E');
if (i<0) i = s.length();
return i;
}
/**
* Returns the number of characters before the decimal point.
*/
protected int lead(String s) {
if (alignment.equals(DECIMAL)) return indexOfDecimalPoint(s);
return super.lead(s);
}
/**
* Returns a string <tt>s</tt> such that <tt>Object[] m = s</tt> is a legal Java statement.
* @param matrix the matrix to format.
*/
public String toSourceCode(DoubleMatrix1D matrix) {
Formatter copy = (Formatter) this.clone();
copy.setPrintShape(false);
copy.setColumnSeparator(", ");
String lead = "{";
String trail = "};";
return lead + copy.toString(matrix) + trail;
}
/**
* Returns a string <tt>s</tt> such that <tt>Object[] m = s</tt> is a legal Java statement.
* @param matrix the matrix to format.
*/
public String toSourceCode(DoubleMatrix2D matrix) {
Formatter copy = (Formatter) this.clone();
String b3 = blanks(3);
copy.setPrintShape(false);
copy.setColumnSeparator(", ");
copy.setRowSeparator("},\n"+b3+"{");
String lead = "{\n"+b3+"{";
String trail = "}\n};";
return lead + copy.toString(matrix) + trail;
}
/**
* Returns a string <tt>s</tt> such that <tt>Object[] m = s</tt> is a legal Java statement.
* @param matrix the matrix to format.
*/
public String toSourceCode(DoubleMatrix3D matrix) {
Formatter copy = (Formatter) this.clone();
String b3 = blanks(3);
String b6 = blanks(6);
copy.setPrintShape(false);
copy.setColumnSeparator(", ");
copy.setRowSeparator("},\n"+b6+"{");
copy.setSliceSeparator("}\n"+b3+"},\n"+b3+"{\n"+b6+"{");
String lead = "{\n"+b3+"{\n"+b6+"{";
String trail = "}\n"+b3+"}\n}";
return lead + copy.toString(matrix) + trail;
}
/**
* Returns a string representation of the given matrix.
* @param matrix the matrix to convert.
*/
public String toString(DoubleMatrix1D matrix) {
DoubleMatrix2D easy = matrix.like2D(1,matrix.size());
easy.viewRow(0).assign(matrix);
return toString(easy);
}
/**
* Returns a string representation of the given matrix.
* @param matrix the matrix to convert.
*/
public String toString(DoubleMatrix2D matrix) {
return super.toString(matrix);
}
/**
* Returns a string representation of the given matrix.
* @param matrix the matrix to convert.
*/
public String toString(DoubleMatrix3D matrix) {
StringBuffer buf = new StringBuffer();
boolean oldPrintShape = this.printShape;
this.printShape = false;
for (int slice=0; slice < matrix.slices(); slice++) {
if (slice!=0) buf.append(sliceSeparator);
buf.append(toString(matrix.viewSlice(slice)));
}
this.printShape = oldPrintShape;
if (printShape) buf.insert(0,shape(matrix) + "\n");
return buf.toString();
}
/**
* Returns a string representation of the given matrix.
* @param matrix the matrix to convert.
*/
protected String toString(AbstractMatrix2D matrix) {
return this.toString((DoubleMatrix2D) matrix);
}
/**
Returns a string representation of the given matrix with axis as well as rows and columns labeled.
Pass <tt>null</tt> to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.
@param matrix The matrix to format.
@param rowNames The headers of all rows (to be put to the left of the matrix).
@param columnNames The headers of all columns (to be put to above the matrix).
@param rowAxisName The label of the y-axis.
@param columnAxisName The label of the x-axis.
@param title The overall title of the matrix to be formatted.
@return the matrix converted to a string.
*/
protected String toTitleString(DoubleMatrix2D matrix, String[] rowNames, String[] columnNames, String rowAxisName, String columnAxisName, String title) {
if (matrix.size()==0) return "Empty matrix";
String[][] s = format(matrix);
//String oldAlignment = this.alignment;
//this.alignment = DECIMAL;
align(s);
//this.alignment = oldAlignment;
return new cern.colt.matrix.objectalgo.Formatter().toTitleString(cern.colt.matrix.ObjectFactory2D.dense.make(s), rowNames,columnNames,rowAxisName,columnAxisName,title);
}
/**
Same as <tt>toTitleString</tt> except that additionally statistical aggregates (mean, median, sum, etc.) of rows and columns are printed.
Pass <tt>null</tt> to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.
@param matrix The matrix to format.
@param rowNames The headers of all rows (to be put to the left of the matrix).
@param columnNames The headers of all columns (to be put to above the matrix).
@param rowAxisName The label of the y-axis.
@param columnAxisName The label of the x-axis.
@param title The overall title of the matrix to be formatted.
@param aggr the aggregation functions to be applied to columns and rows.
@return the matrix converted to a string.
@see hep.aida.bin.BinFunction1D
@see hep.aida.bin.BinFunctions1D
*/
public String toTitleString(DoubleMatrix2D matrix, String[] rowNames, String[] columnNames, String rowAxisName, String columnAxisName, String title, hep.aida.bin.BinFunction1D[] aggr) {
if (matrix.size()==0) return "Empty matrix";
if (aggr==null || aggr.length==0) return toTitleString(matrix,rowNames,columnNames,rowAxisName,columnAxisName,title);
DoubleMatrix2D rowStats = matrix.like(matrix.rows(), aggr.length); // hold row aggregations
DoubleMatrix2D colStats = matrix.like(aggr.length, matrix.columns()); // hold column aggregations
cern.colt.matrix.doublealgo.Statistic.aggregate(matrix, aggr, colStats); // aggregate an entire column at a time
cern.colt.matrix.doublealgo.Statistic.aggregate(matrix.viewDice(), aggr, rowStats.viewDice()); // aggregate an entire row at a time
// turn into strings
// tmp holds "matrix" plus "colStats" below (needed so that numbers in a columns can be decimal point aligned)
DoubleMatrix2D tmp = matrix.like(matrix.rows()+aggr.length, matrix.columns());
tmp.viewPart(0,0,matrix.rows(),matrix.columns()).assign(matrix);
tmp.viewPart(matrix.rows(),0,aggr.length,matrix.columns()).assign(colStats);
colStats = null;
String[][] s1 = format(tmp); align(s1); tmp = null;
String[][] s2 = format(rowStats); align(s2); rowStats = null;
// copy strings into a large matrix holding the source matrix and all aggregations
cern.colt.matrix.ObjectMatrix2D allStats = cern.colt.matrix.ObjectFactory2D.dense.make(matrix.rows()+aggr.length, matrix.columns()+aggr.length+1);
allStats.viewPart(0,0,matrix.rows()+aggr.length,matrix.columns()).assign(s1);
allStats.viewColumn(matrix.columns()).assign("|");
allStats.viewPart(0,matrix.columns()+1,matrix.rows(),aggr.length).assign(s2);
s1 = null; s2 = null;
// append a vertical "|" separator plus names of aggregation functions to line holding columnNames
if (columnNames!=null) {
cern.colt.list.ObjectArrayList list = new cern.colt.list.ObjectArrayList(columnNames);
list.add("|");
for (int i=0; i<aggr.length; i++) list.add(aggr[i].name()); // add names of aggregation functions
columnNames = new String[list.size()];
list.toArray(columnNames);
}
// append names of aggregation functions to line holding rowNames
if (rowNames!=null) {
cern.colt.list.ObjectArrayList list = new cern.colt.list.ObjectArrayList(rowNames);
for (int i=0; i<aggr.length; i++) list.add(aggr[i].name()); // add names of aggregation functions
rowNames = new String[list.size()];
list.toArray(rowNames);
}
// turn large matrix into string
String s = new cern.colt.matrix.objectalgo.Formatter().toTitleString(allStats, rowNames,columnNames,rowAxisName,columnAxisName,title);
// insert a horizontal "----------------------" separation line above the column stats
// determine insertion position and line width
int last = s.length()+1;
int secondLast = last;
int v = Math.max(0, rowAxisName==null ? 0 : rowAxisName.length()-matrix.rows()-aggr.length);
for (int k=0; k<aggr.length+1+v; k++) { // scan "aggr.length+1+v" lines backwards
secondLast = last;
last = s.lastIndexOf(rowSeparator, last-1);
}
StringBuffer buf = new StringBuffer(s);
buf.insert(secondLast,rowSeparator+repeat('-',secondLast-last-1));
return buf.toString();
}
/**
Returns a string representation of the given matrix with axis as well as rows and columns labeled.
Pass <tt>null</tt> to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.
@param matrix The matrix to format.
@param sliceNames The headers of all slices (to be put above each slice).
@param rowNames The headers of all rows (to be put to the left of the matrix).
@param columnNames The headers of all columns (to be put to above the matrix).
@param sliceAxisName The label of the z-axis (to be put above each slice).
@param rowAxisName The label of the y-axis.
@param columnAxisName The label of the x-axis.
@param title The overall title of the matrix to be formatted.
@param aggr the aggregation functions to be applied to columns, rows.
@return the matrix converted to a string.
@see hep.aida.bin.BinFunction1D
@see hep.aida.bin.BinFunctions1D
*/
public String toTitleString(DoubleMatrix3D matrix, String[] sliceNames, String[] rowNames, String[] columnNames, String sliceAxisName, String rowAxisName, String columnAxisName, String title, hep.aida.bin.BinFunction1D[] aggr) {
if (matrix.size()==0) return "Empty matrix";
StringBuffer buf = new StringBuffer();
for (int i=0; i<matrix.slices(); i++) {
if (i!=0) buf.append(sliceSeparator);
buf.append(toTitleString(matrix.viewSlice(i),rowNames,columnNames,rowAxisName,columnAxisName,title+"\n"+sliceAxisName+"="+sliceNames[i],aggr));
}
return buf.toString();
}
/**
Returns a string representation of the given matrix with axis as well as rows and columns labeled.
Pass <tt>null</tt> to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.
@param matrix The matrix to format.
@param sliceNames The headers of all slices (to be put above each slice).
@param rowNames The headers of all rows (to be put to the left of the matrix).
@param columnNames The headers of all columns (to be put to above the matrix).
@param sliceAxisName The label of the z-axis (to be put above each slice).
@param rowAxisName The label of the y-axis.
@param columnAxisName The label of the x-axis.
@param title The overall title of the matrix to be formatted.
@return the matrix converted to a string.
*/
private String xtoTitleString(DoubleMatrix3D matrix, String[] sliceNames, String[] rowNames, String[] columnNames, String sliceAxisName, String rowAxisName, String columnAxisName, String title) {
if (matrix.size()==0) return "Empty matrix";
StringBuffer buf = new StringBuffer();
for (int i=0; i<matrix.slices(); i++) {
if (i!=0) buf.append(sliceSeparator);
buf.append(toTitleString(matrix.viewSlice(i),rowNames,columnNames,rowAxisName,columnAxisName,title+"\n"+sliceAxisName+"="+sliceNames[i]));
}
return buf.toString();
}
}