SparseVector (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.datatypes.SparseVector

All Implemented Interfaces:

Serializable, Cloneable
```
public class SparseVector
extends Object
implements Serializable, Cloneable
```
Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class represents a Sparse Vector, i.e. a vector that has only few non-zero entries. Supports special (space-)optimized routines for binary vectors. Supports k-means with eucledian, cosine or other distances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SparseVector.Distance
Computes a distance of two vectors

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SparseVector.Distance` Computes a distance of two vectors

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double[]`	`BINARY` Standard values for a binary vector (just 1,1,1,...; gets prolonged if needed)
`static SparseVector.Distance`	`cosineDistance` Computes the cosine distance
`protected int[]`	`dim` dim[i] tells what dimension val[i] belongs to.
`static SparseVector.Distance`	`eucledianDistance` Computes the eucledian distance
`protected double`	`label` Contains a double value associated to this Sparse Vector
`protected int`	`size` Holds the number of non-zero values of this vector
`protected static int[]`	`STANDARDDIM` Standard dimensions 0...
`protected double`	`twonorm_sq` Holds the squared two_norm of this vector, computed on demand
`protected double[]`	`val` Contains the values of this vector (corresponding to dim).

Constructor Summary

Constructors
Constructor and Description
`SparseVector(double[] v, int[] d)` Creates a Sparse Vector from (sorted) dimensions and values
`SparseVector(double label, double... values)` Creates a SparseVector from actual values
`SparseVector(double l, int[] d)` Creates a binary Sparse Vector from an unsorted array of dimensions and a label Zero-entries and duplicates in the dimension array will be ignored.
`SparseVector(double l, int[] d, double[] v)` Creates a Sparse Vector from (sorted) dimensions, (modifiable) values and a label
`SparseVector(double l, List<Integer> dimensions)` Creates a binary Sparse Vector from an (unsorted) list of dimensions and a label
`SparseVector(SparseVector v)` Duplicates a vector
`SparseVector(String s)` Creates a Sparse Vector from a SVM-light-like input string of the form label dim:val ...

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SparseVector`	`add(SparseVector v)` Adds a vector to this one
`char`	`charLabel()` Returns a char label for the vector
`SparseVector`	`clone()` Clones a vector
`SparseVector`	`compress()` Kicks out 0-entries (without affecting the vector in a mathematical sense)
`double`	`cosine(SparseVector v)` Returns the cosine of this vector with another vector
`double`	`eucledianDistance(SparseVector v)` Returns the distance to another vector
`double`	`get(int i)` Retrieves the i-th value
`int`	`index(int dimension)` Returns the index for a dimension (or -1)
`boolean`	`isBinary()` Tells whether this vector is binary
`static void`	`kMeans(SparseVector[] dots, SparseVector[] centers)` Does a simple K-means
`static void`	`kMeans(SparseVector[] dots, SparseVector[] centers, SparseVector.Distance distanceFunction, double epsilon, int iterations)` Does a simple K-means until the number of iterations is exceeded
`double`	`l2norm()` Returns this vector's two-norm
`static void`	`main(String[] argv)` Test method
`SparseVector`	`multiply(double r)` Multiplies this vector by a scalar
`Iterator<Integer>`	`nonZeroIndices()` Gives an iterator over the non-zero indices
`int`	`size()` Returns the number of non-zero elements.
`double`	`sprod(SparseVector v)` Returns the scalar product (dot product) of this vector with another one.
`double`	`squaredl2norm()` Returns this vector's squared two-norm
`String`	`toString()` Returns a String representation in an SVM-light-like format label dim:val ...
`protected static void`	`updateBINARY(int num)` Ensures that the BINARY array has enough 1's
`static String`	`visualize(List<SparseVector> vectors)` Visualizes two-dimensional vectors
`static String`	`visualize(List<SparseVector> vectors1, List<SparseVector> vectors2)` Visualizes two-dimensional vectors
`static String`	`visualize(SparseVector... vectors)` Visualizes two-dimensional vectors
`static String`	`visualize(SparseVector[] vectors1, SparseVector[] vectors2)` Visualizes two-dimensional vectors

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - label
```
protected double label
```
    Contains a double value associated to this Sparse Vector
  - val
```
protected double[] val
```
    Contains the values of this vector (corresponding to dim). May change. May be set to BINARY.
  - dim
```
protected int[] dim
```
    dim[i] tells what dimension val[i] belongs to. Does not change. May be set to STANDARDDIM
  - STANDARDDIM
```
protected static int[] STANDARDDIM
```
    Standard dimensions 0... (gets prolonged if needed)
  - BINARY
```
protected static double[] BINARY
```
    Standard values for a binary vector (just 1,1,1,...; gets prolonged if needed)
  - size
```
protected int size
```
    Holds the number of non-zero values of this vector
  - twonorm_sq
```
protected double twonorm_sq
```
    Holds the squared two_norm of this vector, computed on demand
  - eucledianDistance
```
public static final SparseVector.Distance eucledianDistance
```
    Computes the eucledian distance
  - cosineDistance
```
public static final SparseVector.Distance cosineDistance
```
    Computes the cosine distance
- Constructor Detail
  - SparseVector
```
public SparseVector(SparseVector v)
```
    Duplicates a vector
  - SparseVector
```
public SparseVector(double l,
                    List<Integer> dimensions)
```
    Creates a binary Sparse Vector from an (unsorted) list of dimensions and a label
  - SparseVector
```
public SparseVector(double l,
                    int[] d)
```
    Creates a binary Sparse Vector from an unsorted array of dimensions and a label Zero-entries and duplicates in the dimension array will be ignored. Left here as a legacy from LEILA
  - SparseVector
```
public SparseVector(double[] v,
                    int[] d)
```
    Creates a Sparse Vector from (sorted) dimensions and values
  - SparseVector
```
public SparseVector(double l,
                    int[] d,
                    double[] v)
```
    Creates a Sparse Vector from (sorted) dimensions, (modifiable) values and a label
  - SparseVector
```
public SparseVector(double label,
                    double... values)
```
    Creates a SparseVector from actual values
  - SparseVector
```
public SparseVector(String s)
```
    Creates a Sparse Vector from a SVM-light-like input string of the form label dim:val ... # comments
- Method Detail
  - updateBINARY
```
protected static void updateBINARY(int num)
```
    Ensures that the BINARY array has enough 1's
  - compress
```
public SparseVector compress()
```
    Kicks out 0-entries (without affecting the vector in a mathematical sense)
  - toString
```
public String toString()
```
    Returns a String representation in an SVM-light-like format label dim:val ...
    
    Overrides:
    
    toString in class Object
  - sprod
```
public double sprod(SparseVector v)
```
    Returns the scalar product (dot product) of this vector with another one. This code is optimized by speed, not by size
  - isBinary
```
public boolean isBinary()
```
    Tells whether this vector is binary
  - size
```
public int size()
```
    Returns the number of non-zero elements.
  - squaredl2norm
```
public double squaredl2norm()
```
    Returns this vector's squared two-norm
  - l2norm
```
public double l2norm()
```
    Returns this vector's two-norm
  - cosine
```
public double cosine(SparseVector v)
```
    Returns the cosine of this vector with another vector
  - get
```
public double get(int i)
```
    Retrieves the i-th value
  - visualize
```
public static String visualize(SparseVector... vectors)
```
    Visualizes two-dimensional vectors
  - visualize
```
public static String visualize(List<SparseVector> vectors1,
                               List<SparseVector> vectors2)
```
    Visualizes two-dimensional vectors
  - visualize
```
public static String visualize(SparseVector[] vectors1,
                               SparseVector[] vectors2)
```
    Visualizes two-dimensional vectors
  - visualize
```
public static String visualize(List<SparseVector> vectors)
```
    Visualizes two-dimensional vectors
  - charLabel
```
public char charLabel()
```
    Returns a char label for the vector
  - kMeans
```
public static void kMeans(SparseVector[] dots,
                          SparseVector[] centers)
```
    Does a simple K-means
  - kMeans
```
public static void kMeans(SparseVector[] dots,
                          SparseVector[] centers,
                          SparseVector.Distance distanceFunction,
                          double epsilon,
                          int iterations)
```
    Does a simple K-means until the number of iterations is exceeded
  - eucledianDistance
```
public double eucledianDistance(SparseVector v)
```
    Returns the distance to another vector
  - index
```
public int index(int dimension)
```
    Returns the index for a dimension (or -1)
  - add
```
public SparseVector add(SparseVector v)
```
    Adds a vector to this one
  - multiply
```
public SparseVector multiply(double r)
```
    Multiplies this vector by a scalar
  - nonZeroIndices
```
public Iterator<Integer> nonZeroIndices()
```
    Gives an iterator over the non-zero indices
  - clone
```
public SparseVector clone()
```
    Clones a vector
    
    Overrides:
    
    clone in class Object
  - main
```
public static void main(String[] argv)
                 throws Exception
```
    Test method
    
    Throws:
    
    Exception

Class SparseVector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

label

val

dim

STANDARDDIM

BINARY

size

twonorm_sq

eucledianDistance

cosineDistance

Constructor Detail

SparseVector

SparseVector

SparseVector

SparseVector

SparseVector

SparseVector

SparseVector

Method Detail

updateBINARY

compress

toString

sprod

isBinary

size

squaredl2norm

l2norm

cosine

get

visualize

visualize

visualize

visualize

charLabel

kMeans

kMeans

eucledianDistance

index

add

multiply

nonZeroIndices

clone

main