sbrt.shell.text.math
Class MatrixElementFormatV1<R,C>

java.lang.Object
  extended by sbrt.shell.text.math.MatrixElementFormatV1<R,C>
Type Parameters:
R - the row index type.
C - the column index type.
All Implemented Interfaces:
Format, Formatter<MatrixElement<R,C,java.lang.Double>>, MatrixElementFormat<R,C,java.lang.Double>, Parser<MatrixElement<R,C,java.lang.Double>>, SimpleFormat<MatrixElement<R,C,java.lang.Double>>

public final class MatrixElementFormatV1<R,C>
extends java.lang.Object
implements MatrixElementFormat<R,C,java.lang.Double>

This class is a concrete implementation of MatrixElementFormat. The string representation of matrix elements used by this class is: [RowIndex | ColumnIndex] = Element.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
MatrixElementFormatV1(SimpleFormat<R> rowIndexFormat, SimpleFormat<C> columnIndexFormat)
          Constructs a new matrix element format.
 
Method Summary
 java.lang.String format(MatrixElement<R,C,java.lang.Double> indexPair)
          Returns a formatted string representation of the provided matrix element.
 java.lang.String formatElement(MatrixElement<? extends R,? extends C,java.lang.Double> element)
          Returns a formatted string representation of the provided matrix element.
 DoubleFormatV1 getElementFormat()
          Returns the format used for matrix elements.
 IndexPairFormatV1<R,C> getIndexFormat()
          Returns the format used for matrix elements.
 MatrixElement<R,C,java.lang.Double> parse(java.lang.String element)
          Parses the provided string and returns its corresponding matrix element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface sbrt.shell.text.Formatter
format
 

Constructor Detail

MatrixElementFormatV1

public MatrixElementFormatV1(SimpleFormat<R> rowIndexFormat,
                             SimpleFormat<C> columnIndexFormat)
Constructs a new matrix element format.

Parameters:
rowIndexFormat - the row index formatter.
columnIndexFormat - the column index formatter.
Method Detail

getIndexFormat

public IndexPairFormatV1<R,C> getIndexFormat()
Returns the format used for matrix elements.

Returns:
the format used for matrix elements.

getElementFormat

public DoubleFormatV1 getElementFormat()
Returns the format used for matrix elements.

Returns:
the format used for matrix elements.

formatElement

public java.lang.String formatElement(MatrixElement<? extends R,? extends C,java.lang.Double> element)
Returns a formatted string representation of the provided matrix element.

Parameters:
element - the matrix element to be formatted.
Returns:
a formatted string representation of the provided matrix element.

format

public java.lang.String format(MatrixElement<R,C,java.lang.Double> indexPair)
Returns a formatted string representation of the provided matrix element.

Parameters:
indexPair - the matrix element to be formatted.
Returns:
a formatted string representation of the provided matrix element.

parse

public MatrixElement<R,C,java.lang.Double> parse(java.lang.String element)
Parses the provided string and returns its corresponding matrix element.

Specified by:
parse in interface Parser<MatrixElement<R,C,java.lang.Double>>
Parameters:
element - the string to be parsed.
Returns:
the matrix element corresponding to the provided string.