edu.ucla.sspace.vector

Class AbstractIntegerVector

java.lang.Object

edu.ucla.sspace.vector.AbstractVector<Integer>

edu.ucla.sspace.vector.AbstractIntegerVector

All Implemented Interfaces:

IntegerVector, Vector<Integer>

Direct Known Subclasses:

CompactSparseIntegerVector, DenseIntVector, SparseHashIntegerVector

public abstract class AbstractIntegerVector
extends AbstractVector<Integer>
implements IntegerVector

An abstract base class that provides default implementations of common methods in IntegerVector. IntegerVector implementations need only implement Vector.length() and IntegerVector.get(int) functionality to be read-only vectors.

Constructor Summary

Constructors

Constructor and Description
AbstractIntegerVector()

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int index, int delta) Throws an UnsupportedOperationException if called (vector is unmodifiable).
boolean	equals(Object o) Returns true if the object is a Vector of the same length and whose corresponding indices have equivalent values.
Integer	getValue(int index) Returns the value of the vector at the given index as a Integer.
int	hashCode() Returns the hash code as the sum of the vectors elements, normalized to an int.
double	magnitude() Returns the magnitude of this vector
void	set(int index, int value) Throws an UnsupportedOperationException if called (vector is unmodifiable).
void	set(int index, Number value) Set the value in the vector (optional operation).
int[]	toArray() Returns an int array representing this vector.
String	toString() Returns a string description of the full contents of this vector

Methods inherited from class edu.ucla.sspace.vector.AbstractVector

add

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

get

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

length

Constructor Detail

AbstractIntegerVector

public AbstractIntegerVector()

Method Detail

add

public int add(int index,
      int delta)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

add in interface IntegerVector

Parameters:

index - index to change.

delta - the amount to change by.

Returns:

the resulting value at the index

equals

public boolean equals(Object o)

Returns true if the object is a Vector of the same length and whose corresponding indices have equivalent values.

Specified by:

equals in interface Vector<Integer>

Overrides:

equals in class AbstractVector<Integer>

getValue

public Integer getValue(int index)

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

Specified by:

getValue in interface IntegerVector

Specified by:

getValue in interface Vector<Integer>

Parameters:

index - index to retrieve.

Returns:

value at index.

hashCode

public int hashCode()

Returns the hash code as the sum of the vectors elements, normalized to an int.

Specified by:

hashCode in interface Vector<Integer>

Overrides:

hashCode in class AbstractVector<Integer>

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<Integer>

Overrides:

magnitude in class AbstractVector<Integer>

set

public void set(int index,
       int value)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

set in interface IntegerVector

Parameters:

index - index to set.

value - value to set in the vector.

set

public void set(int index,
       Number value)

Set the value in the vector (optional operation).

Specified by:

set in interface Vector<Integer>

Overrides:

set in class AbstractVector<Integer>

Parameters:

index - index to set.

value - value to set in the vector.

toArray

public 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.

Specified by:

toArray in interface IntegerVector

Returns:

an int array of this vector.

toString

public String toString()

Returns a string description of the full contents of this vector

Overrides:

toString in class AbstractVector<Integer>