container for user parameters used to create a fragment catalog
More...
#include <FragCatParams.h>
container for user parameters used to create a fragment catalog
Definition at line 24 of file FragCatParams.h.
◆ FragCatParams() [1/4]
RDKit::FragCatParams::FragCatParams |
( |
| ) |
|
|
inline |
◆ FragCatParams() [2/4]
RDKit::FragCatParams::FragCatParams |
( |
unsigned int | lLen, |
|
|
unsigned int | uLen, |
|
|
const std::string & | fgroupFile, |
|
|
double | tol = 1e-08 ) |
construct from a function-group file
- Parameters
-
lLen | the lower limit on fragment size |
uLen | the upper limit on fragment size |
fgroupFile | the name of the function-group file |
tol | (optional) the eigenvalue tolerance to be used when comparing fragments |
◆ FragCatParams() [3/4]
RDKit::FragCatParams::FragCatParams |
( |
const FragCatParams & | other | ) |
|
◆ FragCatParams() [4/4]
RDKit::FragCatParams::FragCatParams |
( |
const std::string & | pickle | ) |
|
construct from a pickle string (serialized representation)
◆ ~FragCatParams()
RDKit::FragCatParams::~FragCatParams |
( |
| ) |
|
|
override |
◆ getFuncGroup()
const ROMol * RDKit::FragCatParams::getFuncGroup |
( |
unsigned int | fid | ) |
const |
returns a pointer to a specific functional group
◆ getFuncGroups()
const MOL_SPTR_VECT & RDKit::FragCatParams::getFuncGroups |
( |
| ) |
const |
returns our std::vector of functional groups
◆ getLowerFragLength()
unsigned int RDKit::FragCatParams::getLowerFragLength |
( |
| ) |
const |
|
inline |
◆ getNumFuncGroups()
unsigned int RDKit::FragCatParams::getNumFuncGroups |
( |
| ) |
const |
|
inline |
returns our number of functional groups
Definition at line 68 of file FragCatParams.h.
◆ getTolerance()
double RDKit::FragCatParams::getTolerance |
( |
| ) |
const |
|
inline |
returns our fragment-comparison tolerance
Definition at line 63 of file FragCatParams.h.
◆ getUpperFragLength()
unsigned int RDKit::FragCatParams::getUpperFragLength |
( |
| ) |
const |
|
inline |
◆ initFromStream()
void RDKit::FragCatParams::initFromStream |
( |
std::istream & | ss | ) |
|
|
overridevirtual |
◆ initFromString()
void RDKit::FragCatParams::initFromString |
( |
const std::string & | text | ) |
|
|
overridevirtual |
◆ Serialize()
std::string RDKit::FragCatParams::Serialize |
( |
| ) |
const |
|
overridevirtual |
◆ setLowerFragLength()
void RDKit::FragCatParams::setLowerFragLength |
( |
unsigned int | lFrLen | ) |
|
|
inline |
◆ setTolerance()
void RDKit::FragCatParams::setTolerance |
( |
double | val | ) |
|
|
inline |
sets our fragment-comparison tolerance
Definition at line 65 of file FragCatParams.h.
◆ setUpperFragLength()
void RDKit::FragCatParams::setUpperFragLength |
( |
unsigned int | uFrLen | ) |
|
|
inline |
◆ toStream()
void RDKit::FragCatParams::toStream |
( |
std::ostream & | | ) |
const |
|
overridevirtual |
The documentation for this class was generated from the following file: