edu.ucla.sspace.vector

Class MaskedSparseDoubleVectorView

java.lang.Object

edu.ucla.sspace.vector.MaskedDoubleVectorView

edu.ucla.sspace.vector.MaskedSparseDoubleVectorView

All Implemented Interfaces:

DoubleVector, SparseDoubleVector, SparseVector<Double>, Vector<Double>, Serializable

public class MaskedSparseDoubleVectorView
extends MaskedDoubleVectorView
implements SparseDoubleVector

A decorator that masked view of a SparseVector through the use of a mapping from new column indices to original column indices. The size of the new vector is based on the number of valid mappings.

Author:

Keith Stevens

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isImmutable Whether the vector data backing this instance is immutable
protected double	magnitude The magnitude of the vector or -1 if the value is currently invalid needs to be recomputed
protected Vector	vector The actual vector this ViewDoubleAsDoubleVector is decorating.
protected int	vectorLength A fixed length for this Vector.
protected int	vectorOffset The index at which the values vector are stored.

Fields inherited from class edu.ucla.sspace.vector.MaskedDoubleVectorView

updated

Constructor Summary

Constructors

Constructor and Description
MaskedSparseDoubleVectorView(T v, int[] columnMask, Map<Integer,Integer> reverseMask) Creates a new SparseDoubleVector view of the data in the provided SparseDoubleVector.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getNonZeroIndices() Returns all the indices whose values are non-zero
double	magnitude() Returns the magnitude of this vector
void	set(int index, Number value) Throws UnsupportedOperationException if called
String	toString()

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

add, get, getIndex, getOriginalVector, getValue, length, set, toArray

Methods inherited from class java.lang.Object

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

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

add, get, getValue, set, toArray

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

equals, hashCode, length, magnitude, set

Field Detail

isImmutable

protected final boolean isImmutable

Whether the vector data backing this instance is immutable

vector

protected final Vector vector

The actual vector this ViewDoubleAsDoubleVector is decorating.

vectorLength

protected final int vectorLength

A fixed length for this Vector. This length may be longer or less than that of vector.

vectorOffset

protected final int vectorOffset

The index at which the values vector are stored.

magnitude

protected double magnitude

The magnitude of the vector or -1 if the value is currently invalid needs to be recomputed

Constructor Detail

MaskedSparseDoubleVectorView

public MaskedSparseDoubleVectorView(T v,
                            int[] columnMask,
                            Map<Integer,Integer> reverseMask)

Creates a new SparseDoubleVector view of the data in the provided SparseDoubleVector.

Parameters:

v - the DoubleVector to view as containing double data.

columnMask - A mapping from new indices to old indices.

Method Detail

getNonZeroIndices

public int[] getNonZeroIndices()

Returns all the indices whose values are non-zero

Specified by:

getNonZeroIndices in interface SparseVector<Double>

set

public void set(int index,
       Number value)

Throws UnsupportedOperationException if called

Specified by:

set in interface Vector<T extends Number>

Parameters:

index - index to set.

value - value to set in the vector.

magnitude

public double magnitude()

Returns the magnitude of this vector

Specified by:

magnitude in interface Vector<T extends Number>

toString

public String toString()

Overrides:

toString in class Object