RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Class Template Reference

a Query implementing ==: arguments must match a particular value (within an optional tolerance) More...

#include <EqualityQuery.h>

Inheritance diagram for Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >:
Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion > Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >

Public Member Functions

 EqualityQuery ()
 
 EqualityQuery (MatchFuncArgType v)
 constructs with our target value
 
 EqualityQuery (MatchFuncArgType v, MatchFuncArgType t)
 constructs with our target value and a tolerance
 
void setVal (MatchFuncArgType what)
 sets our target value
 
const MatchFuncArgType getVal () const
 returns our target value
 
void setTol (MatchFuncArgType what)
 sets our tolerance
 
const MatchFuncArgType getTol () const
 returns out tolerance
 
bool Match (const DataFuncArgType what) const override
 returns whether or not we match the argument
 
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy () const override
 returns a copy of this Query
 
std::string getFullDescription () const override
 returns a fuller text description
 
- Public Member Functions inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
 Query ()
 
virtual ~Query ()
 
void setNegation (bool what)
 sets whether or not we are negated
 
bool getNegation () const
 returns whether or not we are negated
 
void setDescription (const std::string &descr)
 sets our text description
 
void setDescription (const char *descr)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const std::string & getDescription () const
 returns our text description
 
void setTypeLabel (const std::string &typ)
 sets our type label
 
void setTypeLabel (const char *typ)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const std::string & getTypeLabel () const
 returns our text label.
 
void setMatchFunc (bool(*what)(MatchFuncArgType))
 sets our match function
 
void setDataFunc (MatchFuncArgType(*what)(DataFuncArgType))
 sets our data function
 
void addChild (CHILD_TYPE child)
 adds a child to our list of children
 
CHILD_VECT_CI beginChildren () const
 returns an iterator for the beginning of our child vector
 
CHILD_VECT_CI endChildren () const
 returns an iterator for the end of our child vector
 

Additional Inherited Members

- Public Types inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
using CHILD_TYPE
 
using CHILD_VECT = std::vector<CHILD_TYPE>
 
using CHILD_VECT_I = typename CHILD_VECT::iterator
 
using CHILD_VECT_CI = typename CHILD_VECT::const_iterator
 
using MATCH_FUNC_ARG_TYPE = MatchFuncArgType
 
using DATA_FUNC_ARG_TYPE = DataFuncArgType
 
- Public Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
bool(*)(MatchFuncArgType) getMatchFunc () const
 returns our match function:
 
MatchFuncArgType(*)(DataFuncArgType) getDataFunc () const
 returns our data function:
 
- Protected Member Functions inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
MatchFuncArgType TypeConvert (MatchFuncArgType what, Int2Type< false >) const
 calls our dataFunc (if it's set) on what and returns the result, otherwise returns what
 
MatchFuncArgType TypeConvert (DataFuncArgType what, Int2Type< true >) const
 
- Protected Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
MatchFuncArgType d_val = 0
 
MatchFuncArgType d_tol = 0
 
std::string d_description = ""
 
std::string d_queryType = ""
 
CHILD_VECT d_children
 
bool df_negate {false}
 
bool(* d_matchFunc )(MatchFuncArgType)
 
union { 
 
   MatchFuncArgType(*   d_dataFunc )(DataFuncArgType) 
 
   MatchFuncArgType(*   d_dataFuncSameType )(MatchFuncArgType) 
 
};  
 

Detailed Description

template<typename MatchFuncArgType, typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
class Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >

a Query implementing ==: arguments must match a particular value (within an optional tolerance)

Definition at line 23 of file EqualityQuery.h.

Constructor & Destructor Documentation

◆ EqualityQuery() [1/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( )
inline

Definition at line 26 of file EqualityQuery.h.

◆ EqualityQuery() [2/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( MatchFuncArgType v)
inlineexplicit

constructs with our target value

Definition at line 29 of file EqualityQuery.h.

◆ EqualityQuery() [3/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( MatchFuncArgType v,
MatchFuncArgType t )
inline

constructs with our target value and a tolerance

Definition at line 35 of file EqualityQuery.h.

Member Function Documentation

◆ copy()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy ( ) const
inlineoverridevirtual

returns a copy of this Query

Notes:

  • the caller is responsible for deleteing the result

Reimplemented from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >.

Reimplemented in RDKit::HasPropQuery< TargetPtr >, RDKit::HasPropWithValueQuery< TargetPtr, T >, RDKit::HasPropWithValueQuery< TargetPtr, std::string >, RDKit::HasPropWithValueQuery< TargetPtr, ExplicitBitVect >, Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, and Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >.

Definition at line 61 of file EqualityQuery.h.

References Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_description, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_queryType, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDataFunc(), Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setNegation(), Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setTol(), and Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setVal().

◆ getFullDescription()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
std::string Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription ( ) const
inlineoverridevirtual

returns a fuller text description

Reimplemented from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >.

Reimplemented in Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, and Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >.

Definition at line 74 of file EqualityQuery.h.

◆ getTol()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getTol ( ) const
inline

returns out tolerance

Definition at line 49 of file EqualityQuery.h.

◆ getVal()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getVal ( ) const
inline

returns our target value

Definition at line 44 of file EqualityQuery.h.

◆ Match()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
bool Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match ( const DataFuncArgType arg) const
inlineoverridevirtual

returns whether or not we match the argument

Reimplemented from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >.

Reimplemented in Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, and Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >.

Definition at line 51 of file EqualityQuery.h.

References Queries::queryCmp().

◆ setTol()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setTol ( MatchFuncArgType what)
inline

sets our tolerance

Definition at line 47 of file EqualityQuery.h.

Referenced by RDKit::AtomRingQuery::copy(), Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ setVal()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setVal ( MatchFuncArgType what)
inline

sets our target value

Definition at line 42 of file EqualityQuery.h.

Referenced by Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

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