RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::SubstructMatchParameters Struct Reference

#include <SubstructMatch.h>

Public Member Functions

 SubstructMatchParameters ()
 

Public Attributes

bool useChirality = false
 
bool useEnhancedStereo = false
 
bool aromaticMatchesConjugated = false
 
bool useQueryQueryMatches = false
 
bool useGenericMatchers = false
 
bool recursionPossible = true
 Allow recursive queries.
 
bool uniquify = true
 uniquify (by atom index) match results
 
unsigned int maxMatches = 1000
 maximum number of matches to return
 
int numThreads = 1
 
std::vector< std::string > atomProperties
 
std::vector< std::string > bondProperties
 
std::function< bool(const ROMol &mol, const std::vector< unsigned int > &match) extraFinalCheck )
 
unsigned int maxRecursiveMatches
 

Detailed Description

Definition at line 41 of file SubstructMatch.h.

Constructor & Destructor Documentation

◆ SubstructMatchParameters()

RDKit::SubstructMatchParameters::SubstructMatchParameters ( )
inline

Definition at line 71 of file SubstructMatch.h.

Member Data Documentation

◆ aromaticMatchesConjugated

bool RDKit::SubstructMatchParameters::aromaticMatchesConjugated = false

Aromatic and conjugated bonds match each other

Definition at line 46 of file SubstructMatch.h.

◆ atomProperties

std::vector<std::string> RDKit::SubstructMatchParameters::atomProperties

atom properties that must be equivalent in order to match

Definition at line 60 of file SubstructMatch.h.

◆ bondProperties

std::vector<std::string> RDKit::SubstructMatchParameters::bondProperties

bond properties that must be equivalent in order to match

Definition at line 62 of file SubstructMatch.h.

◆ extraFinalCheck

std::function<bool(const ROMol &mol, const std::vector<unsigned int> &match) RDKit::SubstructMatchParameters::extraFinalCheck)

a function to be called at the end to validate a match

Definition at line 66 of file SubstructMatch.h.

◆ maxMatches

unsigned int RDKit::SubstructMatchParameters::maxMatches = 1000

◆ maxRecursiveMatches

unsigned int RDKit::SubstructMatchParameters::maxRecursiveMatches
Initial value:
=
1000

maximum number of matches that the recursive substructure matching should return

Definition at line 68 of file SubstructMatch.h.

◆ numThreads

int RDKit::SubstructMatchParameters::numThreads = 1

number of threads to use when multi-threading is possible. 0 selects the number of concurrent threads supported by the hardware negative values are added to the number of concurrent threads supported by the hardware

Definition at line 55 of file SubstructMatch.h.

Referenced by RDKit::SubstructMatch(), and RDKit::SubstructMatch().

◆ recursionPossible

◆ uniquify

bool RDKit::SubstructMatchParameters::uniquify = true

uniquify (by atom index) match results

Definition at line 53 of file SubstructMatch.h.

Referenced by RDKit::SubstructMatch(), and RDKit::SubstructMatch().

◆ useChirality

◆ useEnhancedStereo

bool RDKit::SubstructMatchParameters::useEnhancedStereo = false

Use enhanced stereochemistry in determining whether atoms/bonds match

Definition at line 44 of file SubstructMatch.h.

◆ useGenericMatchers

bool RDKit::SubstructMatchParameters::useGenericMatchers = false

Looks for generic atoms in the query and uses them as part of the matching

Definition at line 50 of file SubstructMatch.h.

◆ useQueryQueryMatches


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