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

Constraint functor that accepts a pair of features whose 3D-position distance lies within a configured [min, max] interval. More...

#include <FeatureDistanceConstraint.hpp>

+ Inheritance diagram for CDPL::Pharm::FeatureDistanceConstraint:

Public Member Functions

 FeatureDistanceConstraint (double min_dist, double max_dist)
 Constructs a FeatureDistanceConstraint functor with a minimum feature distance of min_dist and maximum distance of max_dist. More...
 
double getMinDistance () const
 Returns the currently configured minimum feature pair distance. More...
 
double getMaxDistance () const
 Returns the currently configured maximum feature pair distance. More...
 
bool operator() (const Feature &ftr1, const Feature &ftr2) const
 Tests whether the 3D-position distance between ftr1 and ftr2 lies within the configured [min, max] interval. More...
 

Detailed Description

Constraint functor that accepts a pair of features whose 3D-position distance lies within a configured [min, max] interval.

Constructor & Destructor Documentation

◆ FeatureDistanceConstraint()

CDPL::Pharm::FeatureDistanceConstraint::FeatureDistanceConstraint ( double  min_dist,
double  max_dist 
)
inline

Constructs a FeatureDistanceConstraint functor with a minimum feature distance of min_dist and maximum distance of max_dist.

Parameters
min_distThe minimum feature pair distance.
max_distThe maximum feature pair distance.

Member Function Documentation

◆ getMinDistance()

double CDPL::Pharm::FeatureDistanceConstraint::getMinDistance ( ) const

Returns the currently configured minimum feature pair distance.

Returns
The minimum distance.

◆ getMaxDistance()

double CDPL::Pharm::FeatureDistanceConstraint::getMaxDistance ( ) const

Returns the currently configured maximum feature pair distance.

Returns
The maximum distance.

◆ operator()()

bool CDPL::Pharm::FeatureDistanceConstraint::operator() ( const Feature ftr1,
const Feature ftr2 
) const

Tests whether the 3D-position distance between ftr1 and ftr2 lies within the configured [min, max] interval.

Parameters
ftr1The first feature.
ftr2The second feature.
Returns
true if the constraint is satisfied, and false otherwise.

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