CorrelationConstrained (CF4J 2.3.0 API Documentation)

java.lang.Object
- es.upm.etsisi.cf4j.recommender.knn.itemSimilarityMetric.ItemSimilarityMetric
- - es.upm.etsisi.cf4j.recommender.knn.itemSimilarityMetric.CorrelationConstrained

All Implemented Interfaces:

Partible<Item>
```
public class CorrelationConstrained
extends ItemSimilarityMetric
```
This class implements the Constrained Correlation as CF similarity metric for items.

Field Summary
- Fields inherited from class es.upm.etsisi.cf4j.recommender.knn.itemSimilarityMetric.ItemSimilarityMetric
  datamodel, similarities

Constructor Summary

Constructors
Constructor Description

CorrelationConstrained(double median)
Constructor of the similarity metric

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`similarity(Item item, Item otherItem)`	This method must returns the similarity between two items.
`String`	`toString()`

Methods inherited from class es.upm.etsisi.cf4j.recommender.knn.itemSimilarityMetric.ItemSimilarityMetric
afterRun, beforeRun, getSimilarities, run, setDatamodel

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

- Constructor Detail
  - CorrelationConstrained
```
public CorrelationConstrained(double median)
```
    Constructor of the similarity metric
    
    Parameters:
    
    median - Median of the ratings of the DataSet instance
- Method Detail
  - similarity
```
public double similarity(Item item,
                         Item otherItem)
```
    Description copied from class: ItemSimilarityMetric
    
    This method must returns the similarity between two items.
    If two items do not have a similarity value, the method must return Double.NEGATIVE_INFINITY.
    The value returned by this method should be higher the greater the similarity between items.
    
    Specified by:
    
    similarity in class ItemSimilarityMetric
    
    Parameters:
    
    item - An item
    
    otherItem - Other item
    
    Returns:
    
    Similarity between item and otherItem
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ItemSimilarityMetric