edu.ucla.sspace.vector

Interface Vector<T extends Number>

All Known Subinterfaces:

DoubleVector, IntegerVector, SparseDoubleVector, SparseIntegerVector, SparseVector<T>

All Known Implementing Classes:

AbstractDoubleVector, AbstractIntegerVector, AbstractVector, AmortizedSparseVector, AtomicSparseVector, AtomicVector, CompactSparseIntegerVector, CompactSparseVector, DenseDynamicMagnitudeVector, DenseIntVector, DenseVector, MaskedDoubleVectorView, MaskedSparseDoubleVectorView, ScaledDoubleVector, ScaledSparseDoubleVector, SparseHashDoubleVector, SparseHashIntegerVector, SparseHashVector, TernaryVector

public interface Vector<T extends Number>

An generalized interface for vectors. This interface allows implementations to implement the vector with any kind of underlying data type.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if the object is a Vector of the same length and whose corresponding indices have equivalent values.
Number	getValue(int index) Return the value of the vector at the given index as a Number.
int	hashCode() Returns the hash code as the sum of the vectors elements, normalized to an int.
int	length() Return the size of the Vector.
double	magnitude() Returns the magnitude of this vector
void	set(int index, Number value) Set the value in the vector (optional operation).

Method Detail

equals

boolean equals(Object o)

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

Overrides:

equals in class Object

getValue

Number getValue(int index)

Return the value of the vector at the given index as a Number.

Parameters:

index - index to retrieve.

Returns:

value at index.

hashCode

int hashCode()

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

Overrides:

hashCode in class Object

length

int length()

Return the size of the Vector.

Returns:

size of the vector.

magnitude

double magnitude()

Returns the magnitude of this vector

set

void set(int index,
       Number value)

Set the value in the vector (optional operation).

Parameters:

index - index to set.

value - value to set in the vector.