gov.sandia.cognition.math.matrix
Interface TwoVectorEntry

All Known Implementing Classes:
DefaultTwoVectorEntry

@CodeReview(reviewer="Jonathan McClain",
            date="2006-05-17",
            changesNeeded=true,
            comments="Comments marked with triple slash",
            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 TwoVectorEntry

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

Since:
1.0
Author:
Kevin R. Dixon

Method Summary
 double getFirstValue()
          Gets the first value to which this entry points
 int getIndex()
          Gets the current index into the Vector to which this entry points
 double getSecondValue()
          Gets the second value to which this entry points
 void setFirstValue(double value)
          Sets the first value to which this entry points
 void setIndex(int index)
          Sets the current index into the Vector to which this entry points
 void setSecondValue(double value)
          Sets the second value to which this entry points
 

Method Detail

getIndex

int getIndex()
Gets the current index into the Vector to which this entry points

Returns:
current zero-based index

setIndex

void setIndex(int index)
Sets the current index into the Vector to which this entry points

Parameters:
index - zero-based index into the Vector

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 second entry

getSecondValue

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

Returns:
value of the first entry

setSecondValue

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

Parameters:
value - new value of the second entry