* Interface to relations between expressions. */
/*
- * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2022 Johannes Gutenberg University Mainz, Germany
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_RELATIONAL_H__
-#define __GINAC_RELATIONAL_H__
+#ifndef GINAC_RELATIONAL_H
+#define GINAC_RELATIONAL_H
-#include <ginac/basic.h>
-#include <ginac/ex.h>
+#include "basic.h"
+#include "ex.h"
+#include "archive.h"
-#ifndef NO_GINAC_NAMESPACE
namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
/** This class holds a relation consisting of two expressions and a logical
* relation between them. */
class relational : public basic
{
+ GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
// types
public:
- enum operators { equal,
- not_equal,
- less,
- less_or_equal,
- greater,
- greater_or_equal
- };
-
-// member functions
-
- // default constructor, destructor, copy constructor assignment operator and helpers
+ enum operators {
+ equal,
+ not_equal,
+ less,
+ less_or_equal,
+ greater,
+ greater_or_equal
+ };
+
+ // other constructors
public:
- relational();
- ~relational();
- relational(relational const & other);
- relational const & operator=(relational const & other);
+ relational(const ex & lhs, const ex & rhs, operators oper=equal);
+
+ // functions overriding virtual functions from base classes
+public:
+ unsigned precedence() const override {return 20;}
+ bool info(unsigned inf) const override;
+ size_t nops() const override;
+ ex op(size_t i) const override;
+ ex map(map_function & f) const override;
+ ex subs(const exmap & m, unsigned options = 0) const override;
+
+ /** Save (a.k.a. serialize) object into archive. */
+ void archive(archive_node& n) const override;
+ /** Read (a.k.a. deserialize) object from archive. */
+ void read_archive(const archive_node& n, lst& syms) override;
+ ex canonical() const;
+
protected:
- void copy(relational const & other);
- void destroy(bool call_parent);
+ ex eval_ncmul(const exvector & v) const override;
+ bool match_same_type(const basic & other) const override;
+ unsigned return_type() const override;
+ return_type_t return_type_tinfo() const override;
+ unsigned calchash() const override;
- // other constructors
-public:
- relational(ex const & lhs, ex const & rhs, operators oper=equal);
-
- // functions overriding virtual functions from bases classes
-public:
- basic * duplicate() const;
- void print(ostream & os, unsigned upper_precedence=0) const;
- void printraw(ostream & os) const;
- void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
- bool info(unsigned inf) const;
- unsigned nops() const;
- ex & let_op(int const i);
- ex eval(int level=0) const;
- ex evalf(int level=0) const;
- ex simplify_ncmul(exvector const & v) const;
+ // new virtual functions which can be overridden by derived classes
protected:
- int compare_same_type(basic const & other) const;
- unsigned return_type(void) const;
- unsigned return_type_tinfo(void) const;
+ void do_print(const print_context & c, unsigned level) const;
+ void do_print_python_repr(const print_python_repr & c, unsigned level) const;
+
+public:
+ ex lhs() const { return lh; }
+ ex rhs() const { return rh; }
+
+ // non-virtual functions in this class
+private:
+ // For conversions to Boolean, as would be used in an if conditional,
+ // implicit conversions from bool to int have a large number of
+ // undesirable side effects. The following safe_bool type enables
+ // use of relational objects in conditionals without those side effects
+ struct safe_bool_helper {
+ void nonnull() {};
+ };
- // new virtual functions which can be overridden by derived classes
- // none
+ typedef void (safe_bool_helper::*safe_bool)();
+
+ safe_bool make_safe_bool(bool) const;
- // non-virtual functions in this class
public:
- operator bool(void) const;
-
+ operator safe_bool() const;
+ safe_bool operator!() const;
+
// member variables
-
+
protected:
- ex lh;
- ex rh;
- operators o;
- static unsigned precedence;
+ ex lh;
+ ex rh;
+ operators o;
};
-
-// global constants
-
-extern const relational some_relational;
-extern type_info const & typeid_relational;
+GINAC_DECLARE_UNARCHIVER(relational);
// utility functions
-inline const relational &ex_to_relational(const ex &e)
+
+// inlined functions for efficiency
+inline relational::safe_bool relational::operator!() const
{
- return static_cast<const relational &>(*e.bp);
+ return make_safe_bool(!static_cast<bool>(*this));
}
-#ifndef NO_GINAC_NAMESPACE
} // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
-#endif // ndef __GINAC_RELATIONAL_H__
+#endif // ndef GINAC_RELATIONAL_H