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

ParallelPiPiInteractionConstraint. More...

#include <ParallelPiPiInteractionConstraint.hpp>

Public Member Functions

 ParallelPiPiInteractionConstraint (double min_v_dist=DEF_MIN_V_DISTANCE, double max_v_dist=DEF_MAX_V_DISTANCE, double max_h_dist=DEF_MAX_H_DISTANCE, double max_ang=DEF_MAX_ANGLE)
 Constructs a ParallelPiPiInteractionConstraint functor with the specified constraints. More...
 
double getMinVDistance () const
 
double getMaxVDistance () const
 
double getMaxHDistance () const
 
double getMaxAngle () const
 
bool operator() (const Feature &ftr1, const Feature &ftr2) const
 

Static Public Attributes

static constexpr double DEF_MAX_H_DISTANCE = 2.8
 
static constexpr double DEF_MIN_V_DISTANCE = 3.0
 
static constexpr double DEF_MAX_V_DISTANCE = 5.5
 
static constexpr double DEF_MAX_ANGLE = 30.0
 

Detailed Description

ParallelPiPiInteractionConstraint.

Constructor & Destructor Documentation

◆ ParallelPiPiInteractionConstraint()

CDPL::Pharm::ParallelPiPiInteractionConstraint::ParallelPiPiInteractionConstraint ( double  min_v_dist = DEF_MIN_V_DISTANCE,
double  max_v_dist = DEF_MAX_V_DISTANCE,
double  max_h_dist = DEF_MAX_H_DISTANCE,
double  max_ang = DEF_MAX_ANGLE 
)
inline

Constructs a ParallelPiPiInteractionConstraint functor with the specified constraints.

Parameters
min_v_distThe minimum allowed distance of the two feature-positions orthogonal to the ring-planes.
max_v_distThe maximum allowed distance of the two feature-positions orthogonal to the ring-planes.
max_h_distThe maximum allowed distance of the feature-position along the their ring-planes.
max_angThe maximum allowed angle deviation from 0° of the two ring-plane orientation vectors.

Member Function Documentation

◆ getMinVDistance()

double CDPL::Pharm::ParallelPiPiInteractionConstraint::getMinVDistance ( ) const

◆ getMaxVDistance()

double CDPL::Pharm::ParallelPiPiInteractionConstraint::getMaxVDistance ( ) const

◆ getMaxHDistance()

double CDPL::Pharm::ParallelPiPiInteractionConstraint::getMaxHDistance ( ) const

◆ getMaxAngle()

double CDPL::Pharm::ParallelPiPiInteractionConstraint::getMaxAngle ( ) const

◆ operator()()

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

Member Data Documentation

◆ DEF_MAX_H_DISTANCE

constexpr double CDPL::Pharm::ParallelPiPiInteractionConstraint::DEF_MAX_H_DISTANCE = 2.8
staticconstexpr

◆ DEF_MIN_V_DISTANCE

constexpr double CDPL::Pharm::ParallelPiPiInteractionConstraint::DEF_MIN_V_DISTANCE = 3.0
staticconstexpr

◆ DEF_MAX_V_DISTANCE

constexpr double CDPL::Pharm::ParallelPiPiInteractionConstraint::DEF_MAX_V_DISTANCE = 5.5
staticconstexpr

◆ DEF_MAX_ANGLE

constexpr double CDPL::Pharm::ParallelPiPiInteractionConstraint::DEF_MAX_ANGLE = 30.0
staticconstexpr

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