RDKit
Open-source cheminformatics and machine learning.
RDKit::MolHolderBase Class Referenceabstract

Base class API for holding molecules so substructure search. More...

#include <SubstructLibrary.h>

Inheritance diagram for RDKit::MolHolderBase:
RDKit::CachedMolHolder RDKit::CachedSmilesMolHolder RDKit::CachedTrustedSmilesMolHolder RDKit::MolHolder

Public Member Functions

virtual ~MolHolderBase ()
 
virtual unsigned int addMol (const ROMol &m)=0
 
virtual boost::shared_ptr< ROMolgetMol (unsigned int) const =0
 
virtual unsigned int size () const =0
 Get the current library size. More...
 

Detailed Description

Base class API for holding molecules so substructure search.

This is an API that hides the implementation details used for indexing molecules for substructure searching. It simply provides an API for adding and getting molecules from a set.

Definition at line 50 of file SubstructLibrary.h.

Constructor & Destructor Documentation

virtual RDKit::MolHolderBase::~MolHolderBase ( )
inlinevirtual

Definition at line 52 of file SubstructLibrary.h.

References addMol(), getMol(), and size().

Member Function Documentation

virtual unsigned int RDKit::MolHolderBase::addMol ( const ROMol m)
pure virtual

Add a new molecule to the substructure search library Returns the molecules index in the library

Implemented in RDKit::CachedTrustedSmilesMolHolder, RDKit::CachedSmilesMolHolder, RDKit::CachedMolHolder, and RDKit::MolHolder.

Referenced by RDKit::SubstructLibrary::getFingerprints(), and ~MolHolderBase().

virtual boost::shared_ptr<ROMol> RDKit::MolHolderBase::getMol ( unsigned  int) const
pure virtual

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