Package org.apache.commons.text.similarity

Class IntersectionSimilarity<T>

java.lang.Object
org.apache.commons.text.similarity.IntersectionSimilarity<T>
Type Parameters:
T - the type of the elements extracted from the character sequence
All Implemented Interfaces:
SimilarityScore<IntersectionResult>
public class IntersectionSimilarity<T>
extends Object
implements SimilarityScore<IntersectionResult>
Measures the intersection of two sets created from a pair of character sequences.

It is assumed that the type T correctly conforms to the requirements for storage within a Set or HashMap. Ideally the type is immutable and implements Object.equals(Object) and Object.hashCode().

Since:
1.7
See Also:
Set, HashMap

  • Constructor Details

    • IntersectionSimilarity

      public IntersectionSimilarity​(Function<CharSequence,​Collection<T>> converter)
      Create a new intersection similarity using the provided converter.

      If the converter returns a Set then the intersection result will not include duplicates. Any other Collection is used to produce a result that will include duplicates in the intersect and union.

      Parameters:
      converter - the converter used to create the elements from the characters
      Throws:
      IllegalArgumentException - if the converter is null

  • Method Details