* Added documentation for the add_dyn(), mul_dyn()... methods.

[ginac.git] / ginac / relational.h

diff --git a/ginac/relational.h b/ginac/relational.h
index c3b223b5eb0f494f722ffc25f20a10ce72de5431..0062a753832be9cc13edccaa79b22f1f0917713f 100644 (file)
--- a/ginac/relational.h
+++ b/ginac/relational.h
@@ -3,7 +3,7 @@
  *  Interface to relations between expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2002 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
@@ -49,7 +49,7 @@ public:
 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;}
@@ -57,12 +57,13 @@ public:
        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;
+
 protected:
+       bool match_same_type(const basic & other) const;
        unsigned return_type(void) const;
        unsigned return_type_tinfo(void) const;
+       unsigned calchash(void) const;
 
        // new virtual functions which can be overridden by derived classes
 public:
@@ -70,9 +71,23 @@ public:
        virtual ex rhs(void) const;
 
        // 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(void) const;
+       safe_bool operator!(void) const;
+
 // member variables
        
 protected:
@@ -82,9 +97,17 @@ protected:
 };
 
 // utility functions
-inline const relational &ex_to_relational(const ex &e)
+
+/** Specialization of is_exactly_a<relational>(obj) for relational objects. */
+template<> inline bool is_exactly_a<relational>(const basic & obj)
+{
+       return obj.tinfo()==TINFO_relational;
+}
+
+// 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));
 }
 
 } // namespace GiNaC