weka.experiment

Class ResultMatrixLatex

java.lang.Object

weka.experiment.ResultMatrix

weka.experiment.ResultMatrixLatex

All Implemented Interfaces:

java.io.Serializable, OptionHandler, RevisionHandler

public class ResultMatrixLatex
extends ResultMatrix

Generates the matrix output in LaTeX-syntax.

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: 0)

 -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: 0)

 -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: 8034 $

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 and Description
ResultMatrixLatex() initializes the matrix as 1x1 matrix.
ResultMatrixLatex(int cols, int rows) initializes the matrix with the given dimensions.
ResultMatrixLatex(ResultMatrix matrix) initializes the matrix with the values from the given matrix.

Method Summary

Modifier and Type	Method and Description
void	clear() removes the stored data but retains the dimensions of the matrix.
boolean	getDefaultEnumerateColNames() returns the default of whether column names are prefixed with the index.
boolean	getDefaultPrintColNames() returns the default of whether column names or numbers instead are printed.
java.lang.String	getDisplayName() returns the name of the output format.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing the matrix.
static void	main(java.lang.String[] args) for testing only.
java.lang.String	toStringHeader() returns the header of the matrix as a string.
java.lang.String	toStringKey() returns returns a key for all the col names, for better readability if the names got cut off.
java.lang.String	toStringMatrix() returns the matrix as latex table.
java.lang.String	toStringRanking() returns the ranking in a string representation.
java.lang.String	toStringSummary() returns the summary as string.

Methods inherited from class weka.experiment.ResultMatrix

addHeader, assign, clearHeader, clearRanking, clearSummary, colNameWidthTipText, countWidthTipText, enumerateColNamesTipText, enumerateRowNamesTipText, getAverage, getColCount, getColHidden, getColName, getColNameWidth, getColOrder, getCount, getCountWidth, getDefaultColNameWidth, getDefaultCountWidth, getDefaultEnumerateRowNames, getDefaultMeanPrec, getDefaultMeanWidth, getDefaultPrintRowNames, getDefaultRemoveFilterName, getDefaultRowNameWidth, 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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

ResultMatrixLatex

public ResultMatrixLatex()

initializes the matrix as 1x1 matrix.

ResultMatrixLatex

public ResultMatrixLatex(int cols,
                         int rows)

initializes the matrix with the given dimensions.

Parameters:

cols - the number of columns

rows - the number of rows

ResultMatrixLatex

public ResultMatrixLatex(ResultMatrix matrix)

initializes the matrix with the values from the given matrix.

Parameters:

matrix - the matrix to get the values from

Method Detail

globalInfo

public java.lang.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 java.lang.String getDisplayName()

returns the name of the output format.

Specified by:

getDisplayName in class ResultMatrix

Returns:

the display name

clear

public void clear()

removes the stored data but retains the dimensions of the matrix.

Overrides:

clear in class ResultMatrix

getDefaultPrintColNames

public boolean getDefaultPrintColNames()

returns the default of whether column names or numbers instead are printed.

Overrides:

getDefaultPrintColNames in class ResultMatrix

Returns:

true if names instead of numbers are printed

getDefaultEnumerateColNames

public boolean getDefaultEnumerateColNames()

returns the default of whether column names are prefixed with the index.

Overrides:

getDefaultEnumerateColNames in class ResultMatrix

Returns:

true if the names are prefixed

toStringHeader

public java.lang.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 java.lang.String toStringMatrix()

returns the matrix as latex table.

Specified by:

toStringMatrix in class ResultMatrix

Returns:

the matrix

toStringKey

public java.lang.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 java.lang.String toStringSummary()

returns the summary as string.

Specified by:

toStringSummary in class ResultMatrix

Returns:

the summary

toStringRanking

public java.lang.String toStringRanking()

returns the ranking in a string representation.

Specified by:

toStringRanking in class ResultMatrix

Returns:

the ranking

getRevision

public java.lang.String getRevision()

Returns the revision string.

Returns:

the revision

main

public static void main(java.lang.String[] args)

for testing only.

Parameters:

args - ignored