edu.ucla.sspace.vector

Class DenseVector

java.lang.Object

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

edu.ucla.sspace.vector.AbstractDoubleVector

edu.ucla.sspace.vector.DenseVector

All Implemented Interfaces:

DoubleVector, Vector<Double>, Serializable

public class DenseVector
extends AbstractDoubleVector
implements Serializable

A Vector where all values are held in memory. The underlying implementation is simply an array of doubles.

Author:

Keith Stevens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseVector(double[] vector) Create a DenseVector taking the values given by vector.
DenseVector(DoubleVector v) Create a DenseVector by copying the values from another Vector.
DenseVector(int vectorLength) Create an DenseVector with all values starting at 0 with the given length.

Method Summary

Methods

Modifier and Type	Method and Description
double	add(int index, double delta) Throws an UnsupportedOperationException if called (vector is unmodifiable).
double	get(int index) Returns the value of this vector at the given index.
int	length() Return the size of the Vector.
double	magnitude() Returns the magnitude of this vector
void	set(int index, double value) Throws an UnsupportedOperationException if called (vector is unmodifiable).
double[]	toArray() Returns a double array representing this vector.

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

equals, getValue, hashCode, set, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DenseVector

public DenseVector(int vectorLength)

Create an DenseVector with all values starting at 0 with the given length.

Parameters:

vectorLength - The size of the vector to create.

DenseVector

public DenseVector(double[] vector)

Create a DenseVector taking the values given by vector. The created vector contains no references to the provided array, so changes to either will not be reflected in the other.

Parameters:

vector - The vector values to start with.

DenseVector

public DenseVector(DoubleVector v)

Create a DenseVector by copying the values from another Vector.

Parameters:

vector - The Vector to copy from.

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 AbstractDoubleVector

Parameters:

index - index to change.

delta - the amount to change by.

Returns:

the resulting value at the index

get

public double get(int index)

Returns the value of this vector at the given index.

Specified by:

get in interface DoubleVector

Parameters:

index - index to retrieve.

Returns:

value at index.

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<Double>

Overrides:

magnitude in class AbstractDoubleVector

set

public void set(int index,
       double value)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

set in interface DoubleVector

Overrides:

set in class AbstractDoubleVector

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

Overrides:

toArray in class AbstractDoubleVector

Returns:

a double array of this vector.

length

public int length()

Return the size of the Vector.

Specified by:

length in interface Vector<Double>

Returns:

size of the vector.