RDKit: RDKit::FilterMatchOps::And Class Reference

| RDKit Open-source cheminformatics and machine learning.

Loading...
Searching...
No Matches
Public Member Functions | List of all members
RDKit::FilterMatchOps::And Class Reference

`#include <FilterMatchers.h>`

Inheritance diagram for RDKit::FilterMatchOps::And:

## Public Member Functions
| And ()
| And (const FilterMatcherBase &arg1, const FilterMatcherBase &arg2)
| And (boost::shared_ptr< FilterMatcherBase > arg1, boost::shared_ptr< FilterMatcherBase > arg2)
| And (const And &rhs)
std::string | getName () const override
bool | isValid () const override
bool | hasMatch (const ROMol &mol) const override
| hasMatches
bool | getMatches (const ROMol &mol, std::vector< FilterMatch > &matchVect) const override
| getMatches
boost::shared_ptr< FilterMatcherBase > | copy () 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< FilterMatcherBase > | Clone () const

## Detailed Description

Definition at line 60 of file FilterMatchers.h.

## Constructor & Destructor Documentation

## ◆ And() [1/4]

RDKit::FilterMatchOps::And::And | ( |  | ) |
| inline

Definition at line 66 of file FilterMatchers.h.

References RDKit::FilterMatcherBase::FilterMatcherBase().

Referenced by And(), and copy().

## ◆ And() [2/4]

RDKit::FilterMatchOps::And::And | ( | const FilterMatcherBase & | arg1,
|  | const FilterMatcherBase & | arg2 )
| inline

Constructs an Ander True if arg1 and arg2 FilterMatchers are true

Definition at line 71 of file FilterMatchers.h.

References copy(), and RDKit::FilterMatcherBase::FilterMatcherBase().

## ◆ And() [3/4]

RDKit::FilterMatchOps::And::And | ( | boost::shared_ptr< FilterMatcherBase > | arg1,
|  | boost::shared_ptr< FilterMatcherBase > | arg2 )
| inline

Definition at line 74 of file FilterMatchers.h.

References RDKit::FilterMatcherBase::FilterMatcherBase().

## ◆ And() [4/4]

RDKit::FilterMatchOps::And::And | ( | const And & | rhs | ) |
| inline

Definition at line 80 of file FilterMatchers.h.

References And(), and RDKit::FilterMatcherBase::FilterMatcherBase().

## Member Function Documentation

## ◆ copy()

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

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

Implements RDKit::FilterMatcherBase.

Definition at line 110 of file FilterMatchers.h.

References And().

Referenced by And().

## ◆ getMatches()

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

getMatches

Match the filter against a molecule

Parameters

  mol | readonly const molecule being searched
  matches | output vector of atom index matches found in the molecule

Implements RDKit::FilterMatcherBase.

Definition at line 98 of file FilterMatchers.h.

References isValid(), and PRECONDITION.

## ◆ getName()

std::string RDKit::FilterMatchOps::And::getName | ( |  | ) | const
| inlineoverridevirtual

Reimplemented from RDKit::FilterMatcherBase.

Definition at line 83 of file FilterMatchers.h.

References RDKit::FilterMatcherBase::getName().

## ◆ hasMatch()

bool RDKit::FilterMatchOps::And::hasMatch | ( | const ROMol & | mol | ) | const
| inlineoverridevirtual

hasMatches

Does the given molecule contain this filter pattern

Parameters

  mol | readonly const molecule being searched

Implements RDKit::FilterMatcherBase.

Definition at line 92 of file FilterMatchers.h.

References isValid(), and PRECONDITION.

## ◆ isValid()

bool RDKit::FilterMatchOps::And::isValid | ( |  | ) | const
| inlineoverridevirtual

Implements RDKit::FilterMatcherBase.

Definition at line 88 of file FilterMatchers.h.

Referenced by getMatches(), and hasMatch().

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

- FilterMatchers.h