edu.ucla.sspace.vector

Class AbstractDoubleVector

java.lang.Object

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

edu.ucla.sspace.vector.AbstractDoubleVector

All Implemented Interfaces:

DoubleVector, Vector<Double>

Direct Known Subclasses:

CompactSparseVector, DenseVector

public abstract class AbstractDoubleVector
extends AbstractVector<Double>
implements DoubleVector

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

Constructor Summary

Constructors

Constructor and Description
AbstractDoubleVector()

Method Summary

Methods

Modifier and Type	Method and Description
double	add(int index, double 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.
Double	getValue(int index) Returns the value of the vector at the given index as a Double.
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, double value) Throws an UnsupportedOperationException if called (vector is unmodifiable).
void	set(int index, Number value) Set the value in the vector (optional operation).
double[]	toArray() Returns a double array representing this vector.
String	toString() Returns a string description of the full contents of this vector

Methods inherited from class java.lang.Object

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

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

get

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

length

Constructor Detail

AbstractDoubleVector

public AbstractDoubleVector()

Method Detail

add

public double add(int index,
         double delta)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

add in interface DoubleVector

Overrides:

add in class AbstractVector<Double>

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<Double>

Overrides:

equals in class AbstractVector<Double>

getValue

public Double getValue(int index)

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

Specified by:

getValue in interface DoubleVector

Specified by:

getValue in interface Vector<Double>

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<Double>

Overrides:

hashCode in class AbstractVector<Double>

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<Double>

Overrides:

magnitude in class AbstractVector<Double>

set

public void set(int index,
       double value)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

set in interface DoubleVector

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<Double>

Overrides:

set in class AbstractVector<Double>

Parameters:

index - index to set.

value - value to set in the vector.

toArray

public double[] toArray()

Returns a double 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 DoubleVector

Returns:

a double array of this vector.

toString

public String toString()

Returns a string description of the full contents of this vector

Overrides:

toString in class AbstractVector<Double>