RangeQuery.h
Go to the documentation of this file.
//
// Copyright (c) 2003-2006 Greg Landrum and Rational Discovery LLC
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
#include <RDGeneral/export.h>
#ifndef __RD_RANGEQUERY_H__
#define __RD_RANGEQUERY_H__
#include "Query.h"
#include <utility>
namespace Queries {
//! \brief 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
template <class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType,
bool needsConversion = false>
class RangeQuery
: public Query<MatchFuncArgType, DataFuncArgType, needsConversion> {
public:
RangeQuery()
: d_upper(0), d_lower(0), df_upperOpen(true), df_lowerOpen(true) {
this->df_negate = false;
};
//! construct and set the lower and upper bounds
RangeQuery(MatchFuncArgType lower, MatchFuncArgType upper)
: d_upper(upper), d_lower(lower), df_upperOpen(true), df_lowerOpen(true) {
this->df_negate = false;
};
//! sets our upper bound
void setUpper(MatchFuncArgType what) { this->d_upper = what; };
//! returns our upper bound
const MatchFuncArgType getUpper() const { return this->d_upper; };
//! sets our lower bound
void setLower(MatchFuncArgType what) { this->d_lower = what; };
//! returns our lower bound
const MatchFuncArgType getLower() const { return this->d_lower; };
//! sets whether or not the ends of the range are open
void setEndsOpen(bool lower, bool upper) {
this->df_lowerOpen = lower;
this->df_upperOpen = upper;
};
//! returns the state of our ends (open or not)
std::pair<bool, bool> getEndsOpen() const {
return std::make_pair(this->df_lowerOpen, this->df_upperOpen);
};
//! sets our tolerance
void setTol(MatchFuncArgType what) { this->d_tol = what; };
//! returns our tolerance
const MatchFuncArgType getTol() const { return this->d_tol; };
bool Match(const DataFuncArgType what) const {
MatchFuncArgType mfArg =
this->TypeConvert(what, Int2Type<needsConversion>());
int lCmp = queryCmp(this->d_lower, mfArg, this->d_tol);
int uCmp = queryCmp(this->d_upper, mfArg, this->d_tol);
bool lowerRes, upperRes;
if (this->df_lowerOpen)
lowerRes = lCmp < 0;
else
lowerRes = lCmp <= 0;
if (this->df_upperOpen)
upperRes = uCmp > 0;
else
upperRes = uCmp >= 0;
bool tempR = !(lowerRes && upperRes);
if (this->getNegation())
return tempR;
else
return !tempR;
};
Query<MatchFuncArgType, DataFuncArgType, needsConversion> *copy() const {
RangeQuery<MatchFuncArgType, DataFuncArgType, needsConversion> *res =
new RangeQuery<MatchFuncArgType, DataFuncArgType, needsConversion>();
res->setUpper(this->d_upper);
res->setLower(this->d_lower);
res->setTol(this->d_tol);
res->setNegation(this->getNegation());
res->setEndsOpen(this->df_lowerOpen, this->df_upperOpen);
res->setDataFunc(this->d_dataFunc);
res->d_description = this->d_description;
return res;
};
std::string getFullDescription() const {
std::ostringstream res;
res << this->getDescription();
if (this->getNegation()) res << " ! ";
res << " " << this->d_lower << " val " << this->d_upper;
return res.str();
};
protected:
MatchFuncArgType d_upper, d_lower;
bool df_upperOpen, df_lowerOpen;
};
} // namespace Queries
#endif
Queries::RangeQuery::getLower
const MatchFuncArgType getLower() const
returns our lower bound
Definition: RangeQuery.h:47
Queries::Query::df_negate
bool df_negate
Definition: Query.h:149
Queries::RangeQuery::d_upper
MatchFuncArgType d_upper
Definition: RangeQuery.h:105
Queries::RangeQuery::copy
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy() const
returns a copy of this Query
Definition: RangeQuery.h:86
Queries::Query::setNegation
void setNegation(bool what)
sets whether or not we are negated
Definition: Query.h:63
Queries::queryCmp
int queryCmp(const T1 v1, const T2 v2, const T1 tol)
Definition: Query.h:191
Queries::Query::d_dataFunc
MatchFuncArgType(* d_dataFunc)(DataFuncArgType)
Definition: Query.h:158
Queries::RangeQuery::getFullDescription
std::string getFullDescription() const
returns a fuller text description
Definition: RangeQuery.h:99
Query.h
Queries::RangeQuery::getUpper
const MatchFuncArgType getUpper() const
returns our upper bound
Definition: RangeQuery.h:43
Queries::RangeQuery
a Query implementing a range: arguments must fall in a particular range of values.
Definition: RangeQuery.h:27
Queries::RangeQuery::setEndsOpen
void setEndsOpen(bool lower, bool upper)
sets whether or not the ends of the range are open
Definition: RangeQuery.h:50
Queries
Definition: AndQuery.h:16
Queries::RangeQuery::setUpper
void setUpper(MatchFuncArgType what)
sets our upper bound
Definition: RangeQuery.h:41
Queries::RangeQuery::df_lowerOpen
bool df_lowerOpen
Definition: RangeQuery.h:109
Queries::RangeQuery::df_upperOpen
bool df_upperOpen
Definition: RangeQuery.h:109
Queries::Query::d_description
std::string d_description
Definition: Query.h:147
Queries::RangeQuery::setTol
void setTol(MatchFuncArgType what)
sets our tolerance
Definition: RangeQuery.h:60
Queries::Query::setDataFunc
void setDataFunc(MatchFuncArgType(*what)(DataFuncArgType))
sets our data function
Definition: Query.h:92
Queries::RangeQuery::Match
bool Match(const DataFuncArgType what) const
returns whether or not we match the argument
Definition: RangeQuery.h:64
Queries::Query::getNegation
bool getNegation() const
returns whether or not we are negated
Definition: Query.h:65
Queries::Int2Type
class to allow integer values to pick templates
Definition: Query.h:27
Queries::RangeQuery::getEndsOpen
std::pair< bool, bool > getEndsOpen() const
returns the state of our ends (open or not)
Definition: RangeQuery.h:55
Queries::Query::TypeConvert
MatchFuncArgType TypeConvert(MatchFuncArgType what, Int2Type< false >) const
calls our dataFunc (if it's set) on what and returns the result, otherwise returns what
Definition: Query.h:163
Queries::RangeQuery::RangeQuery
RangeQuery(MatchFuncArgType lower, MatchFuncArgType upper)
construct and set the lower and upper bounds
Definition: RangeQuery.h:35
Queries::Query::d_tol
MatchFuncArgType d_tol
Definition: Query.h:146
Queries::RangeQuery::RangeQuery
RangeQuery()
Definition: RangeQuery.h:30
Queries::Query
Base class for all queries.
Definition: Query.h:46
Queries::RangeQuery::d_lower
MatchFuncArgType d_lower
Definition: RangeQuery.h:105
Queries::Query::getDescription
const std::string & getDescription() const
returns our text description
Definition: Query.h:76
Queries::RangeQuery::setLower
void setLower(MatchFuncArgType what)
sets our lower bound
Definition: RangeQuery.h:45
Queries::RangeQuery::getTol
const MatchFuncArgType getTol() const
returns our tolerance
Definition: RangeQuery.h:62
export.h