Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Properties | List of all members
CDPL.Util.BronKerboschAlgorithm Class Reference

Implementation of the Bron-Kerbosch clique-detection algorithm [BKA]. More...

+ Inheritance diagram for CDPL.Util.BronKerboschAlgorithm:

Public Member Functions

None __init__ ()
 Initializes the BronKerboschAlgorithm instance.
 
None __init__ (BronKerboschAlgorithm bka)
 Initializes a copy of the BronKerboschAlgorithm instance bka. More...
 
None __init__ (BitSetArray adj_mtx)
 Initializes the BronKerboschAlgorithm instance. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None init (BitSetArray adj_mtx)
 
bool nextClique (BitSet clique)
 
BronKerboschAlgorithm assign (BronKerboschAlgorithm bka)
 Replaces the current state of self with a copy of the state of the BronKerboschAlgorithm instance bka. More...
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

Implementation of the Bron-Kerbosch clique-detection algorithm [BKA].

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Util.BronKerboschAlgorithm.__init__ ( BronKerboschAlgorithm  bka)

Initializes a copy of the BronKerboschAlgorithm instance bka.

Parameters
bkaThe BronKerboschAlgorithm instance to copy.

◆ __init__() [2/2]

None CDPL.Util.BronKerboschAlgorithm.__init__ ( BitSetArray  adj_mtx)

Initializes the BronKerboschAlgorithm instance.

Parameters
adj_mtx

Member Function Documentation

◆ getObjectID()

int CDPL.Util.BronKerboschAlgorithm.getObjectID ( )

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

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

◆ init()

None CDPL.Util.BronKerboschAlgorithm.init ( BitSetArray  adj_mtx)
Parameters
adj_mtx

◆ nextClique()

bool CDPL.Util.BronKerboschAlgorithm.nextClique ( BitSet  clique)
Parameters
clique
Returns

◆ assign()

BronKerboschAlgorithm CDPL.Util.BronKerboschAlgorithm.assign ( BronKerboschAlgorithm  bka)

Replaces the current state of self with a copy of the state of the BronKerboschAlgorithm instance bka.

Parameters
bkaThe BronKerboschAlgorithm instance to copy.
Returns
self