org.petuum.jbosen.row.double_

Interface DoubleColumnIterator

public interface DoubleColumnIterator

This interface specifies an iterator over a DoubleColumnMap object. Typical usage of this class is as follows:

 
 DoubleColumnIterator iter = someDoubleColumnMap.iterator();
 while (iter.hasNext()) {
     iter.advance();
     int columnId = iter.getColumnId();
     double value = iter.getValue();
 }
 
 

Method Summary

Modifier and Type	Method and Description
void	advance() Advance the iterator to the next columnId-value pair.
int	getColumnId() Returns the columnId of the current columnId-value pair.
double	getValue() Returns the value of the current columnId-value pair.
boolean	hasNext() Check whether the iterator has a next element.
void	incValue(double value) Increments the value of the current columnId-value pair.
void	setValue(double value) Sets the value of the current columnId-value pair.

Method Detail

hasNext

boolean hasNext()

Check whether the iterator has a next element.

Returns:

whether or not there is a next element.

advance

void advance()

Advance the iterator to the next columnId-value pair. Must be called after instantiation to access the first element.

getColumnId

int getColumnId()

Returns the columnId of the current columnId-value pair.

Returns:

current column ID of the iterator.

getValue

double getValue()

Returns the value of the current columnId-value pair.

Returns:

current value of the iterator.

setValue

void setValue(double value)

Sets the value of the current columnId-value pair.

Parameters:

value - new value to be set.

incValue

void incValue(double value)

Increments the value of the current columnId-value pair.

Parameters:

value - value to increment by.