edu.illinois.cs.cogcomp.lbjava.util

Class TableFormat

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.util.TableFormat

public class TableFormat
extends Object

A library of routines for taking tabular data and producing a human readable string representation of it. The resulting string(s) can be pure ASCII or latex compatible.

Author:

Nick Rizzolo

Constructor Summary

Constructors

Constructor and Description
TableFormat()

Method Summary

Modifier and Type	Method and Description
protected static String[]	asciiTableFormat(int columns, int dataColumns, int rows, int dataRows, String[] columnLabels, String[] rowLabels, Double[][] data, int[] sigDigits, int[] dashRows) Formats the given data into an ASCII table.
protected static String	center(String original, int width) Returns a space-padded string of at least the specified width such that the argument string is centered within the returned string.
protected static String	format(double f, int d) Formats a floating point number so that it is rounded and zero-padded to the given number of significant digits after the decimal point.
protected static String	ljust(String original, int width) Returns a space-padded string of at least the specified width such that the argument string is left-justified within the returned string.
static void	printTable(PrintStream out, String[] table) Simply prints each element of the given array of strings to the given stream in its own line.
static void	printTableFormat(PrintStream out, double[][] data) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, Double[][] data) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, double[][] data) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, Double[][] data) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, double[][] data, int[] sigDigits) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, Double[][] data, int[] sigDigits) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, double[][] data, int[] sigDigits, int[] dashRows) Formats the given data into an ASCII table and prints it to the given stream.
static void	printTableFormat(PrintStream out, String[] columnLabels, String[] rowLabels, Double[][] data, int[] sigDigits, int[] dashRows) Formats the given data into an ASCII table and prints it to the given stream.
protected static String	rjust(String original, int width) Returns a space-padded string of at least the specified width such that the argument string is right-justified within the returned string.
static String[]	tableFormat(double[][] data) Formats the given data into an ASCII table.
static String[]	tableFormat(Double[][] data) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, double[][] data) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, Double[][] data) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, double[][] data, int[] sigDigits) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, Double[][] data, int[] sigDigits) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, double[][] data, int[] sigDigits, int[] dashRows) Formats the given data into an ASCII table.
static String[]	tableFormat(String[] columnLabels, String[] rowLabels, Double[][] data, int[] sigDigits, int[] dashRows) Formats the given data into an ASCII table.
static double[][]	transpose(double[][] m) Transposes the given matrix so that the rows become the columns and the columns become the rows.
static Double[][]	transpose(Double[][] m) Transposes the given matrix so that the rows become the columns and the columns become the rows.
static Double[][]	wrapDouble(double[][] m) Simply converts the type of the given matrix from double to Double.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableFormat

public TableFormat()

Method Detail

wrapDouble

public static Double[][] wrapDouble(double[][] m)

Simply converts the type of the given matrix from double to Double.

Parameters:

m - The matrix.

Returns:

The type converted matrix.

printTable

public static void printTable(PrintStream out,
                              String[] table)

Simply prints each element of the given array of strings to the given stream in its own line.

Parameters:

out - The stream.

table - The strings.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    double[][] data)

Formats the given data into an ASCII table and prints it to the given stream. All non- null entries will be rounded to three significant digits after the decimal place.

Parameters:

out - The stream.

data - The numerical data.

tableFormat

public static String[] tableFormat(double[][] data)

Formats the given data into an ASCII table. All non-null entries will be rounded to three significant digits after the decimal place.

Parameters:

data - The numerical data.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    Double[][] data)

Formats the given data into an ASCII table and prints it to the given stream. All non- null entries will be rounded to three significant digits after the decimal place.

Parameters:

out - The stream.

data - The numerical data.

tableFormat

public static String[] tableFormat(Double[][] data)

Formats the given data into an ASCII table. All non-null entries will be rounded to three significant digits after the decimal place.

Parameters:

data - The numerical data.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    double[][] data)

Formats the given data into an ASCII table and prints it to the given stream. All non- null entries will be rounded to three significant digits after the decimal place.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   double[][] data)

Formats the given data into an ASCII table. All non-null entries will be rounded to three significant digits after the decimal place.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    Double[][] data)

Formats the given data into an ASCII table and prints it to the given stream. Any entry in any row of data set to null will become a single dash in the output. All non-null entries will be rounded to three significant digits after the decimal place.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   Double[][] data)

Formats the given data into an ASCII table. Any entry in any row of data set to null will become a single dash in the output. All non-null entries will be rounded to three significant digits after the decimal place.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    double[][] data,
                                    int[] sigDigits)

Formats the given data into an ASCII table and prints it to the given stream. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   double[][] data,
                                   int[] sigDigits)

Formats the given data into an ASCII table. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    Double[][] data,
                                    int[] sigDigits)

Formats the given data into an ASCII table and prints it to the given stream. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   Double[][] data,
                                   int[] sigDigits)

Formats the given data into an ASCII table. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    double[][] data,
                                    int[] sigDigits,
                                    int[] dashRows)

Formats the given data into an ASCII table and prints it to the given stream. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

dashRows - The indexes of rows in data which should be preceded by a row of dashes in the output.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   double[][] data,
                                   int[] sigDigits,
                                   int[] dashRows)

Formats the given data into an ASCII table. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

dashRows - The indexes of rows in data which should be preceded by a row of dashes in the output.

Returns:

The string respresentation of the data.

printTableFormat

public static void printTableFormat(PrintStream out,
                                    String[] columnLabels,
                                    String[] rowLabels,
                                    Double[][] data,
                                    int[] sigDigits,
                                    int[] dashRows)

Formats the given data into an ASCII table and prints it to the given stream. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

out - The stream.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

dashRows - The indexes of rows in data which should be preceded by a row of dashes in the output.

tableFormat

public static String[] tableFormat(String[] columnLabels,
                                   String[] rowLabels,
                                   Double[][] data,
                                   int[] sigDigits,
                                   int[] dashRows)

Formats the given data into an ASCII table. Any entry in any row of data set to null will become a single dash in the output.

Parameters:

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

dashRows - The indexes of rows in data which should be preceded by a row of dashes in the output.

Returns:

The string respresentation of the data.

asciiTableFormat

protected static String[] asciiTableFormat(int columns,
                                           int dataColumns,
                                           int rows,
                                           int dataRows,
                                           String[] columnLabels,
                                           String[] rowLabels,
                                           Double[][] data,
                                           int[] sigDigits,
                                           int[] dashRows)

Formats the given data into an ASCII table. Any row of data set to null will become a row with one dash in each cell of the output table's row. Any entry in any row of data set to null will also become a single dash in the output.

Parameters:

columns - The total number of columns in the table.

dataColumns - The number of columns containing data in the table.

rows - The total number of rows in the table.

dataRows - The number of rows containing data in the table.

columnLabels - One label for each column in the output, starting with the column of row labels if one exists. If null, no column label row will be returned.

rowLabels - One label for each non-null row in data. If null, no row label column will be returned.

data - The numerical data.

sigDigits - Significant digits specified on a column by column basis, only for data columns.

dashRows - The indexes of rows in data which should be preceded by a row of dashes in the output.

Returns:

The string respresentation of the data.

transpose

public static double[][] transpose(double[][] m)

Transposes the given matrix so that the rows become the columns and the columns become the rows.

Parameters:

m - The matrix to transpose.

Returns:

The transposed matrix.

transpose

public static Double[][] transpose(Double[][] m)

Transposes the given matrix so that the rows become the columns and the columns become the rows.

Parameters:

m - The matrix to transpose.

Returns:

The transposed matrix.

format

protected static String format(double f,
                               int d)

Formats a floating point number so that it is rounded and zero-padded to the given number of significant digits after the decimal point.

Parameters:

f - The floating point value to format.

d - The number of significant digits to round to. If less than 0, this method assumes 0; if greater than 18, this method assumes 18.

Returns:

The formatted result.

ljust

protected static String ljust(String original,
                              int width)

Returns a space-padded string of at least the specified width such that the argument string is left-justified within the returned string.

Parameters:

original - The string to justify.

width - The width within which the original string should be padded.

Returns:

The padded string. If the original is longer than the specified width, the original is simply returned.

rjust

protected static String rjust(String original,
                              int width)

Returns a space-padded string of at least the specified width such that the argument string is right-justified within the returned string.

Parameters:

original - The string to justify.

width - The width within which the original string should be padded.

Returns:

The padded string. If the original is longer than the specified width, the original is simply returned.

center

protected static String center(String original,
                               int width)

Returns a space-padded string of at least the specified width such that the argument string is centered within the returned string.

Parameters:

original - The string to justify.

width - The width within which the original string should be padded.

Returns:

The padded string. If the original is longer than the specified width, the original is simply returned.