Happy New Year!
[ginac.git] / ginac / relational.h
index a5188b5c4d95f4c114511f78297d971c352c88d0..ac6caecfd801425de214b380f8a7df0c8fff2a9c 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to relations between expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2019 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 "basic.h"
 #include "ex.h"
+#include "archive.h"
 
 namespace GiNaC {
 
@@ -45,34 +46,57 @@ public:
                greater_or_equal
        };
        
-       // other ctors
+       // other constructors
 public:
        relational(const ex & lhs, const ex & rhs, operators oper=equal);
        
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
-       unsigned precedence(void) const {return 20;}
-       bool info(unsigned inf) const;
-       unsigned nops() const;
-       ex & let_op(int i);
-       ex eval(int level=0) const;
-       ex evalf(int level=0) const;
-       ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
-       ex simplify_ncmul(const exvector & v) const;
+       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;
 protected:
-       unsigned return_type(void) const;
-       unsigned return_type_tinfo(void) const;
+       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;
 
        // new virtual functions which can be overridden by derived classes
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
+
 public:
-       virtual ex lhs(void) const;
-       virtual ex rhs(void) const;
+       ex lhs() const { return lh; }
+       ex rhs() const { return rh; }
 
        // non-virtual functions in this class
-public:
-       operator bool(void) const;
+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() {};
+       };
+
+       typedef void (safe_bool_helper::*safe_bool)();
        
+       safe_bool make_safe_bool(bool) const;
+
+public:
+       operator safe_bool() const;
+       safe_bool operator!() const;
+
 // member variables
        
 protected:
@@ -80,22 +104,16 @@ protected:
        ex rh;
        operators o;
 };
+GINAC_DECLARE_UNARCHIVER(relational); 
 
 // utility functions
 
-/** Return the relational object handled by an ex.  Deprecated: use ex_to<relational>().
- *  This is unsafe: you need to check the type first. */
-inline const relational &ex_to_relational(const ex &e)
-{
-       return static_cast<const relational &>(*e.bp);
-}
-
-/** Specialization of is_exactly_a<relational>(obj) for relational objects. */
-template<> inline bool is_exactly_a<relational>(const basic & obj)
+// inlined functions for efficiency
+inline relational::safe_bool relational::operator!() const
 {
-       return obj.tinfo()==TINFO_relational;
+       return make_safe_bool(!static_cast<bool>(*this));
 }
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_RELATIONAL_H__
+#endif // ndef GINAC_RELATIONAL_H