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

#include <FilterMatchers.h>

Inheritance diagram for RDKit::FilterMatchOps::Or:
RDKit::FilterMatcherBase

Public Member Functions

 Or ()
 
 Or (const FilterMatcherBase &arg1, const FilterMatcherBase &arg2)
 
 Or (boost::shared_ptr< FilterMatcherBase > arg1, boost::shared_ptr< FilterMatcherBase > arg2)
 
 Or (const Or &rhs)
 
std::string getName () const override
 
bool isValid () const override
 
bool hasMatch (const ROMol &mol) const override
 hasMatches More...
 
bool getMatches (const ROMol &mol, std::vector< FilterMatch > &matchVect) const override
 getMatches More...
 
boost::shared_ptr< FilterMatcherBasecopy () const override
 
- Public Member Functions inherited from RDKit::FilterMatcherBase
 FilterMatcherBase (std::string name=DEFAULT_FILTERMATCHERBASE_NAME)
 
 FilterMatcherBase (const FilterMatcherBase &rhs)
 
virtual ~FilterMatcherBase ()
 
virtual boost::shared_ptr< FilterMatcherBaseClone () const
 

Detailed Description

Definition at line 120 of file FilterMatchers.h.

Constructor & Destructor Documentation

◆ Or() [1/4]

RDKit::FilterMatchOps::Or::Or ( )
inline

Definition at line 126 of file FilterMatchers.h.

◆ Or() [2/4]

RDKit::FilterMatchOps::Or::Or ( const FilterMatcherBase arg1,
const FilterMatcherBase arg2 
)
inline

Constructs or Ander true if arg1 or arg2 are true

Definition at line 130 of file FilterMatchers.h.

◆ Or() [3/4]

RDKit::FilterMatchOps::Or::Or ( boost::shared_ptr< FilterMatcherBase arg1,
boost::shared_ptr< FilterMatcherBase arg2 
)
inline

Definition at line 133 of file FilterMatchers.h.

◆ Or() [4/4]

RDKit::FilterMatchOps::Or::Or ( const Or rhs)
inline

Definition at line 137 of file FilterMatchers.h.

Member Function Documentation

◆ copy()

boost::shared_ptr<FilterMatcherBase> RDKit::FilterMatchOps::Or::copy ( ) const
inlineoverridevirtual

copy copies the current FilterMatcherBase into one that can be passed around safely.

Implements RDKit::FilterMatcherBase.

Definition at line 164 of file FilterMatchers.h.

◆ getMatches()

bool RDKit::FilterMatchOps::Or::getMatches ( const ROMol mol,
std::vector< FilterMatch > &  matchVect 
) const
inlineoverridevirtual

getMatches

Match the filter against a molecule

Parameters
molreadonly const molecule being searched
matchesoutput vector of atom index matches found in the molecule

Implements RDKit::FilterMatcherBase.

Definition at line 153 of file FilterMatchers.h.

References PRECONDITION.

◆ getName()

std::string RDKit::FilterMatchOps::Or::getName ( ) const
inlineoverridevirtual

Reimplemented from RDKit::FilterMatcherBase.

Definition at line 139 of file FilterMatchers.h.

References RDKit::FilterMatcherBase::getName().

◆ hasMatch()

bool RDKit::FilterMatchOps::Or::hasMatch ( const ROMol mol) const
inlineoverridevirtual

hasMatches

Does the given molecule contain this filter pattern

Parameters
molreadonly const molecule being searched

Implements RDKit::FilterMatcherBase.

Definition at line 148 of file FilterMatchers.h.

References PRECONDITION.

◆ isValid()

bool RDKit::FilterMatchOps::Or::isValid ( ) const
inlineoverridevirtual

Implements RDKit::FilterMatcherBase.

Definition at line 144 of file FilterMatchers.h.


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