RDKit
Open-source cheminformatics and machine learning.
RDKit::CachedSmilesMolHolder Class Reference

Concrete class that holds smiles strings in memory. More...

#include <SubstructLibrary.h>

Inheritance diagram for RDKit::CachedSmilesMolHolder:
RDKit::MolHolderBase

Public Member Functions

 CachedSmilesMolHolder ()
 
virtual unsigned int addMol (const ROMol &m)
 
unsigned int addSmiles (const std::string &smiles)
 
virtual boost::shared_ptr< ROMolgetMol (unsigned int idx) const
 
virtual unsigned int size () const
 Get the current library size. More...
 
std::vector< std::string > & getMols ()
 
const std::vector< std::string > & getMols () const
 
- Public Member Functions inherited from RDKit::MolHolderBase
virtual ~MolHolderBase ()
 

Detailed Description

Concrete class that holds smiles strings in memory.

This implementation uses quite a bit less memory than the cached binary or uncached implementation. However, due to the reduced speed it should be used in conjunction with a pattern fingerprinter.

See RDKit::FPHolder

Definition at line 147 of file SubstructLibrary.h.

Constructor & Destructor Documentation

◆ CachedSmilesMolHolder()

RDKit::CachedSmilesMolHolder::CachedSmilesMolHolder ( )
inline

Definition at line 152 of file SubstructLibrary.h.

Member Function Documentation

◆ addMol()

virtual unsigned int RDKit::CachedSmilesMolHolder::addMol ( const ROMol m)
inlinevirtual

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

Implements RDKit::MolHolderBase.

Definition at line 154 of file SubstructLibrary.h.

References RDKit::MolToSmiles().

◆ addSmiles()

unsigned int RDKit::CachedSmilesMolHolder::addSmiles ( const std::string &  smiles)
inline

Add a smiles to the dataset, no validation is done to the inputs.

Definition at line 162 of file SubstructLibrary.h.

◆ getMol()

virtual boost::shared_ptr<ROMol> RDKit::CachedSmilesMolHolder::getMol ( unsigned int  idx) const
inlinevirtual

Implements RDKit::MolHolderBase.

Definition at line 167 of file SubstructLibrary.h.

References RDKit::SmilesToMol().

◆ getMols() [1/2]

std::vector<std::string>& RDKit::CachedSmilesMolHolder::getMols ( )
inline

Definition at line 178 of file SubstructLibrary.h.

◆ getMols() [2/2]

const std::vector<std::string>& RDKit::CachedSmilesMolHolder::getMols ( ) const
inline

Definition at line 179 of file SubstructLibrary.h.

◆ size()

virtual unsigned int RDKit::CachedSmilesMolHolder::size ( ) const
inlinevirtual

Get the current library size.

Implements RDKit::MolHolderBase.

Definition at line 174 of file SubstructLibrary.h.


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