edu.ucla.sspace.vector

Class DenseDynamicMagnitudeVector

java.lang.Object

edu.ucla.sspace.vector.DenseDynamicMagnitudeVector

All Implemented Interfaces:

DoubleVector, Vector<Double>, Serializable

public class DenseDynamicMagnitudeVector
extends Object
implements DoubleVector, Serializable

A Vector where all values are held in memory. The underlying implementation is simply an array of doubles. This implementation updates the magnitude everytime a value is modified. This can be a benefit if the vector regularly needs the magnitude to be computed but also has minor changes to it between each computation.

Author:

Keith Stevens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseDynamicMagnitudeVector(double[] vector) Create a DenseDynamicMagnitudeVector taking the values given by vector.
DenseDynamicMagnitudeVector(DoubleVector v) Create a DenseDynamicMagnitudeVector by copying the values from another Vector.
DenseDynamicMagnitudeVector(int vectorLength) Create an DenseDynamicMagnitudeVector 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) 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.
int	length() Return the size of the Vector.
double	magnitude() Returns the magnitude of this vector
void	set(int index, double value) Sets the length in this vector (optional operation).
void	set(int index, Number value) Set the value in the vector (optional operation).
double[]	toArray() Returns a double array representing this vector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equals, hashCode

Constructor Detail

DenseDynamicMagnitudeVector

public DenseDynamicMagnitudeVector(int vectorLength)

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

Parameters:

vectorLength - The size of the vector to create.

DenseDynamicMagnitudeVector

public DenseDynamicMagnitudeVector(double[] vector)

Create a DenseDynamicMagnitudeVector 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.

DenseDynamicMagnitudeVector

public DenseDynamicMagnitudeVector(DoubleVector v)

Create a DenseDynamicMagnitudeVector by copying the values from another Vector.

Parameters:

vector - The Vector to copy from.

Method Detail

add

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

Specified by:

add in interface DoubleVector

Parameters:

index - index to change.

delta - the amount to change by.

Returns:

the resulting value at the index

set

public void set(int index,
       double value)

Sets the length in this vector (optional operation).

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>

Parameters:

index - index to set.

value - value to set in the vector.

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.

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.

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<Double>

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.

length

public int length()

Return the size of the Vector.

Specified by:

length in interface Vector<Double>

Returns:

size of the vector.