![]() |
RDKit
Open-source cheminformatics and machine learning.
|
a Query implementing a range: arguments must fall in a particular range of values. More...
#include <RangeQuery.h>
Public Member Functions | |
RangeQuery () | |
RangeQuery (MatchFuncArgType lower, MatchFuncArgType upper) | |
construct and set the lower and upper bounds More... | |
void | setUpper (MatchFuncArgType what) |
sets our upper bound More... | |
const MatchFuncArgType | getUpper () const |
returns our upper bound More... | |
void | setLower (MatchFuncArgType what) |
sets our lower bound More... | |
const MatchFuncArgType | getLower () const |
returns our lower bound More... | |
void | setEndsOpen (bool lower, bool upper) |
sets whether or not the ends of the range are open More... | |
std::pair< bool, bool > | getEndsOpen () const |
returns the state of our ends (open or not) More... | |
void | setTol (MatchFuncArgType what) |
sets our tolerance More... | |
const MatchFuncArgType | getTol () const |
returns our tolerance More... | |
bool | Match (const DataFuncArgType what) const |
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * | copy () const |
returns a copy of this Query More... | |
std::string | getFullDescription () const |
returns a fuller text description More... | |
![]() | |
Query () | |
virtual | ~Query () |
void | setNegation (bool what) |
sets whether or not we are negated More... | |
bool | getNegation () const |
returns whether or not we are negated More... | |
void | setDescription (const std::string &descr) |
sets our text description More... | |
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. More... | |
const std::string & | getDescription () const |
returns our text description More... | |
void | setTypeLabel (const std::string &typ) |
sets our type label More... | |
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. More... | |
const std::string & | getTypeLabel () const |
returns our text label. More... | |
void | setMatchFunc (bool(*what)(MatchFuncArgType)) |
sets our match function More... | |
void | setDataFunc (MatchFuncArgType(*what)(MatchFuncArgType)) |
sets our data function More... | |
void | addChild (CHILD_TYPE child) |
adds a child to our list of children More... | |
CHILD_VECT_CI | beginChildren () const |
returns an iterator for the beginning of our child vector More... | |
CHILD_VECT_CI | endChildren () const |
returns an iterator for the end of our child vector More... | |
virtual bool | Match (const MatchFuncArgType arg) const |
returns whether or not we match the argument More... | |
Protected Attributes | |
MatchFuncArgType | d_upper |
MatchFuncArgType | d_lower |
bool | df_upperOpen {true} |
bool | df_lowerOpen {true} |
![]() | |
MatchFuncArgType | d_val |
MatchFuncArgType | d_tol |
std::string | d_description |
std::string | d_queryType |
CHILD_VECT | d_children |
bool | df_negate |
bool(* | d_matchFunc )(MatchFuncArgType) |
union { | |
MatchFuncArgType(* d_dataFunc )(DataFuncArgType) | |
MatchFuncArgType(* d_dataFuncSameType )(MatchFuncArgType) | |
}; | |
Additional Inherited Members | |
![]() | |
typedef std::shared_ptr< Query< MatchFuncArgType, MatchFuncArgType, needsConversion > > | CHILD_TYPE |
typedef std::vector< CHILD_TYPE > | CHILD_VECT |
typedef CHILD_VECT::iterator | CHILD_VECT_I |
typedef CHILD_VECT::const_iterator | CHILD_VECT_CI |
![]() | |
bool(*)(MatchFuncArgType) | getMatchFunc () const |
returns our match function: More... | |
MatchFuncArgType(*)(MatchFuncArgType) | getDataFunc () const |
returns our data function: More... | |
MatchFuncArgType(* | d_dataFunc )(MatchFuncArgType) |
MatchFuncArgType(* | d_dataFuncSameType )(MatchFuncArgType) |
![]() | |
MatchFuncArgType | TypeConvert (MatchFuncArgType what, Int2Type< false >) const |
calls our dataFunc (if it's set) on what and returns the result, otherwise returns what More... | |
MatchFuncArgType | TypeConvert (MatchFuncArgType what, Int2Type< true >) const |
calls our dataFunc (which must be set) on what and returns the More... | |
a Query implementing a range: arguments must fall in a particular range of values.
The ends of the range default to be open, but they can individually set to be closed.
There is also an optional tolerance to be used in comparisons
Definition at line 27 of file RangeQuery.h.
|
inline |
Definition at line 30 of file RangeQuery.h.
References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::df_negate.
|
inline |
construct and set the lower and upper bounds
Definition at line 32 of file RangeQuery.h.
References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::df_negate.
|
inlinevirtual |
returns a copy of this Query
Notes:
delete
ing the result Reimplemented from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >.
Definition at line 83 of file RangeQuery.h.
References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_dataFunc, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_description, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_description, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_queryType, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_queryType, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_lowerOpen, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_upperOpen, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::getNegation(), Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDataFunc(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setEndsOpen(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setLower(), Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setNegation(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setTol(), and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setUpper().
|
inline |
returns the state of our ends (open or not)
Definition at line 52 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_lowerOpen, and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_upperOpen.
|
inlinevirtual |
returns a fuller text description
Reimplemented from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >.
Definition at line 97 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::getDescription(), and Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::getNegation().
|
inline |
returns our lower bound
Definition at line 44 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower.
|
inline |
returns our tolerance
Definition at line 59 of file RangeQuery.h.
References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol.
|
inline |
returns our upper bound
Definition at line 40 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper.
|
inline |
Definition at line 61 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_lowerOpen, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_upperOpen, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::getNegation(), Queries::queryCmp(), and Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::TypeConvert().
|
inline |
sets whether or not the ends of the range are open
Definition at line 47 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_lowerOpen, and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::df_upperOpen.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and RDKit::makeAtomRangeQuery().
|
inline |
sets our lower bound
Definition at line 42 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().
|
inline |
sets our tolerance
Definition at line 57 of file RangeQuery.h.
References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().
|
inline |
sets our upper bound
Definition at line 38 of file RangeQuery.h.
References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().
|
protected |
Definition at line 106 of file RangeQuery.h.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getLower(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match(), and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setLower().
|
protected |
Definition at line 106 of file RangeQuery.h.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getUpper(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match(), and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setUpper().
|
protected |
Definition at line 107 of file RangeQuery.h.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getEndsOpen(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match(), and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setEndsOpen().
|
protected |
Definition at line 107 of file RangeQuery.h.
Referenced by Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getEndsOpen(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match(), and Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setEndsOpen().