AbstractFormatter
cern.colt.matrix.impl

Class AbstractFormatter

  • All Implemented Interfaces:
    Serializable, Cloneable
    Direct Known Subclasses:
    Formatter, Formatter


    public abstract class AbstractFormatterextends PersistentObject
    Abstract base class for flexible, well human readable matrix print formatting.Value type independent.A single cell is formatted via a format string.Columns can be aligned left, centered, right and by decimal point.

    A column can be broader than specified by the parameter minColumnWidth (because a cell may not fit into that width) but a column is never smaller than minColumnWidth. Normally one does not need to specify minColumnWidth.Cells in a row are separated by a separator string, similar separators can be set for rows and slices.For more info, see the concrete subclasses.

    See Also:
    Serialized Form
    • Field Detail

      • CENTER

        public static final String CENTER
        The alignment string aligning the cells of a column to its center.
        See Also:
        Constant Field Values
      • DECIMAL

        public static final String DECIMAL
        The alignment string aligning the cells of a column to the decimal point.
        See Also:
        Constant Field Values
      • DEFAULT_MIN_COLUMN_WIDTH

        public static final int DEFAULT_MIN_COLUMN_WIDTH
        The default minimum number of characters a column may have; currently 1.
        See Also:
        Constant Field Values
      • DEFAULT_COLUMN_SEPARATOR

        public static final String DEFAULT_COLUMN_SEPARATOR
        The default string separating any two columns from another; currently " ".
        See Also:
        Constant Field Values
      • DEFAULT_ROW_SEPARATOR

        public static final String DEFAULT_ROW_SEPARATOR
        The default string separating any two rows from another; currently "\n".
        See Also:
        Constant Field Values
      • DEFAULT_SLICE_SEPARATOR

        public static final String DEFAULT_SLICE_SEPARATOR
        The default string separating any two slices from another; currently "\n\n".
        See Also:
        Constant Field Values
    • Method Detail

      • demo1

        public static void demo1()
        Demonstrates how to use this class.
      • demo2

        public static void demo2()
        Demonstrates how to use this class.
      • demo3

        public static void demo3(int size,         Object value)
        Demonstrates how to use this class.
      • setAlignment

        public void setAlignment(String alignment)
        Sets the column alignment (left,center,right,decimal).
        Parameters:
        alignment - the new alignment to be used; must be one of {LEFT,CENTER,RIGHT,DECIMAL}.
      • setColumnSeparator

        public void setColumnSeparator(String columnSeparator)
        Sets the string separating any two columns from another.
        Parameters:
        columnSeparator - the new columnSeparator to be used.
      • setFormat

        public void setFormat(String format)
        Sets the way a single cell value is to be formatted.
        Parameters:
        format - the new format to be used.
      • setMinColumnWidth

        public void setMinColumnWidth(int minColumnWidth)
        Sets the minimum number of characters a column may have.
        Parameters:
        minColumnWidth - the new minColumnWidth to be used.
      • setPrintShape

        public void setPrintShape(boolean printShape)
        Specifies whether a string representation of a matrix is to be preceded with a summary of its shape.
        Parameters:
        printShape - true shape summary is printed, otherwise not printed.
      • setRowSeparator

        public void setRowSeparator(String rowSeparator)
        Sets the string separating any two rows from another.
        Parameters:
        rowSeparator - the new rowSeparator to be used.
      • setSliceSeparator

        public void setSliceSeparator(String sliceSeparator)
        Sets the string separating any two slices from another.
        Parameters:
        sliceSeparator - the new sliceSeparator to be used.
      • shape

        public static String shape(AbstractMatrix1D matrix)
        Returns a short string representation describing the shape of the matrix.
      • shape

        public static String shape(AbstractMatrix2D matrix)
        Returns a short string representation describing the shape of the matrix.
      • shape

        public static String shape(AbstractMatrix3D matrix)
        Returns a short string representation describing the shape of the matrix.

SCaVis 2.2 © jWork.ORG