edu.ucla.sspace.vector

Interface DoubleVector

All Superinterfaces:

Vector<Double>

All Known Subinterfaces:

SparseDoubleVector

All Known Implementing Classes:

AbstractDoubleVector, AmortizedSparseVector, AtomicSparseVector, AtomicVector, CompactSparseVector, DenseDynamicMagnitudeVector, DenseVector, MaskedDoubleVectorView, MaskedSparseDoubleVectorView, ScaledDoubleVector, ScaledSparseDoubleVector, SparseHashDoubleVector

public interface DoubleVector
extends Vector<Double>

An generalized interface for vectors. This interface allows implementations to implement the vector with any kind of underlying data type, but the input and output data types must be doubles.

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
double	add(int index, double delta) Changes the value in this vector by a specified amount (optional operation).
double	get(int index) Returns the value of this vector at the given index.
Double	getValue(int index) Returns the value of the vector at the given index as a Double.
void	set(int index, double value) Sets the length in this vector (optional operation).
double[]	toArray() Returns a double array representing this vector.

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

equals, hashCode, length, magnitude, set

Method Detail

add

double add(int index,
         double delta)

Changes the value in this 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

double get(int index)

Returns the value of this vector at the given index.

Parameters:

index - index to retrieve.

Returns:

value at index.

getValue

Double getValue(int index)

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

Specified by:

getValue in interface Vector<Double>

Parameters:

{@inheritDoc} -

Returns:

value at index.

set

void set(int index,
       double value)

Sets the length in this vector (optional operation).

Parameters:

index - index to set.

value - value to set in the vector.

toArray

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.

Returns:

a double array of this vector.