ppt4j 1.0
 
Loading...
Searching...
No Matches
ppt4j.feature.FeatureMatcher Interface Reference

Public Member Functions

String getAlgorithm ()
 
double match (Features f1, Features f2)
 
default boolean isMatch (Features f1, Features f2, double threshold)
 

Static Public Member Functions

static FeatureMatcher get (String algorithm)
 
static FeatureMatcher get ()
 

Member Function Documentation

◆ get() [1/2]

static FeatureMatcher ppt4j.feature.FeatureMatcher.get ( )
static

This method returns a FeatureMatcher object with the default similarity measure set to "jaccard".

Returns
a FeatureMatcher object with the default similarity measure set to "jaccard"

◆ get() [2/2]

static FeatureMatcher ppt4j.feature.FeatureMatcher.get ( String algorithm)
static

Returns a FeatureMatcher based on the input algorithm.

Parameters
algorithmthe algorithm to determine which FeatureMatcher to return
Returns
a FeatureMatcher based on the specified algorithm
Exceptions
IllegalArgumentExceptionif the algorithm is unknown

◆ getAlgorithm()

String ppt4j.feature.FeatureMatcher.getAlgorithm ( )

Returns the algorithm used by the object.

Returns
the algorithm used by the object

◆ isMatch()

default boolean ppt4j.feature.FeatureMatcher.isMatch ( Features f1,
Features f2,
double threshold )

Checks if the similarity score between two Features objects is greater than or equal to a specified threshold.

Parameters
f1the first Features object to compare
f2the second Features object to compare
thresholdthe threshold value for the match to be considered successful
Returns
true if the similarity score is greater than or equal to the threshold, false otherwise

◆ match()

double ppt4j.feature.FeatureMatcher.match ( Features f1,
Features f2 )

Calculates the similarity between two feature sets.

Parameters
f1the first set of features
f2the second set of features
Returns
a double value representing the similarity between f1 and f2

The documentation for this interface was generated from the following file: