edu.ucla.sspace.vector

Interface IntegerVector

All Superinterfaces:

Vector<Integer>

All Known Subinterfaces:

SparseIntegerVector

All Known Implementing Classes:

AbstractIntegerVector, CompactSparseIntegerVector, DenseIntVector, SparseHashIntegerVector, TernaryVector

public interface IntegerVector
extends Vector<Integer>

An Integer based Vector. Methods which modify the state of a Vector are optional. Implementations that are not modifiable should throw an UnsupportedOperationException if such methods are called. These methods are marked as "optional" in the specification for the interface.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int index, int delta) Changes the value in the vector by a specified amount (optional operation).
int	get(int index) Returns the value of this vector at the given index.
Integer	getValue(int index) Returns the value of the vector at the given index as a Integer.
void	set(int index, int value) Sets the value in this vector (optional operation).
int[]	toArray() Returns an int array representing this vector.

Methods inherited from interface edu.ucla.sspace.vector.Vector

equals, hashCode, length, magnitude, set

Method Detail

add

int add(int index,
      int delta)

Changes the value in the vector by a specified amount (optional operation). If there is not a value set at index, delta should be set to the actual value.

Parameters:

index - index to change.

delta - the amount to change by.

Returns:

the resulting value at the index

get

int get(int index)

Returns the value of this vector at the given index.

Parameters:

index - index to retrieve.

Returns:

value at index.

getValue

Integer getValue(int index)

Returns the value of the vector at the given index as a Integer.

Specified by:

getValue in interface Vector<Integer>

Parameters:

{@inheritDoc} -

Returns:

value at index.

set

void set(int index,
       int value)

Sets the value in this vector (optional operation).

Parameters:

index - index to set.

value - value to set in the vector.

toArray

int[] toArray()

Returns an int array representing this vector. The returned array will be "safe" in that no changes to the array will be reflected in the vector, and likewise for changes to to the vector. The caller is thus free to modify the returned array.

Returns:

an int array of this vector.