Class PrintOptions

java.lang.Object
org.flag4j.io.PrintOptions
public final class PrintOptions extends Object
Printing and formating options for tensors, matrices, and vectors.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    DEFAULT_CENTER
    Default flag for centering elements when printing.
    static final int
    DEFAULT_MAX_COLS
    Default maximum number of columns to print.
    static final int
    DEFAULT_MAX_ROWS
    Default maximum number of rows to print.
    static final int
    DEFAULT_PADDING
    Default padding between elements when printing.
    static final int
    DEFAULT_PRECISION
    Default precision (i.e. number of decimals) to use when printing.

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    getMaxColumns()
    Gets the current maximum number of columns to print.
    static int
    getMaxRows()
    Gets the maximum number of rows to print.
    static int
    getPadding()
    Gets the current padding amount for columns.
    static int
    getPrecision()
    Gets the current printing precision.
    static void
    resetAll()
    Resets all print options to their default values.
    static void
    setCentering(boolean center)
    Sets the centering flag.
    static void
    setMaxColumns(int maxColumns)
    Sets the maximum number of columns to print.
    static void
    setMaxRows(int maxRows)
    Set the maximum number of rows to print.
    static void
    setMaxRowsCols(int maxRowCols)
    Set the maximum number of rows and columns to print.
    static void
    setMaxRowsCols(int maxRows, int maxCols)
    Set the maximum number of rows and columns to print.
    static void
    setPadding(int padding)
    Sets the minimum padding amount for the columns.
    static void
    setPrecision(int precision)
    Sets the printing precision for which values in a matrix/vector
    static boolean
    useCentering()
    Gets the centering flag.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_PADDING

      public static final int DEFAULT_PADDING
      Default padding between elements when printing.
      See Also:

    • DEFAULT_MAX_ROWS

      public static final int DEFAULT_MAX_ROWS
      Default maximum number of rows to print.
      See Also:

    • DEFAULT_MAX_COLS

      public static final int DEFAULT_MAX_COLS
      Default maximum number of columns to print.
      See Also:

    • DEFAULT_PRECISION

      public static final int DEFAULT_PRECISION
      Default precision (i.e. number of decimals) to use when printing.
      See Also:

    • DEFAULT_CENTER

      public static final boolean DEFAULT_CENTER
      Default flag for centering elements when printing.
      See Also:

  • Method Details

    • setCentering

      public static void setCentering(boolean center)
      Sets the centering flag.
      Parameters:
      center - Flag for centering values within its column.

    • useCentering

      public static boolean useCentering()
      Gets the centering flag.
      Returns:
      The current value of the center flag.

    • setPrecision

      public static void setPrecision(int precision)
      Sets the printing precision for which values in a matrix/vector
      Parameters:
      precision - The precision to use.

    • getPrecision

      public static int getPrecision()
      Gets the current printing precision.
      Returns:
      The current printing precision.

    • getMaxColumns

      public static int getMaxColumns()
      Gets the current maximum number of columns to print.
      Returns:
      The current maximum number of columns to print.

    • setMaxColumns

      public static void setMaxColumns(int maxColumns)
      Sets the maximum number of columns to print.
      Parameters:
      maxColumns - Maximum number of columns to print.

    • getMaxRows

      public static int getMaxRows()
      Gets the maximum number of rows to print.
      Returns:
      The maximum number of rows to print.

    • setMaxRows

      public static void setMaxRows(int maxRows)
      Set the maximum number of rows to print.
      Parameters:
      maxRows - The new maximum number of rows to print.

    • setMaxRowsCols

      public static void setMaxRowsCols(int maxRows, int maxCols)
      Set the maximum number of rows and columns to print.
      Parameters:
      maxRows - The new maximum number of rows to print.
      maxCols - The maximum number of columns to print.

    • setMaxRowsCols

      public static void setMaxRowsCols(int maxRowCols)
      Set the maximum number of rows and columns to print.
      Parameters:
      maxRowCols - The new maximum number of rows and columns to print.

    • getPadding

      public static int getPadding()
      Gets the current padding amount for columns.
      Returns:
      The current padding amount for columns.

    • setPadding

      public static void setPadding(int padding)
      Sets the minimum padding amount for the columns.
      Parameters:
      padding - New padding amount for the columns.

    • resetAll

      public static void resetAll()
      Resets all print options to their default values.