CDPL.Pharm.FeatureDistanceConstraint Class Reference

FeatureDistanceConstraint. More...

Inheritance diagram for CDPL.Pharm.FeatureDistanceConstraint:

Public Member Functions
None	__init__ (FeatureDistanceConstraint constr)
	Initializes a copy of the FeatureDistanceConstraint instance constr. More...
None	__init__ (float min_dist, float max_dist)
	Constructs a FeatureDistanceConstraint functor with a minimum feature distance of min_dist and maximum distance of max_dist. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
float	getMinDistance ()
float	getMaxDistance ()
FeatureDistanceConstraint	assign (FeatureDistanceConstraint constr)
	Replaces the current state of self with a copy of the state of the FeatureDistanceConstraint instance constr. More...
bool	__call__ (Feature ftr1, Feature ftr2)

Properties
	objectID = property(getObjectID)
	minDistance = property(getMinDistance)
	maxDistance = property(getMaxDistance)

Detailed Description

FeatureDistanceConstraint.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Pharm.FeatureDistanceConstraint.__init__

(

FeatureDistanceConstraint

constr

)

Initializes a copy of the FeatureDistanceConstraint instance constr.

Parameters

constr

The FeatureDistanceConstraint instance to copy.

__init__() [2/2]

None CDPL.Pharm.FeatureDistanceConstraint.__init__	(	float	min_dist,
		float	max_dist
	)

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

Parameters

min_dist	The minimum feature pair distance.
max_dist	The maximum feature pair distance.

Reimplemented in CDPL.Pharm.HydrophobicInteractionConstraint, and CDPL.Pharm.IonicInteractionConstraint.

Member Function Documentation

getObjectID()

int CDPL.Pharm.FeatureDistanceConstraint.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python FeatureDistanceConstraint instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two FeatureDistanceConstraint instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

getMinDistance()

float CDPL.Pharm.FeatureDistanceConstraint.getMinDistance

(

)

Returns

getMaxDistance()

float CDPL.Pharm.FeatureDistanceConstraint.getMaxDistance

(

)

Returns

assign()

FeatureDistanceConstraint CDPL.Pharm.FeatureDistanceConstraint.assign

(

FeatureDistanceConstraint

constr

)

Replaces the current state of self with a copy of the state of the FeatureDistanceConstraint instance constr.

Parameters

constr

The FeatureDistanceConstraint instance to copy.

Returns

self

__call__()

bool CDPL.Pharm.FeatureDistanceConstraint.__call__	(	Feature	ftr1,
		Feature	ftr2
	)

Parameters

ftr1
ftr2

Returns