edu.ucla.sspace.vector

Class CompactSparseIntegerVector

java.lang.Object

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

edu.ucla.sspace.vector.AbstractIntegerVector

edu.ucla.sspace.vector.CompactSparseIntegerVector

All Implemented Interfaces:

IntegerVector, SparseIntegerVector, SparseVector<Integer>, Vector<Integer>, Serializable, Iterable<IntegerEntry>

public class CompactSparseIntegerVector
extends AbstractIntegerVector
implements SparseIntegerVector, Serializable, Iterable<IntegerEntry>

A sparse IntegerVector class whose data is back by a compact sparse array. Access to the elements of this vector is O(log(n)).

Author:

Keith Stevens, David Jurgens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompactSparseIntegerVector(int length) Creates a new vector of the specified length
CompactSparseIntegerVector(int[] values) Creates a new vector using the non-zero values of the specified array.
CompactSparseIntegerVector(IntegerVector v) Creates a new vector using the values of the specified vector.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int index, int delta) Throws an UnsupportedOperationException if called (vector is unmodifiable).
int	get(int index) Returns the value of this vector at the given index.
int[]	getNonZeroIndices() Returns all the indices whose values are non-zero
Iterator<IntegerEntry>	iterator() Returns an iterator over all the non-zero indices and values in this vector.
int	length() Return the size of the Vector.
double	magnitude() Returns the magnitude of this vector
void	set(int index, int value) Throws an UnsupportedOperationException if called (vector is unmodifiable).

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

equals, getValue, hashCode, set, toArray, toString

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

add

Methods inherited from class java.lang.Object

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

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

getValue, toArray

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

equals, hashCode, set

Constructor Detail

CompactSparseIntegerVector

public CompactSparseIntegerVector(int length)

Creates a new vector of the specified length

Parameters:

length - the length of this vector

CompactSparseIntegerVector

public CompactSparseIntegerVector(IntegerVector v)

Creates a new vector using the values of the specified vector. The created vector contains no references to the provided vector, so changes to either will not be reflected in the other.

Parameters:

v - the intial values for this vector to have

CompactSparseIntegerVector

public CompactSparseIntegerVector(int[] values)

Creates a new vector using the non-zero values of the specified array. The created vector contains no references to the provided array, so changes to either will not be reflected in the other.

Parameters:

values - the intial values for this vector to have

Method Detail

add

public int add(int index,
      int delta)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

add in interface IntegerVector

Overrides:

add in class AbstractIntegerVector

Parameters:

index - index to change.

delta - the amount to change by.

Returns:

the resulting value at the index

get

public int get(int index)

Returns the value of this vector at the given index.

Specified by:

get in interface IntegerVector

Parameters:

index - index to retrieve.

Returns:

value at index.

getNonZeroIndices

public int[] getNonZeroIndices()

Returns all the indices whose values are non-zero

Specified by:

getNonZeroIndices in interface SparseVector<Integer>

iterator

public Iterator<IntegerEntry> iterator()

Returns an iterator over all the non-zero indices and values in this vector.

Specified by:

iterator in interface Iterable<IntegerEntry>

length

public int length()

Return the size of the Vector.

Specified by:

length in interface Vector<Integer>

Returns:

size of the vector.

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<Integer>

Overrides:

magnitude in class AbstractIntegerVector

set

public void set(int index,
       int value)

Throws an UnsupportedOperationException if called (vector is unmodifiable).

Specified by:

set in interface IntegerVector

Overrides:

set in class AbstractIntegerVector

Parameters:

index - index to set.

value - value to set in the vector.