Class Formatter

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.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.
    Version:
    1.1, 11/22/99
    See Also:
    Serialized Form
    • Constructor Detail

      • Formatter

        public Formatter()
        Constructs and returns a matrix formatter with alignment LEFT.
      • Formatter

        public Formatter​(java.lang.String alignment)
        Constructs and returns a matrix formatter.
        Parameters:
        alignment - the given alignment used to align a column.
    • Method Detail

      • form

        protected java.lang.String form​(ObjectMatrix1D matrix,
                                        int index,
                                        Former formatter)
        Converts a given cell to a String; no alignment considered.
      • format

        protected java.lang.String[][] format​(AbstractMatrix2D matrix)
        Returns a string representations of all cells; no alignment considered.
        Specified by:
        format in class AbstractFormatter
      • format

        protected java.lang.String[][] format​(ObjectMatrix2D matrix)
        Returns a string representations of all cells; no alignment considered.
      • toSourceCode

        public java.lang.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 java.lang.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 java.lang.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

        protected java.lang.String toString​(AbstractMatrix2D matrix)
        Returns a string representation of the given matrix.
        Overrides:
        toString in class AbstractFormatter
        Parameters:
        matrix - the matrix to convert.
      • toString

        public java.lang.String toString​(ObjectMatrix1D matrix)
        Returns a string representation of the given matrix.
        Parameters:
        matrix - the matrix to convert.
      • toString

        public java.lang.String toString​(ObjectMatrix2D matrix)
        Returns a string representation of the given matrix.
        Parameters:
        matrix - the matrix to convert.
      • toString

        public java.lang.String toString​(ObjectMatrix3D matrix)
        Returns a string representation of the given matrix.
        Parameters:
        matrix - the matrix to convert.
      • toTitleString

        public java.lang.String toTitleString​(ObjectMatrix2D matrix,
                                              java.lang.String[] rowNames,
                                              java.lang.String[] columnNames,
                                              java.lang.String rowAxisName,
                                              java.lang.String columnAxisName,
                                              java.lang.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 java.lang.String toTitleString​(ObjectMatrix3D matrix,
                                              java.lang.String[] sliceNames,
                                              java.lang.String[] rowNames,
                                              java.lang.String[] columnNames,
                                              java.lang.String sliceAxisName,
                                              java.lang.String rowAxisName,
                                              java.lang.String columnAxisName,
                                              java.lang.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.