Chemical Data Processing Library C++ API - Version 1.1.1
Public Member Functions | List of all members
CDPL::Pharm::FeaturePairDistanceMatchFunctor Class Reference

FeaturePairDistanceMatchFunctor. More...

#include <FeaturePairDistanceMatchFunctor.hpp>

Public Member Functions

 FeaturePairDistanceMatchFunctor (bool query_mode)
 Constructs the FeaturePairDistanceMatchFunctor instance. More...
 
bool queryMode () const
 
bool operator() (const Feature &p1_ftr1, const Feature &p1_ftr2, const Feature &p2_ftr1, const Feature &p2_ftr2) const
 Checks if the feature pairs (p1_ftr1, p1_ftr2) and (p2_ftr1, p2_ftr2) are matching in terms of their feature distance. More...
 

Detailed Description

FeaturePairDistanceMatchFunctor.

Constructor & Destructor Documentation

◆ FeaturePairDistanceMatchFunctor()

CDPL::Pharm::FeaturePairDistanceMatchFunctor::FeaturePairDistanceMatchFunctor ( bool  query_mode)
inline

Constructs the FeaturePairDistanceMatchFunctor instance.

Parameters
query_modeIf true, the second pair feature distance must fall in the distance +/- tolerances of the first pair for the compatibility check to succeed. If false, it is sufficient that any one of the pairs matches the distance range of the other.

Member Function Documentation

◆ queryMode()

bool CDPL::Pharm::FeaturePairDistanceMatchFunctor::queryMode ( ) const

◆ operator()()

bool CDPL::Pharm::FeaturePairDistanceMatchFunctor::operator() ( const Feature p1_ftr1,
const Feature p1_ftr2,
const Feature p2_ftr1,
const Feature p2_ftr2 
) const

Checks if the feature pairs (p1_ftr1, p1_ftr2) and (p2_ftr1, p2_ftr2) are matching in terms of their feature distance.

Parameters
p1_ftr1The first feature of the first pair.
p1_ftr2The second feature of the first pair.
p2_ftr1The first feature of the second pair.
p2_ftr2The second feature of the second pair.
Returns
true if the feature pair distance are compatible, and false otherwise.
See also
FeaturePairDistanceMatchFunctor()

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