com.fnklabs.draenei.analytics.search.SimilarityAlgorithm Maven / Gradle / Ivy

Go to download

package com.fnklabs.draenei.analytics.search;


import org.jetbrains.annotations.NotNull;

import java.util.Collection;

/**
 * Interface for implementing similarity algorithm
 */
interface SimilarityAlgorithm {
    /**
     * Get similarity among two specified clusters
     * 
     * Higher value means higher similarity.
     *
     * @param firstFacet  First cluster
     * @param secondFacet Second cluster
     *
     * @return Similarity index
     */
     double getSimilarity(@NotNull Collection firstFacet, @NotNull Collection secondFacet);


}