Package weka.experiment

# Class ResultMatrixPlainText

java.lang.Object
weka.experiment.ResultMatrix
weka.experiment.ResultMatrixPlainText

All Implemented Interfaces:
  `Serializable`, `OptionHandler`, `RevisionHandler`

public class ResultMatrixPlainText extends ResultMatrix
Generates the output as plain text (for fixed width fonts).

Valid options are:

     -mean-prec <int>
      The number of decimals after the decimal point for the mean.
      (default: 2)

     -stddev-prec <int>
      The number of decimals after the decimal point for the mean.
      (default: 2)

     -col-name-width <int>
      The maximum width for the column names (0 = optimal).
      (default: 0)

     -row-name-width <int>
      The maximum width for the row names (0 = optimal).
      (default: 25)

     -mean-width <int>
      The width of the mean (0 = optimal).
      (default: 0)

     -stddev-width <int>
      The width of the standard deviation (0 = optimal).
      (default: 0)

     -sig-width <int>
      The width of the significance indicator (0 = optimal).
      (default: 0)

     -count-width <int>
      The width of the counts (0 = optimal).
      (default: 5)

     -show-stddev
      Whether to display the standard deviation column.
      (default: no)

     -show-avg
      Whether to show the row with averages.
      (default: no)

     -remove-filter
      Whether to remove the classname package prefixes from the
      filter names in datasets.
      (default: no)

     -print-col-names
      Whether to output column names or just numbers representing them.
      (default: no)

     -print-row-names
      Whether to output row names or just numbers representing them.
      (default: no)

     -enum-col-names
      Whether to enumerate the column names (prefixing them with
      '(x)', with 'x' being the index).
      (default: no)

     -enum-row-names
      Whether to enumerate the row names (prefixing them with
      '(x)', with 'x' being the index).
      (default: no)

Version:
  $Revision: 10204 $
Author:
  FracPete (fracpete at waikato dot ac dot nz)
See Also:
  - Serialized Form

- ## Field Summary

  ### Fields inherited from class weka.experiment.ResultMatrix

  `LEFT_PARENTHESES, LOSS_STRING, RIGHT_PARENTHESES, SIGNIFICANCE_LOSS, SIGNIFICANCE_TIE, SIGNIFICANCE_WIN, TIE_STRING, WIN_STRING`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ResultMatrixPlainText()`
  initializes the matrix as 1x1 matrix.
  `ResultMatrixPlainText(int cols, int rows)`
  initializes the matrix with the given dimensions.
  `ResultMatrixPlainText(ResultMatrix matrix)`
  initializes the matrix with the values from the given matrix.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getDefaultCountWidth()`
  returns the default width for the counts.
  `int`
  `getDefaultRowNameWidth()`
  returns the default width for the row names.
  `String`
  `getDisplayName()`
  returns the name of the output format.
  `String`
  `getRevision()`
  Returns the revision string.
  `String`
  `globalInfo()`
  Returns a string describing the matrix.
  `static void`
  `main(String[] args)`
  for testing only.
  `String`
  `toStringHeader()`
  returns the header of the matrix as a string.
  `String`
  `toStringKey()`
  returns returns a key for all the col names, for better readability if the names got cut off.
  `String`
  `toStringMatrix()`
  returns the matrix as plain text.
  `String`
  `toStringRanking()`
  returns the ranking in a string representation.
  `String`
  `toStringSummary()`
  returns the summary as string.

  ### Methods inherited from class weka.experiment.ResultMatrix

  `addHeader, assign, clear, clearHeader, clearRanking, clearSummary, colNameWidthTipText, countWidthTipText, enumerateColNamesTipText, enumerateRowNamesTipText, getAverage, getColCount, getColHidden, getColName, getColNameWidth, getColOrder, getCount, getCountWidth, getDefaultColNameWidth, getDefaultEnumerateColNames, getDefaultEnumerateRowNames, getDefaultMeanPrec, getDefaultMeanWidth, getDefaultPrintColNames, getDefaultPrintRowNames, getDefaultRemoveFilterName, getDefaultShowAverage, getDefaultShowStdDev, getDefaultSignificanceWidth, getDefaultStdDevPrec, getDefaultStdDevWidth, getDisplayCol, getDisplayRow, getEnumerateColNames, getEnumerateRowNames, getHeader, getMean, getMeanPrec, getMeanWidth, getOptions, getPrintColNames, getPrintRowNames, getRemoveFilterName, getRowCount, getRowHidden, getRowName, getRowNameWidth, getRowOrder, getShowAverage, getShowStdDev, getSignificance, getSignificanceCount, getSignificanceWidth, getStdDev, getStdDevPrec, getStdDevWidth, getVisibleColCount, getVisibleRowCount, headerKeys, listOptions, meanPrecTipText, meanWidthTipText, printColNamesTipText, printRowNamesTipText, removeFilterNameTipText, rowNameWidthTipText, setColHidden, setColName, setColNameWidth, setColOrder, setCount, setCountWidth, setEnumerateColNames, setEnumerateRowNames, setMean, setMeanPrec, setMeanWidth, setOptions, setPrintColNames, setPrintRowNames, setRanking, setRemoveFilterName, setRowHidden, setRowName, setRowNameWidth, setRowOrder, setShowAverage, setShowStdDev, setSignificance, setSignificanceWidth, setSize, setStdDev, setStdDevPrec, setStdDevWidth, setSummary, showAverageTipText, showStdDevTipText, significanceWidthTipText, stdDevPrecTipText, stdDevWidthTipText, toString`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### ResultMatrixPlainText

    public ResultMatrixPlainText()
    initializes the matrix as 1x1 matrix.

  - ### ResultMatrixPlainText

    public ResultMatrixPlainText(int cols, int rows)
    initializes the matrix with the given dimensions.
    Parameters:
      `cols` - the number of columns
      `rows` - the number of rows

  - ### ResultMatrixPlainText

    public ResultMatrixPlainText(ResultMatrix matrix)
    initializes the matrix with the values from the given matrix.
    Parameters:
      `matrix` - the matrix to get the values from

- ## Method Details

  - ### globalInfo

    public String globalInfo()
    Returns a string describing the matrix.
    Specified by:
      `globalInfo` in class `ResultMatrix`
    Returns:
      a description suitable for displaying in the experimenter gui

  - ### getDisplayName

    public String getDisplayName()
    returns the name of the output format.
    Specified by:
      `getDisplayName` in class `ResultMatrix`
    Returns:
      the display name

  - ### getDefaultRowNameWidth

    public int getDefaultRowNameWidth()
    returns the default width for the row names.
    Overrides:
      `getDefaultRowNameWidth` in class `ResultMatrix`
    Returns:
      the width

  - ### getDefaultCountWidth

    public int getDefaultCountWidth()
    returns the default width for the counts.
    Overrides:
      `getDefaultCountWidth` in class `ResultMatrix`
    Returns:
      the width

  - ### toStringHeader

    public String toStringHeader()
    returns the header of the matrix as a string.
    Specified by:
      `toStringHeader` in class `ResultMatrix`
    Returns:
      the header
    See Also:
      - `ResultMatrix.m_HeaderKeys`
      - `ResultMatrix.m_HeaderValues`

  - ### toStringMatrix

    public String toStringMatrix()
    returns the matrix as plain text.
    Specified by:
      `toStringMatrix` in class `ResultMatrix`
    Returns:
      the matrix

  - ### toStringKey

    public String toStringKey()
    returns returns a key for all the col names, for better readability if the names got cut off.
    Specified by:
      `toStringKey` in class `ResultMatrix`
    Returns:
      the key

  - ### toStringSummary

    public String toStringSummary()
    returns the summary as string.
    Specified by:
      `toStringSummary` in class `ResultMatrix`
    Returns:
      the summary

  - ### toStringRanking

    public String toStringRanking()
    returns the ranking in a string representation.
    Specified by:
      `toStringRanking` in class `ResultMatrix`
    Returns:
      the ranking

  - ### getRevision

    public String getRevision()
    Returns the revision string.
    Returns:
      the revision

  - ### main

    public static void main(String[] args)
    for testing only.
    Parameters:
      `args` - ignored