Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Shape.AlignedTotalOverlapTverskyScore Class Reference
+ Inheritance diagram for CDPL.Shape.AlignedTotalOverlapTverskyScore:

Public Member Functions

None __init__ (float beta=0.95)
 Initializes the AlignedTotalOverlapTverskyScore instance. More...
 
None __init__ (AlignedTotalOverlapTverskyScore score)
 Initializes a copy of the AlignedTotalOverlapTverskyScore instance score. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
AlignedTotalOverlapTverskyScore assign (AlignedTotalOverlapTverskyScore score)
 Replaces the current state of self with a copy of the state of the AlignedTotalOverlapTverskyScore instance score. More...
 
float __call__ (AlignmentResult res)
 

Properties

 objectID = property(getObjectID)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Shape.AlignedTotalOverlapTverskyScore.__init__ ( float   beta = 0.95)

Initializes the AlignedTotalOverlapTverskyScore instance.

Parameters
beta

◆ __init__() [2/2]

None CDPL.Shape.AlignedTotalOverlapTverskyScore.__init__ ( AlignedTotalOverlapTverskyScore  score)

Initializes a copy of the AlignedTotalOverlapTverskyScore instance score.

Parameters
scoreThe AlignedTotalOverlapTverskyScore instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Shape.AlignedTotalOverlapTverskyScore.getObjectID ( )

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

Different Python AlignedTotalOverlapTverskyScore 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 AlignedTotalOverlapTverskyScore 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.

◆ assign()

AlignedTotalOverlapTverskyScore CDPL.Shape.AlignedTotalOverlapTverskyScore.assign ( AlignedTotalOverlapTverskyScore  score)

Replaces the current state of self with a copy of the state of the AlignedTotalOverlapTverskyScore instance score.

Parameters
scoreThe AlignedTotalOverlapTverskyScore instance to copy.
Returns
self

◆ __call__()

float CDPL.Shape.AlignedTotalOverlapTverskyScore.__call__ ( AlignmentResult  res)
Parameters
res
Returns