SparseIntegerVector (java-string-similarity 0.15 API)

java.lang.Object
- info.debatty.java.utils.SparseIntegerVector

All Implemented Interfaces:

Serializable
```
public class SparseIntegerVector
extends Object
implements Serializable
```
Sparse vector of int, implemented using two arrays.

Author:

Thibault Debatty

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SparseIntegerVector()` Sparse vector of int, implemented using two arrays.
`SparseIntegerVector(HashMap<Integer,Integer> hashmap)` Sparse vector of int, implemented using two arrays.
`SparseIntegerVector(int size)` Sparse vector of int, implemented using two arrays.
`SparseIntegerVector(int[] array)` Sparse vector of int, implemented using two arrays.

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`cosineSimilarity(SparseIntegerVector other)` Compute and return the cosine similarity (cosine of angle between both vectors).
`double`	`dotProduct(double[] other)` Compute and return the dot product.
`double`	`dotProduct(SparseIntegerVector other)` Compute and return the dot product.
`int`	`getKey(int i)` Get the key at position i.
`int`	`getValue(int i)` Get the value of position i.
`int`	`intersection(SparseIntegerVector other)` Compute the number of values that are present in both vectors (used to compute jaccard index).
`double`	`jaccard(SparseIntegerVector other)` Computes and return the Jaccard index with other SparseVector.
`double`	`norm()` Compute and return the L2 norm of the vector.
`double`	`qgram(SparseIntegerVector other)` Compute and return the qgram similarity with other vector.
`int`	`size()` Return the number of (non-zero) elements in this vector.
`String`	`toString()`
`int`	`union(SparseIntegerVector other)` Compute the size of the union of these two vectors.

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

- Constructor Detail
  - SparseIntegerVector
```
public SparseIntegerVector(int size)
```
    Sparse vector of int, implemented using two arrays.
    
    Parameters:
    size - number of non zero elements in the vector
  - SparseIntegerVector
```
public SparseIntegerVector()
```
    Sparse vector of int, implemented using two arrays. Default size is 20.
  - SparseIntegerVector
```
public SparseIntegerVector(HashMap<Integer,Integer> hashmap)
```
    Sparse vector of int, implemented using two arrays.
    
    Parameters:
    hashmap -
  - SparseIntegerVector
```
public SparseIntegerVector(int[] array)
```
    Sparse vector of int, implemented using two arrays.
    
    Parameters:
    array -
- Method Detail
  - cosineSimilarity
```
public final double cosineSimilarity(SparseIntegerVector other)
```
    Compute and return the cosine similarity (cosine of angle between both vectors).
    
    Parameters:
    other -
    
    Returns:
  - dotProduct
```
public final double dotProduct(SparseIntegerVector other)
```
    Compute and return the dot product.
    
    Parameters:
    other -
    
    Returns:
  - dotProduct
```
public final double dotProduct(double[] other)
```
    Compute and return the dot product.
    
    Parameters:
    other -
    
    Returns:
  - norm
```
public final double norm()
```
    Compute and return the L2 norm of the vector.
    
    Returns:
  - jaccard
```
public final double jaccard(SparseIntegerVector other)
```
    Computes and return the Jaccard index with other SparseVector. |A inter B| / |A union B| It is actually computed as |A inter B| / (|A| +|B| - | A inter B|) using a single loop over A and B
    
    Parameters:
    other -
    
    Returns:
  - union
```
public final int union(SparseIntegerVector other)
```
    Compute the size of the union of these two vectors.
    
    Parameters:
    other -
    
    Returns:
  - intersection
```
public final int intersection(SparseIntegerVector other)
```
    Compute the number of values that are present in both vectors (used to compute jaccard index).
    
    Parameters:
    other -
    
    Returns:
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - qgram
```
public final double qgram(SparseIntegerVector other)
```
    Compute and return the qgram similarity with other vector. Sum(|a_i - b_i|)
    
    Parameters:
    other -
    
    Returns:
  - size
```
public final int size()
```
    Return the number of (non-zero) elements in this vector.
    
    Returns:
  - getKey
```
public final int getKey(int i)
```
    Get the key at position i.
    
    Parameters:
    i -
    
    Returns:
  - getValue
```
public final int getValue(int i)
```
    Get the value of position i.
    
    Parameters:
    i -
    
    Returns:

Class SparseIntegerVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SparseIntegerVector

SparseIntegerVector

SparseIntegerVector

SparseIntegerVector

Method Detail

cosineSimilarity

dotProduct

dotProduct

norm

jaccard

union

intersection

toString

qgram

size

getKey

getValue