64ea0ff8e311dc4766a99534ad83cb9890f87e06
[ginac.git] / ginac / relational.h
1 /** @file relational.h
2  *
3  *  Interface to relations between expressions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef __GINAC_RELATIONAL_H__
24 #define __GINAC_RELATIONAL_H__
25
26 #include "basic.h"
27 #include "ex.h"
28
29 namespace GiNaC {
30
31 /** This class holds a relation consisting of two expressions and a logical
32  *  relation between them. */
33 class relational : public basic
34 {
35         GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
36
37 // types
38 public:
39         enum operators {
40                 equal,
41                 not_equal,
42                 less,
43                 less_or_equal,
44                 greater,
45                 greater_or_equal
46         };
47         
48         // other constructors
49 public:
50         relational(const ex & lhs, const ex & rhs, operators oper=equal);
51         
52         // functions overriding virtual functions from base classes
53 public:
54         unsigned precedence() const {return 20;}
55         bool info(unsigned inf) const;
56         size_t nops() const;
57         ex op(size_t i) const;
58         ex map(map_function & f) const;
59         ex subs(const exmap & m, unsigned options = 0) const;
60         ex eval(int level=0) const;
61
62 protected:
63         ex eval_ncmul(const exvector & v) const;
64         bool match_same_type(const basic & other) const;
65         unsigned return_type() const;
66         unsigned return_type_tinfo() const;
67         unsigned calchash() const;
68
69         // new virtual functions which can be overridden by derived classes
70 protected:
71         void do_print(const print_context & c, unsigned level) const;
72         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
73
74 public:
75         virtual ex lhs() const;
76         virtual ex rhs() const;
77
78         // non-virtual functions in this class
79 private:
80         // For conversions to boolean, as would be used in an if conditional,
81         // implicit conversions from bool to int have a large number of
82         // undesirable side effects.  The following safe_bool type enables
83         // use of relational objects in conditionals without those side effects
84         struct safe_bool_helper {
85                 void nonnull() {};
86         };
87
88         typedef void (safe_bool_helper::*safe_bool)();
89         
90         safe_bool make_safe_bool(bool) const;
91
92 public:
93         operator safe_bool() const;
94         safe_bool operator!() const;
95
96 // member variables
97         
98 protected:
99         ex lh;
100         ex rh;
101         operators o;
102 };
103
104 // utility functions
105
106 /** Specialization of is_exactly_a<relational>(obj) for relational objects. */
107 template<> inline bool is_exactly_a<relational>(const basic & obj)
108 {
109         return obj.tinfo()==TINFO_relational;
110 }
111
112 // inlined functions for efficiency
113 inline relational::safe_bool relational::operator!() const
114 {
115         return make_safe_bool(!static_cast<bool>(*this));
116 }
117
118 } // namespace GiNaC
119
120 #endif // ndef __GINAC_RELATIONAL_H__