jsat.linear

Class IndexValue

java.lang.Object

jsat.linear.IndexValue

public class IndexValue
extends java.lang.Object

The value at a specified index for one dimension. This is a tool mean for use with sparce data structures. The values should not be backed by any list, and changes to the IndexValue should not alter any data structures. This class is mean to be returned by an iterator, and the iterator may reuse the same IndexValue object for efficency.

Constructor Summary

Constructors

Constructor and Description
IndexValue(int index, double value) Creates a new IndexValue

Method Summary

Modifier and Type	Method and Description
int	getIndex() Returns the index of the stored value
double	getValue() Returns the value of the stored index
void	setIndex(int index) Sets the index associated with the value.
void	setValue(double value) Sets the value associated with the index

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexValue

public IndexValue(int index,
                  double value)

Creates a new IndexValue

Parameters:

index - the index for the given value

value - the value at the specified index

Method Detail

setIndex

public void setIndex(int index)

Sets the index associated with the value.

Parameters:

index - the new index

setValue

public void setValue(double value)

Sets the value associated with the index

Parameters:

value - the new value

getIndex

public int getIndex()

Returns the index of the stored value

Returns:

the index of the stored value

getValue

public double getValue()

Returns the value of the stored index

Returns:

the value of the stored index