gov.sandia.cognition.math.matrix

Class VectorUnionIterator

java.lang.Object

gov.sandia.cognition.math.matrix.VectorUnionIterator

All Implemented Interfaces:

java.util.Iterator<TwoVectorEntry>

@CodeReview(reviewer="Jonathan McClain",
            date="2006-05-17",
            changesNeeded=false,
            comments="Looks fine.")
public class VectorUnionIterator
extends java.lang.Object
implements java.util.Iterator<TwoVectorEntry>

Iterator that returns all nonzero entries for either underlying Vector

Since:

1.0

Author:

Kevin R. Dixon

Constructor Summary

Constructors

Constructor and Description
VectorUnionIterator(java.util.Iterator<VectorEntry> firstIterator, java.util.Iterator<VectorEntry> secondIterator, TwoVectorEntry internalEntry) Creates a new instance of VectorUnionIterator
VectorUnionIterator(Vector first, Vector second) Creates a new instance of VectorUnionIterator.

Method Summary

Modifier and Type	Method and Description
protected void	advanceInternalIterators() Internal method for advancing the internal Iterators
VectorEntry	getFirstInternalEntry() getter for firstInternalEntry
java.util.Iterator<VectorEntry>	getFirstIterator() getter for firstIterator
TwoVectorEntry	getInternalEntry() getter for internalEntry
VectorEntry	getSecondInternalEntry() getter for secondInternalEntry
java.util.Iterator<VectorEntry>	getSecondIterator() getter for secondIterator
boolean	hasNext()
TwoVectorEntry	next()
void	remove()
boolean	safeFirstNext() Try to advance the first entry...
boolean	safeSecondNext() Try to advance the second entry...
void	setFirstInternalEntry(VectorEntry firstInternalEntry) setter for firstInternalEntry
void	setFirstIterator(java.util.Iterator<VectorEntry> firstIterator) setter for firstIterator
void	setInternalEntry(TwoVectorEntry internalEntry) setter for internalEntry
void	setSecondInternalEntry(VectorEntry secondInternalEntry) setter for secondInternalEntry
void	setSecondIterator(java.util.Iterator<VectorEntry> secondIterator) setter for secondIterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

VectorUnionIterator

public VectorUnionIterator(Vector first,
                           Vector second)

Creates a new instance of VectorUnionIterator.

Parameters:

first - The first Vector.

second - The second Vector.

VectorUnionIterator

public VectorUnionIterator(java.util.Iterator<VectorEntry> firstIterator,
                           java.util.Iterator<VectorEntry> secondIterator,
                           TwoVectorEntry internalEntry)

Creates a new instance of VectorUnionIterator

Parameters:

firstIterator - Iterator from the first Vector

secondIterator - Iterator from the second Vector

internalEntry - TwoVectorEntry that represents entries from both Vectors

Method Detail

advanceInternalIterators

protected void advanceInternalIterators()

Internal method for advancing the internal Iterators

safeFirstNext

public boolean safeFirstNext()

Try to advance the first entry... if the iterator throws an exception, then there are no more elements in the vector, so just null out the entry

Returns:

true if next was valid, false otherwise

safeSecondNext

public boolean safeSecondNext()

Try to advance the second entry... if the iterator throws an exception, then there are no more elements in the vector, so just null out the entry

Returns:

true if next was valid, false otherwise

getFirstIterator

public java.util.Iterator<VectorEntry> getFirstIterator()

getter for firstIterator

Returns:

Iterator from the first Vector

setFirstIterator

public void setFirstIterator(java.util.Iterator<VectorEntry> firstIterator)

setter for firstIterator

Parameters:

firstIterator - Iterator from the first Vector

getSecondIterator

public java.util.Iterator<VectorEntry> getSecondIterator()

getter for secondIterator

Returns:

Iterator from the second Vector

setSecondIterator

public void setSecondIterator(java.util.Iterator<VectorEntry> secondIterator)

setter for secondIterator

Parameters:

secondIterator - Iterator from the second Vector

getInternalEntry

public TwoVectorEntry getInternalEntry()

getter for internalEntry

Returns:

TwoVectorEntry that represents both Vectors

setInternalEntry

public void setInternalEntry(TwoVectorEntry internalEntry)

setter for internalEntry

Parameters:

internalEntry - TwoVectorEntry that represents entries from both Vectors

getFirstInternalEntry

public VectorEntry getFirstInternalEntry()

getter for firstInternalEntry

Returns:

VectorEntry from the first Vector

setFirstInternalEntry

public void setFirstInternalEntry(VectorEntry firstInternalEntry)

setter for firstInternalEntry

Parameters:

firstInternalEntry - VectorEntry from the first Vector

getSecondInternalEntry

public VectorEntry getSecondInternalEntry()

getter for secondInternalEntry

Returns:

VectorEntry from the second Vector

setSecondInternalEntry

public void setSecondInternalEntry(VectorEntry secondInternalEntry)

setter for secondInternalEntry

Parameters:

secondInternalEntry - VectorEntry from the second Vector

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<TwoVectorEntry>

next

public TwoVectorEntry next()

Specified by:

next in interface java.util.Iterator<TwoVectorEntry>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<TwoVectorEntry>