gov.sandia.cognition.math.matrix
Interface TwoMatrixEntry

All Known Implementing Classes:
TwoMatrixEntryMTJ

@CodeReview(reviewer="Jonathan McClain",
            date="2006-05-17",
            changesNeeded=true,
            comments="Why are there only getters and setters for second value, but not first value? Other than that looks fine.",
            response=@CodeReviewResponse(respondent="Kevin R. Dixon",date="2006-05-18",moreChangesNeeded=false,comments="Okie dokie... I removed the inheritance and made the function names more coherent, as requested."))
public interface TwoMatrixEntry

Interface that specifies the functionality for a class that stores entries for two matrices

Since:
1.0
Author:
Kevin R. Dixon

Method Summary
 int getColumnIndex()
          Gets the column index to which the entry points
 double getFirstValue()
          Gets the first value to which this entry points
 int getRowIndex()
          Gets the current row index to which this entry points
 double getSecondValue()
          Gets the second value to which this entry points
 void setColumnIndex(int columnIndex)
          Sets the column index to which the entry points
 void setFirstValue(double value)
          Sets the first value to which this entry points
 void setRowIndex(int rowIndex)
          Sets the current row index to which this entry points
 void setSecondValue(double value)
          Sets the second value to which this entry points
 

Method Detail

getColumnIndex

int getColumnIndex()
Gets the column index to which the entry points

Returns:
zero-based column index

setColumnIndex

void setColumnIndex(int columnIndex)
Sets the column index to which the entry points

Parameters:
columnIndex - new zero-based column index for the entry

getRowIndex

int getRowIndex()
Gets the current row index to which this entry points

Returns:
current zero-based index

setRowIndex

void setRowIndex(int rowIndex)
Sets the current row index to which this entry points

Parameters:
rowIndex - zero-based row index

getFirstValue

double getFirstValue()
Gets the first value to which this entry points

Returns:
value of the first entry

setFirstValue

void setFirstValue(double value)
Sets the first value to which this entry points

Parameters:
value - new value of the first entry

getSecondValue

double getSecondValue()
Gets the second value to which this entry points

Returns:
value of the second entry

setSecondValue

void setSecondValue(double value)
Sets the second value to which this entry points

Parameters:
value - new value of the second entry