gov.sandia.cognition.math.matrix

Class DefaultTwoVectorEntry

java.lang.Object

gov.sandia.cognition.math.matrix.DefaultTwoVectorEntry

All Implemented Interfaces:

TwoVectorEntry

@CodeReview(reviewer="Justin Basilico",
            date="2006-07-26",
            changesNeeded=false,
            comments="Looks good.")
public class DefaultTwoVectorEntry
extends java.lang.Object
implements TwoVectorEntry

Stores an entry for two vectors. Typically used by iterators that do union and intersection operations

Since:

1.0

Author:

Kevin R. Dixon

Constructor Summary

Constructors

Constructor and Description
DefaultTwoVectorEntry(Vector firstVector, Vector secondVector) Creates a new instance of DefaultTwoVectorEntry.
DefaultTwoVectorEntry(Vector firstVector, Vector secondVector, int index) Creates a new instance of DefaultTwoVectorEntry.

Method Summary

Modifier and Type	Method and Description
double	getFirstValue() Gets the entry value from the first underlying vector.
Vector	getFirstVector() Getter for firstVector.
int	getIndex() Gets the current index into the underlying vectors.
double	getSecondValue() Gets the entry value for the second underlying vector
Vector	getSecondVector() Getter for secondVector.
void	setFirstValue(double value) Sets the entry value to the first underlying vector.
void	setFirstVector(Vector firstVector) Setter for firstVector.
void	setIndex(int index) Sets the current index into the underlying vectors.
void	setSecondValue(double value) Sets the entry value for the second underlying vector.
void	setSecondVector(Vector secondVector) Setter for secondVector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTwoVectorEntry

public DefaultTwoVectorEntry(Vector firstVector,
                             Vector secondVector)

Creates a new instance of DefaultTwoVectorEntry.

Parameters:

firstVector - First underlying vector

secondVector - Second underlying vector

DefaultTwoVectorEntry

public DefaultTwoVectorEntry(Vector firstVector,
                             Vector secondVector,
                             int index)

Creates a new instance of DefaultTwoVectorEntry.

Parameters:

firstVector - First underlying vector.

secondVector - Second underlying vector.

index - Current index into the vectors.

Method Detail

getFirstVector

public Vector getFirstVector()

Getter for firstVector.

Returns:

First underlying vector

setFirstVector

public void setFirstVector(Vector firstVector)

Setter for firstVector.

Parameters:

firstVector - First underlying vector.

getSecondVector

public Vector getSecondVector()

Getter for secondVector.

Returns:

Second underlying vector.

setSecondVector

public void setSecondVector(Vector secondVector)

Setter for secondVector.

Parameters:

secondVector - Second underlying vector.

getFirstValue

public double getFirstValue()

Gets the entry value from the first underlying vector.

Specified by:

getFirstValue in interface TwoVectorEntry

Returns:

Entry value from the first underlying vector.

setFirstValue

public void setFirstValue(double value)

Sets the entry value to the first underlying vector.

Specified by:

setFirstValue in interface TwoVectorEntry

Parameters:

value - Entry value to the first underlying vector.

getIndex

public int getIndex()

Gets the current index into the underlying vectors.

Specified by:

getIndex in interface TwoVectorEntry

Returns:

Current index into the underlying vectors.

setIndex

public void setIndex(int index)

Sets the current index into the underlying vectors.

Specified by:

setIndex in interface TwoVectorEntry

Parameters:

index - Current index into the underlying vectors.

getSecondValue

public double getSecondValue()

Gets the entry value for the second underlying vector

Specified by:

getSecondValue in interface TwoVectorEntry

Returns:

Entry value for the second underlying vector

setSecondValue

public void setSecondValue(double value)

Sets the entry value for the second underlying vector.

Specified by:

setSecondValue in interface TwoVectorEntry

Parameters:

value - Entry value for the second underlying vector.