Happy New Year!
[ginac.git] / ginac / relational.h
1 /** @file relational.h
2  *
3  *  Interface to relations between expressions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2019 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 #include "archive.h"
29
30 namespace GiNaC {
31
32 /** This class holds a relation consisting of two expressions and a logical
33  *  relation between them. */
34 class relational : public basic
35 {
36         GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
37
38 // types
39 public:
40         enum operators {
41                 equal,
42                 not_equal,
43                 less,
44                 less_or_equal,
45                 greater,
46                 greater_or_equal
47         };
48         
49         // other constructors
50 public:
51         relational(const ex & lhs, const ex & rhs, operators oper=equal);
52         
53         // functions overriding virtual functions from base classes
54 public:
55         unsigned precedence() const override {return 20;}
56         bool info(unsigned inf) const override;
57         size_t nops() const override;
58         ex op(size_t i) const override;
59         ex map(map_function & f) const override;
60         ex subs(const exmap & m, unsigned options = 0) const override;
61
62         /** Save (a.k.a. serialize) object into archive. */
63         void archive(archive_node& n) const override;
64         /** Read (a.k.a. deserialize) object from archive. */
65         void read_archive(const archive_node& n, lst& syms) override;
66 protected:
67         ex eval_ncmul(const exvector & v) const override;
68         bool match_same_type(const basic & other) const override;
69         unsigned return_type() const override;
70         return_type_t return_type_tinfo() const override;
71         unsigned calchash() const override;
72
73         // new virtual functions which can be overridden by derived classes
74 protected:
75         void do_print(const print_context & c, unsigned level) const;
76         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
77
78 public:
79         ex lhs() const { return lh; }
80         ex rhs() const { return rh; }
81
82         // non-virtual functions in this class
83 private:
84         // For conversions to Boolean, as would be used in an if conditional,
85         // implicit conversions from bool to int have a large number of
86         // undesirable side effects.  The following safe_bool type enables
87         // use of relational objects in conditionals without those side effects
88         struct safe_bool_helper {
89                 void nonnull() {};
90         };
91
92         typedef void (safe_bool_helper::*safe_bool)();
93         
94         safe_bool make_safe_bool(bool) const;
95
96 public:
97         operator safe_bool() const;
98         safe_bool operator!() const;
99
100 // member variables
101         
102 protected:
103         ex lh;
104         ex rh;
105         operators o;
106 };
107 GINAC_DECLARE_UNARCHIVER(relational); 
108
109 // utility functions
110
111 // inlined functions for efficiency
112 inline relational::safe_bool relational::operator!() const
113 {
114         return make_safe_bool(!static_cast<bool>(*this));
115 }
116
117 } // namespace GiNaC
118
119 #endif // ndef GINAC_RELATIONAL_H