cern.colt.matrix.objectalgo

Class Formatter

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.impl.AbstractFormatter

cern.colt.matrix.objectalgo.Formatter

All Implemented Interfaces:

Serializable, Cloneable

public class Formatter
extends AbstractFormatter

Flexible, well human readable matrix print formatting. Each cell is converted using Object.toString(). For examples see doublealgo.Formatter which is just the same except that it operates on doubles.

See Also:

Serialized Form

Field Summary

Fields inherited from class cern.colt.matrix.impl.AbstractFormatter

CENTER, DECIMAL, DEFAULT_COLUMN_SEPARATOR, DEFAULT_MIN_COLUMN_WIDTH, DEFAULT_ROW_SEPARATOR, DEFAULT_SLICE_SEPARATOR, LEFT, RIGHT

Fields inherited from class cern.colt.PersistentObject

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Formatter() Constructs and returns a matrix formatter with alignment LEFT.
Formatter(String alignment) Constructs and returns a matrix formatter.

Method Summary

Modifier and Type	Method and Description
String	toSourceCode(ObjectMatrix1D matrix) Returns a string s such that Object[] m = s is a legal Java statement.
String	toSourceCode(ObjectMatrix2D matrix) Returns a string s such that Object[] m = s is a legal Java statement.
String	toSourceCode(ObjectMatrix3D matrix) Returns a string s such that Object[] m = s is a legal Java statement.
String	toString(ObjectMatrix1D matrix) Returns a string representation of the given matrix.
String	toString(ObjectMatrix2D matrix) Returns a string representation of the given matrix.
String	toString(ObjectMatrix3D matrix) Returns a string representation of the given matrix.
String	toTitleString(ObjectMatrix2D matrix, String[] rowNames, String[] columnNames, String rowAxisName, String columnAxisName, String title) Returns a string representation of the given matrix with axis as well as rows and columns labeled.
String	toTitleString(ObjectMatrix3D matrix, String[] sliceNames, String[] rowNames, String[] columnNames, String sliceAxisName, String rowAxisName, String columnAxisName, String title) Returns a string representation of the given matrix with axis as well as rows and columns labeled.

Methods inherited from class cern.colt.matrix.impl.AbstractFormatter

demo1, demo2, demo3, setAlignment, setColumnSeparator, setFormat, setMinColumnWidth, setPrintShape, setRowSeparator, setSliceSeparator, shape, shape, shape

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

Formatter

public Formatter()

Constructs and returns a matrix formatter with alignment LEFT.

Formatter

public Formatter(String alignment)

Constructs and returns a matrix formatter.

Parameters:

alignment - the given alignment used to align a column.

Method Detail

toSourceCode

public String toSourceCode(ObjectMatrix1D matrix)

Returns a string s such that Object[] m = s is a legal Java statement.

Parameters:

matrix - the matrix to format.

toSourceCode

public String toSourceCode(ObjectMatrix2D matrix)

Returns a string s such that Object[] m = s is a legal Java statement.

Parameters:

matrix - the matrix to format.

toSourceCode

public String toSourceCode(ObjectMatrix3D matrix)

Returns a string s such that Object[] m = s is a legal Java statement.

Parameters:

matrix - the matrix to format.

toString

public String toString(ObjectMatrix1D matrix)

Returns a string representation of the given matrix.

Parameters:

matrix - the matrix to convert.

toString

public String toString(ObjectMatrix2D matrix)

Returns a string representation of the given matrix.

Parameters:

matrix - the matrix to convert.

toString

public String toString(ObjectMatrix3D matrix)

Returns a string representation of the given matrix.

Parameters:

matrix - the matrix to convert.

toTitleString

public String toTitleString(ObjectMatrix2D matrix,
                            String[] rowNames,
                            String[] columnNames,
                            String rowAxisName,
                            String columnAxisName,
                            String title)

Returns a string representation of the given matrix with axis as well as rows and columns labeled. Pass null to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.

Parameters:

matrix - The matrix to format.

rowNames - The headers of all rows (to be put to the left of the matrix).

columnNames - The headers of all columns (to be put to above the matrix).

rowAxisName - The label of the y-axis.

columnAxisName - The label of the x-axis.

title - The overall title of the matrix to be formatted.

Returns:

the matrix converted to a string.

toTitleString

public String toTitleString(ObjectMatrix3D matrix,
                            String[] sliceNames,
                            String[] rowNames,
                            String[] columnNames,
                            String sliceAxisName,
                            String rowAxisName,
                            String columnAxisName,
                            String title)

Returns a string representation of the given matrix with axis as well as rows and columns labeled. Pass null to one or more parameters to indicate that the corresponding decoration element shall not appear in the string converted matrix.

Parameters:

matrix - The matrix to format.

sliceNames - The headers of all slices (to be put above each slice).

rowNames - The headers of all rows (to be put to the left of the matrix).

columnNames - The headers of all columns (to be put to above the matrix).

sliceAxisName - The label of the z-axis (to be put above each slice).

rowAxisName - The label of the y-axis.

columnAxisName - The label of the x-axis.

title - The overall title of the matrix to be formatted.

Returns:

the matrix converted to a string.