Polaris: Relation.h Source File

Relation.h Go to the documentation of this file. /// /// /// file Relation.h /// #ifndef _RELATION_H #define _RELATION_H /// /// \class Relation /// \brief A set of algebraic relationships {<,=,>} /// \defgroup Polaris /// \ingroup Polaris /// Range /// \see Relation.h /// /// \endcode /// \section Overview Overview /// A Relation object represents a set of algebraic relationships /// {<,=,>}. /// #include <stream.h> /// class Relation { public: inline Relation(); ///< Construct a Relation with no relationships. inline Relation(bool less_than, bool equal, bool greater_than); ///< Construct a Relation with the given algebraic relationships inline Relation(const Relation &other); ///< Construct a copy of the given Relation inline ~Relation(); ///< Destructor inline void less_than(bool value); inline void equal(bool value); inline void greater_than(bool value); inline void circular(bool value); ///< Set/Clear the less than, equal, greater than, or ///< circular relationships inline bool is_less_than() const; inline bool is_less_equal() const; inline bool is_equal() const; inline bool is_not_equal() const; inline bool is_greater_than() const; inline bool is_greater_equal() const; inline bool is_unknown() const; inline bool is_circular() const; ///< Return whether the specified relationship holds inline Relation &operator = (const Relation &other); ///< Assignment operator inline Relation &operator &= (const Relation &other); inline Relation operator & (const Relation &other) const; ///< And operator. Returns a relation that will return true for one ///< of the is_*() methods if and only if that method would return ///< true for both of the given relations. inline void print(ostream &o) const; inline friend ostream & operator << (ostream & o, const Relation & r); ///< Print the relation as one of {<,<=,==,!=,>,>=,?,@} private: bool _may_be_less_than; bool _may_be_equal; bool _may_be_greater_than; bool _may_be_circular; }; ///< inline functions inline Relation::Relation() { #ifdef CLASS_INSTANCE_REGISTRY register_instance(RELATION_CLASS, sizeof(Relation), this); #endif _may_be_less_than = false; _may_be_equal = false; _may_be_greater_than = false; _may_be_circular = false; } inline Relation::Relation(bool less_than, bool equal, bool greater_than) { #ifdef CLASS_INSTANCE_REGISTRY register_instance(RELATION_CLASS, sizeof(Relation), this); #endif _may_be_less_than = less_than; _may_be_equal = equal; _may_be_greater_than = greater_than; _may_be_circular = false; } inline Relation::Relation(const Relation &other) { #ifdef CLASS_INSTANCE_REGISTRY register_instance(RELATION_CLASS, sizeof(Relation), this); #endif _may_be_less_than = other._may_be_less_than; _may_be_equal = other._may_be_equal; _may_be_greater_than = other._may_be_greater_than; _may_be_circular = other._may_be_circular; } inline Relation::~Relation() { #ifdef CLASS_INSTANCE_REGISTRY unregister_instance(RELATION_CLASS, this); #endif ///< nothing to do } inline void Relation::less_than(bool value) { _may_be_less_than = value; } inline void Relation::equal(bool value) { _may_be_equal = value; } inline void Relation::greater_than(bool value) { _may_be_greater_than = value; } inline void Relation::circular(bool value) { _may_be_circular = value; } inline bool Relation::is_less_than() const { return (_may_be_less_than && ! _may_be_equal && ! _may_be_greater_than); } inline bool Relation::is_less_equal() const { return ((_may_be_less_than || _may_be_equal) && ! _may_be_greater_than); } inline bool Relation::is_equal() const { return (! _may_be_less_than && _may_be_equal && ! _may_be_greater_than); } inline bool Relation::is_not_equal() const { return (! _may_be_equal && (_may_be_less_than || _may_be_greater_than)); } inline bool Relation::is_greater_than() const { return (! _may_be_less_than && ! _may_be_equal && _may_be_greater_than); } inline bool Relation::is_greater_equal() const { return (! _may_be_less_than && (_may_be_equal || _may_be_greater_than)); } inline bool Relation::is_unknown() const { return ((! _may_be_less_than && ! _may_be_equal && ! _may_be_greater_than) || (_may_be_less_than && _may_be_equal && _may_be_greater_than)); } inline bool Relation::is_circular() const { return _may_be_circular; } inline Relation & Relation::operator = (const Relation &other) { _may_be_less_than = other._may_be_less_than; _may_be_equal = other._may_be_equal; _may_be_greater_than = other._may_be_greater_than; _may_be_circular = other._may_be_circular; return *this; } inline Relation & Relation::operator &= (const Relation &other) { _may_be_less_than = _may_be_less_than && other._may_be_less_than; _may_be_equal = _may_be_equal && other._may_be_equal; _may_be_greater_than = _may_be_greater_than && other._may_be_greater_than; _may_be_circular = _may_be_circular && other._may_be_circular; return *this; } inline Relation Relation::operator & (const Relation &other) const { Relation result(*this); result &= other; return result; } inline void Relation::print(ostream &o) const { if (is_equal()) o << "=="; else if (is_less_than()) o << "<"; else if (is_less_equal()) o << "<="; else if (is_greater_than()) o << ">"; else if (is_greater_equal()) o << ">="; else if (is_not_equal()) o << "!="; else o << "?"; if (is_circular()) o << "@"; } inline ostream & operator << (ostream & o, const Relation & r) { r.print(o); return o; } #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:06:06 2005