RDKit
Open-source cheminformatics and machine learning.
Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Class Template Reference

a Query implementing a range: arguments must fall in a particular range of values. More...

#include <RangeQuery.h>

Inheritance diagram for Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >:
Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >

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
 returns whether or not we match the argument More...
 
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy () const
 returns a copy of this Query More...
 
std::string getFullDescription () const
 returns a fuller text description More...
 
- Public Member Functions inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
 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)
 
const std::string & getDescription () const
 returns our text description More...
 
void setMatchFunc (bool(*what)(MatchFuncArgType))
 sets our match function More...
 
void setDataFunc (MatchFuncArgType(*what)(DataFuncArgType))
 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...
 

Protected Attributes

MatchFuncArgType d_upper
 
MatchFuncArgType d_lower
 
MatchFuncArgType d_tol
 
bool df_upperOpen
 
bool df_lowerOpen
 
- Protected Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
std::string d_description
 
CHILD_VECT d_children
 
bool df_negate
 
bool(* d_matchFunc )(MatchFuncArgType)
 
MatchFuncArgType(* d_dataFunc )(DataFuncArgType)
 

Additional Inherited Members

- Public Types inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
typedef boost::shared_ptr< Query< MatchFuncArgType, DataFuncArgType, needsConversion > > CHILD_TYPE
 
typedef std::vector< CHILD_TYPECHILD_VECT
 
typedef CHILD_VECT::iterator CHILD_VECT_I
 
typedef CHILD_VECT::const_iterator CHILD_VECT_CI
 
- Public Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
bool(*)(MatchFuncArgType) getMatchFunc () const
 returns our match function: More...
 
MatchFuncArgType(*)(DataFuncArgType) getDataFunc () const
 returns our data function: More...
 
- 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 More...
 
MatchFuncArgType TypeConvert (DataFuncArgType what, Int2Type< true >) const
 calls our dataFunc (which must be set) on what and returns the More...
 

Detailed Description

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

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 26 of file RangeQuery.h.

Constructor & Destructor Documentation

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::RangeQuery ( )
inline
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::RangeQuery ( MatchFuncArgType  lower,
MatchFuncArgType  upper 
)
inline

construct and set the lower and upper bounds

Definition at line 38 of file RangeQuery.h.

References Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::df_negate.

Member Function Documentation

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Query<MatchFuncArgType, DataFuncArgType, needsConversion>* Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy ( ) const
inlinevirtual
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
std::pair<bool, bool> Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getEndsOpen ( ) const
inline
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
std::string Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription ( ) const
inlinevirtual
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getLower ( ) const
inline

returns our lower bound

Definition at line 54 of file RangeQuery.h.

References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_lower.

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

returns our tolerance

Definition at line 69 of file RangeQuery.h.

References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_tol.

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getUpper ( ) const
inline

returns our upper bound

Definition at line 50 of file RangeQuery.h.

References Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_upper.

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setEndsOpen ( bool  lower,
bool  upper 
)
inline
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setLower ( MatchFuncArgType  what)
inline
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setTol ( MatchFuncArgType  what)
inline
template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setUpper ( MatchFuncArgType  what)
inline

Member Data Documentation

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
MatchFuncArgType Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_tol
protected

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