RDKit
Open-source cheminformatics and machine learning.
Public Member Functions | List of all members
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 (const boost::shared_ptr< FilterMatcherBase > &arg1, const boost::shared_ptr< FilterMatcherBase > &arg2)
 
 Or (const Or &rhs)
 
virtual std::string getName () const
 
bool isValid () const
 
bool hasMatch (const ROMol &mol) const
 hasMatches More...
 
bool getMatches (const ROMol &mol, std::vector< FilterMatch > &matchVect) const
 getMatches More...
 
boost::shared_ptr< FilterMatcherBase > copy () const
 copy More...
 
- Public Member Functions inherited from RDKit::FilterMatcherBase
 FilterMatcherBase (const std::string &name=DEFAULT_FILTERMATCHERBASE_NAME)
 
 FilterMatcherBase (const FilterMatcherBase &rhs)
 
virtual ~FilterMatcherBase ()
 
virtual boost::shared_ptr< FilterMatcherBase > Clone () const
 Clone - deprecated. More...
 

Detailed Description

Definition at line 115 of file FilterMatchers.h.

Constructor & Destructor Documentation

◆ Or() [1/4]

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

Definition at line 121 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 125 of file FilterMatchers.h.

◆ Or() [3/4]

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

Definition at line 128 of file FilterMatchers.h.

◆ Or() [4/4]

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

Definition at line 132 of file FilterMatchers.h.

Member Function Documentation

◆ copy()

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

copy

Implements RDKit::FilterMatcherBase.

Definition at line 158 of file FilterMatchers.h.

References RDUNUSED_PARAM.

◆ getMatches()

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

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 148 of file FilterMatchers.h.

References PRECONDITION.

◆ getName()

virtual std::string RDKit::FilterMatchOps::Or::getName ( ) const
inlinevirtual

Reimplemented from RDKit::FilterMatcherBase.

Definition at line 134 of file FilterMatchers.h.

References RDKit::FilterMatcherBase::getName().

◆ hasMatch()

bool RDKit::FilterMatchOps::Or::hasMatch ( const ROMol &  mol) const
inlinevirtual

hasMatches

Does the given molecule contain this filter pattern

Parameters
molreadonly const molecule being searched

Implements RDKit::FilterMatcherBase.

Definition at line 143 of file FilterMatchers.h.

References PRECONDITION.

◆ isValid()

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

Implements RDKit::FilterMatcherBase.

Definition at line 139 of file FilterMatchers.h.

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