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

Constraint functor that tests whether an aromatic feature pair satisfies the geometric criteria for an orthogonal (T-shaped) π-π interaction (horizontal/vertical center separations plus ring-normal angle). More...

#include <OrthogonalPiPiInteractionConstraint.hpp>

Public Member Functions

 OrthogonalPiPiInteractionConstraint (double min_h_dist=DEF_MIN_H_DISTANCE, double max_h_dist=DEF_MAX_H_DISTANCE, double max_v_dist=DEF_MAX_V_DISTANCE, double max_ang=DEF_MAX_ANGLE)
 Constructs a OrthogonalPiPiInteractionConstraint functor with the specified constraints. More...
 
double getMinHDistance () const
 Returns the currently configured minimum horizontal ring-center separation. More...
 
double getMaxHDistance () const
 Returns the currently configured maximum horizontal ring-center separation. More...
 
double getMaxVDistance () const
 Returns the currently configured maximum vertical ring-center separation. More...
 
double getMaxAngle () const
 Returns the currently configured maximum deviation from a 90° angle between the two ring-plane normals. More...
 
bool operator() (const Feature &ftr1, const Feature &ftr2) const
 Tests whether ftr1 and ftr2 satisfy the geometric orthogonal π-π criteria. More...
 

Static Public Attributes

static constexpr double DEF_MAX_V_DISTANCE = 1.4
 Default maximum vertical (out-of-plane) ring-center separation in Ångstrom. More...
 
static constexpr double DEF_MIN_H_DISTANCE = 4.0
 Default minimum horizontal (in-plane) ring-center separation in Ångstrom. More...
 
static constexpr double DEF_MAX_H_DISTANCE = 6.0
 Default maximum horizontal (in-plane) ring-center separation in Ångstrom. More...
 
static constexpr double DEF_MAX_ANGLE = 30.0
 Default maximum angle deviation from 90° of the two ring-plane normals in degrees. More...
 

Detailed Description

Constraint functor that tests whether an aromatic feature pair satisfies the geometric criteria for an orthogonal (T-shaped) π-π interaction (horizontal/vertical center separations plus ring-normal angle).

Constructor & Destructor Documentation

◆ OrthogonalPiPiInteractionConstraint()

CDPL::Pharm::OrthogonalPiPiInteractionConstraint::OrthogonalPiPiInteractionConstraint ( double  min_h_dist = DEF_MIN_H_DISTANCE,
double  max_h_dist = DEF_MAX_H_DISTANCE,
double  max_v_dist = DEF_MAX_V_DISTANCE,
double  max_ang = DEF_MAX_ANGLE 
)
inline

Constructs a OrthogonalPiPiInteractionConstraint functor with the specified constraints.

Parameters
min_h_distThe minimum allowed aromatic ring center distance in the plane of the vertically oriented ring.
max_h_distThe maximum allowed aromatic ring center distance in the plane of the vertically oriented ring.
max_v_distThe maximum allowed distance distance of the center of the horizontally oriented aromatic ring to the plane of the vertically oriented ring.
max_angThe maximum allowed angle deviation from 90° of the two ring-plane orientation vectors.

Member Function Documentation

◆ getMinHDistance()

double CDPL::Pharm::OrthogonalPiPiInteractionConstraint::getMinHDistance ( ) const

Returns the currently configured minimum horizontal ring-center separation.

Returns
The minimum horizontal distance.

◆ getMaxHDistance()

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

Returns the currently configured maximum horizontal ring-center separation.

Returns
The maximum horizontal distance.

◆ getMaxVDistance()

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

Returns the currently configured maximum vertical ring-center separation.

Returns
The maximum vertical distance.

◆ getMaxAngle()

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

Returns the currently configured maximum deviation from a 90° angle between the two ring-plane normals.

Returns
The maximum angle deviation in degrees.

◆ operator()()

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

Tests whether ftr1 and ftr2 satisfy the geometric orthogonal π-π criteria.

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

Member Data Documentation

◆ DEF_MAX_V_DISTANCE

constexpr double CDPL::Pharm::OrthogonalPiPiInteractionConstraint::DEF_MAX_V_DISTANCE = 1.4
staticconstexpr

Default maximum vertical (out-of-plane) ring-center separation in Ångstrom.

◆ DEF_MIN_H_DISTANCE

constexpr double CDPL::Pharm::OrthogonalPiPiInteractionConstraint::DEF_MIN_H_DISTANCE = 4.0
staticconstexpr

Default minimum horizontal (in-plane) ring-center separation in Ångstrom.

◆ DEF_MAX_H_DISTANCE

constexpr double CDPL::Pharm::OrthogonalPiPiInteractionConstraint::DEF_MAX_H_DISTANCE = 6.0
staticconstexpr

Default maximum horizontal (in-plane) ring-center separation in Ångstrom.

◆ DEF_MAX_ANGLE

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

Default maximum angle deviation from 90° of the two ring-plane normals in degrees.


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