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

FeaturePositionMatchFunctor. More...

#include <FeaturePositionMatchFunctor.hpp>

Public Member Functions

 FeaturePositionMatchFunctor (bool query_mode)
 
bool queryMode () const
 
double operator() (const Feature &ftr1, const Feature &ftr2) const
 Checks if the distance between ftr1 and ftr2 is below the allowed maximum and calculates a score reflecting their proximity. More...
 
double operator() (const Feature &ftr1, const Feature &ftr2, const Math::Matrix4D &xform) const
 Checks if the distance between ftr1 and ftr2 is below the allowed maximum and calculates a score reflecting their proximity. More...
 

Detailed Description

FeaturePositionMatchFunctor.

Constructor & Destructor Documentation

◆ FeaturePositionMatchFunctor()

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

Member Function Documentation

◆ queryMode()

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

◆ operator()() [1/2]

double CDPL::Pharm::FeaturePositionMatchFunctor::operator() ( const Feature ftr1,
const Feature ftr2 
) const

Checks if the distance between ftr1 and ftr2 is below the allowed maximum and calculates a score reflecting their proximity.

If in 'query mode', the tolerance of ftr1 specifies the allowed maximum distance. Otherwise, the maximum tolerance of the features takes effect.

Parameters
ftr1The first feature.
ftr2The second feature.
Returns
A score from 0 (=outside effective tolerance) and 1 (exact position match) that specifies the proximity of the features.
See also
Pharm::getPosition(const Feature&), Pharm::getTolerance(const Feature&)

◆ operator()() [2/2]

double CDPL::Pharm::FeaturePositionMatchFunctor::operator() ( const Feature ftr1,
const Feature ftr2,
const Math::Matrix4D xform 
) const

Checks if the distance between ftr1 and ftr2 is below the allowed maximum and calculates a score reflecting their proximity.

If in 'query mode', the tolerance of ftr1 specifies the allowed maximum distance. Otherwise, the maximum tolerance of the features takes effect.

Parameters
ftr1The first feature.
ftr2The second feature.
xformThe transformation to apply to the position of the second feature.
Returns
A score from 0 (=outside effective tolerance) and 1 (exact position match) that specifies the proximity of the features.
See also
Pharm::getPosition(const Feature&), Pharm::getTolerance(const Feature&)

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