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

FeatureDistanceScore. More...

#include <FeatureDistanceScore.hpp>

+ Inheritance diagram for CDPL::Pharm::FeatureDistanceScore:

Public Types

typedef std::shared_ptr< FeatureDistanceScoreSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated FeatureDistanceScore instances. More...
 
typedef std::function< double(double)> DistanceScoringFunction
 
- Public Types inherited from CDPL::Pharm::FeatureInteractionScore
typedef std::shared_ptr< FeatureInteractionScoreSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated FeatureInteractionScore instances. More...
 

Public Member Functions

 FeatureDistanceScore (double min_dist, double max_dist)
 Constructs a FeatureDistanceScore functor with a minimum feature distance of min_dist and maximum distance of max_dist. More...
 
double getMinDistance () const
 
double getMaxDistance () const
 
void setDistanceScoringFunction (const DistanceScoringFunction &func)
 
double operator() (const Feature &ftr1, const Feature &ftr2) const
 
double operator() (const Math::Vector3D &ftr1_pos, const Feature &ftr2) const
 
- Public Member Functions inherited from CDPL::Pharm::FeatureInteractionScore
virtual ~FeatureInteractionScore ()
 Virtual destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CDPL::Pharm::FeatureInteractionScore
 FeatureInteractionScore ()
 

Detailed Description

FeatureDistanceScore.

Member Typedef Documentation

◆ SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated FeatureDistanceScore instances.

◆ DistanceScoringFunction

Constructor & Destructor Documentation

◆ FeatureDistanceScore()

CDPL::Pharm::FeatureDistanceScore::FeatureDistanceScore ( double  min_dist,
double  max_dist 
)

Constructs a FeatureDistanceScore 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::FeatureDistanceScore::getMinDistance ( ) const

◆ getMaxDistance()

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

◆ setDistanceScoringFunction()

void CDPL::Pharm::FeatureDistanceScore::setDistanceScoringFunction ( const DistanceScoringFunction func)

◆ operator()() [1/2]

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

◆ operator()() [2/2]

double CDPL::Pharm::FeatureDistanceScore::operator() ( const Math::Vector3D ftr1_pos,
const Feature ftr2 
) const
virtual

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