Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | List of all members
CDPL.ForceField.TopologicalAtomDistanceFunction Class Reference

Generic wrapper class used to store a user-defined topological atom pair distance function. More...

+ Inheritance diagram for CDPL.ForceField.TopologicalAtomDistanceFunction:

Public Member Functions

None __init__ ()
 Contructs the TopologicalAtomDistanceFunction instance.
 
None __init__ (TopologicalAtomDistanceFunction func)
 Contructs a copy of the TopologicalAtomDistanceFunction instance func. More...
 
None __init__ (object callable)
 Contructs the TopologicalAtomDistanceFunction instance for the specified callable object. More...
 
int __call__ (Chem.Atom arg1, Chem.Atom arg2, Chem.MolecularGraph arg3)
 Invokes the wrapped callable object with the given arguments. More...
 
bool __bool__ ()
 Tells whether the instance holds a callable object. More...
 
bool __nonzero__ ()
 Tells whether the instance holds a callable object. More...
 

Detailed Description

Generic wrapper class used to store a user-defined topological atom pair distance function.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.ForceField.TopologicalAtomDistanceFunction.__init__ ( TopologicalAtomDistanceFunction  func)

Contructs a copy of the TopologicalAtomDistanceFunction instance func.

Parameters
funcThe TopologicalAtomDistanceFunction instance to copy.

◆ __init__() [2/2]

None CDPL.ForceField.TopologicalAtomDistanceFunction.__init__ ( object  callable)

Contructs the TopologicalAtomDistanceFunction instance for the specified callable object.

Parameters
callableThe callable object to wrap.

Member Function Documentation

◆ __call__()

int CDPL.ForceField.TopologicalAtomDistanceFunction.__call__ ( Chem.Atom  arg1,
Chem.Atom  arg2,
Chem.MolecularGraph  arg3 
)

Invokes the wrapped callable object with the given arguments.

Parameters
arg1The first argument to forward.
arg2The second argument to forward.
arg3The third argument to forward.
Returns
The obtained return value.

◆ __bool__()

bool CDPL.ForceField.TopologicalAtomDistanceFunction.__bool__ ( )

Tells whether the instance holds a callable object.

Returns
True if the instance holds a callable object, and False otherwise.

◆ __nonzero__()

bool CDPL.ForceField.TopologicalAtomDistanceFunction.__nonzero__ ( )

Tells whether the instance holds a callable object.

Returns
True if the instance holds a callable object, and False otherwise.