gov.sandia.cognition.math.matrix.mtj
Class TwoMatrixEntryMTJ

java.lang.Object
  extended by gov.sandia.cognition.math.matrix.mtj.TwoMatrixEntryMTJ
All Implemented Interfaces:
TwoMatrixEntry

public class TwoMatrixEntryMTJ
extends Object
implements TwoMatrixEntry

Stores an entry for two matrices typically used by iterators that do union and intersection operations.

Since:
1.0
Author:
Kevin R. Dixon

Constructor Summary
TwoMatrixEntryMTJ(AbstractMTJMatrix firstMatrix, AbstractMTJMatrix secondMatrix)
          Creates a new TwoMatrixEntryMTJ.
TwoMatrixEntryMTJ(AbstractMTJMatrix firstMatrix, AbstractMTJMatrix secondMatrix, int rowIndex, int columnIndex)
          Creates a new instance of TwoMatrixEntryMTJ.
 
Method Summary
 int getColumnIndex()
          Getter for columnIndex.
 AbstractMTJMatrix getFirstMatrix()
          Getter for firstMatrix.
 double getFirstValue()
          Gets the first value from the first underlying matrix.
 int getRowIndex()
          Getter for rowIndex.
 AbstractMTJMatrix getSecondMatrix()
          Getter for secondMatrix.
 double getSecondValue()
          Gets the value from the second underlying matrix.
 void setColumnIndex(int columnIndex)
          Setter for columnIndex.
 void setFirstMatrix(AbstractMTJMatrix firstMatrix)
          Setter for firstMatrix.
 void setFirstValue(double value)
          Sets the first value of the entry into the first underlying matrix.
 void setRowIndex(int rowIndex)
          Setter for rowIndex.
 void setSecondMatrix(AbstractMTJMatrix secondMatrix)
          Setter for secondMatrix.
 void setSecondValue(double value)
          Sets the entry value from the second underlying matrix.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TwoMatrixEntryMTJ

public TwoMatrixEntryMTJ(AbstractMTJMatrix firstMatrix,
                         AbstractMTJMatrix secondMatrix)
Creates a new TwoMatrixEntryMTJ.

Parameters:
firstMatrix - First underlying matrix for the entry.
secondMatrix - Second underlying matrix for the entry.

TwoMatrixEntryMTJ

public TwoMatrixEntryMTJ(AbstractMTJMatrix firstMatrix,
                         AbstractMTJMatrix secondMatrix,
                         int rowIndex,
                         int columnIndex)
Creates a new instance of TwoMatrixEntryMTJ.

Parameters:
firstMatrix - First underlying matrix for the entry.
secondMatrix - Second underlying matrix for the entry.
rowIndex - Current row index for the entry.
columnIndex - Current column index for the entry.
Method Detail

getColumnIndex

public int getColumnIndex()
Getter for columnIndex.

Specified by:
getColumnIndex in interface TwoMatrixEntry
Returns:
Current column index.

setColumnIndex

public void setColumnIndex(int columnIndex)
Setter for columnIndex.

Specified by:
setColumnIndex in interface TwoMatrixEntry
Parameters:
columnIndex - Current column index.

getRowIndex

public int getRowIndex()
Getter for rowIndex.

Specified by:
getRowIndex in interface TwoMatrixEntry
Returns:
Current row index for the entry.

setRowIndex

public void setRowIndex(int rowIndex)
Setter for rowIndex.

Specified by:
setRowIndex in interface TwoMatrixEntry
Parameters:
rowIndex - Current row index for the entry.

getFirstMatrix

public AbstractMTJMatrix getFirstMatrix()
Getter for firstMatrix.

Returns:
First underlying matrix in the entry.

setFirstMatrix

public void setFirstMatrix(AbstractMTJMatrix firstMatrix)
Setter for firstMatrix.

Parameters:
firstMatrix - First underlying matrix in the entry.

getSecondMatrix

public AbstractMTJMatrix getSecondMatrix()
Getter for secondMatrix.

Returns:
Second underlying matrix in the entry.

setSecondMatrix

public void setSecondMatrix(AbstractMTJMatrix secondMatrix)
Setter for secondMatrix.

Parameters:
secondMatrix - Second underlying matrix in the entry.

getFirstValue

public double getFirstValue()
Gets the first value from the first underlying matrix.

Specified by:
getFirstValue in interface TwoMatrixEntry
Returns:
Entry value from the first underlying matrix.

setFirstValue

public void setFirstValue(double value)
Sets the first value of the entry into the first underlying matrix.

Specified by:
setFirstValue in interface TwoMatrixEntry
Parameters:
value - Value to update the first underlying matrix.

getSecondValue

public double getSecondValue()
Gets the value from the second underlying matrix.

Specified by:
getSecondValue in interface TwoMatrixEntry
Returns:
Entry value from the second underlying matrix.

setSecondValue

public void setSecondValue(double value)
Sets the entry value from the second underlying matrix.

Specified by:
setSecondValue in interface TwoMatrixEntry
Parameters:
value - Value to set the entry in the second underlying matrix.