OEFPDatabaseOptions¶

class OEFPDatabaseOptions


This class is used to control the behavior of the OEFPDatabase.GetScores and the OEFPDatabase.GetSortedScores methods. It allows setting options on a per-search basis.

Constructors¶

OEFPDatabaseOptions()


Default constructor.

OEFPDatabaseOptions(unsigned int limit,
unsigned int simfunc=OESimMeasure::Tanimoto)


Constructs an OEFPDatabaseOptions object with a limit on the number of similarity scores returned and a similarity method from the OESimMeasure namespace. The returned scores will be in descending order and applying no cutoff value.

OEFPDatabaseOptions(const OEFPDatabaseOptions &rhs)


Copy constructors.

operator=¶

OEFPDatabaseOptions &operator=(const OEFPDatabaseOptions &rhs)


Assignment operator.

ClearCutoff¶

void ClearCutoff()


Removes the cutoff value previously set by the OEFPDatabaseOptions.SetCutoff method. After clearing the cutoff value, OEFPDatabaseOptions.HasCutoff method will return false.

GetCutoff¶

float GetCutoff() const


Returns the cutoff value previously set by the OEFPDatabase.SetCutoff method.

GetDescendingOrder¶

bool GetDescendingOrder() const


Returns whether the similarity scores will be returned in descending or in ascending order by the OEFPDatabase.GetSortedScores method.

GetLimit¶

unsigned int GetLimit() const


Returns the limit on the number of similarity scores returned by the OEFPDatabase.GetSortedScores method.

GetSimFunc¶

unsigned int GetSimFunc() const


Returns the method used to evaluate fingerprint similarity when calling either the OEFPDatabase.GetScores or the OEFPDatabase.GetSortedScores methods. The return value is taken from the OESimMeasure namespace.

GetTverskyAlpha¶

float GetTverskyAlpha() const


Returns the $$\alpha$$ parameter of the Tversky similarity.

GetTverskyBeta¶

float GetTverskyBeta() const


Returns the $$\beta$$ parameter of the Tversky similarity.

HasCutoff¶

bool HasCutoff() const


Returns whether the cutoff value of the OEFPDatabaseOptions object has been set by the OEFPDatabaseOptions.SetCutoff method.

SetCutoff¶

void SetCutoff(float cutoff)


Sets the cutoff value of the OEFPDatabaseOptions object. The cutoff value influences the behavior of both the OEFPDatabase.GetScores and the OEFPDatabase.GetSortedScores methods.

SetDescendingOrder¶

void SetDescendingOrder(bool descending=true)


Sets whether the similarity scores will be returned in descending or in ascending order by the OEFPDatabase.GetSortedScores method.

Note

This method has no effect on the OEFPDatabase.GetScores method.

SetLimit¶

void SetLimit(unsigned int limit)


Set the limit on the number of similarity scores returned by the GetSortedScores method.

limit
If it is set to zero, then all of the similarity scores are returned.

Note

This method has no effect on the OEFPDatabase.GetScores method.

SetSimFunc¶

void SetSimFunc(unsigned int simtype)


Sets the method that is used to evaluate fingerprint similarity when calling either the OEFPDatabase.GetScores or the OEFPDatabase.GetSortedScores methods.

simtype
This value has to be from the OESimMeasure namespace.

void SetTverskyCoeffs(float alpha=0.95f, float beta=0.05f)

Sets $$\alpha$$ and $$\beta$$ parameters for the Tversky similarity.