1ca6089336c71d3517df247c2b1a678c37172767
[ginac.git] / ginac / relational.h
1 /** @file relational.h
2  *
3  *  Interface to relations between expressions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_RELATIONAL_H__
24 #define __GINAC_RELATIONAL_H__
25
26 #include "basic.h"
27 #include "ex.h"
28
29 #ifndef NO_NAMESPACE_GINAC
30 namespace GiNaC {
31 #endif // ndef NO_NAMESPACE_GINAC
32
33 /** This class holds a relation consisting of two expressions and a logical
34  *  relation between them. */
35 class relational : public basic
36 {
37     GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
38
39 // types
40 public:
41     enum operators { equal,
42            not_equal,
43            less,
44            less_or_equal,
45            greater,
46            greater_or_equal
47     };
48     
49 // member functions
50
51     // default constructor, destructor, copy constructor assignment operator and helpers
52 public:
53     relational();
54     ~relational();
55     relational(const relational & other);
56     const relational & operator=(const relational & other);
57 protected:
58     void copy(const relational & other);
59     void destroy(bool call_parent);
60
61     // other constructors
62 public:
63     relational(const ex & lhs, const ex & rhs, operators oper=equal);
64     
65     // functions overriding virtual functions from bases classes
66 public:
67     basic * duplicate() const;
68     void print(ostream & os, unsigned upper_precedence=0) const;
69     void printraw(ostream & os) const;
70     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
71     bool info(unsigned inf) const;
72     unsigned nops() const;
73     ex & let_op(int i);
74     ex eval(int level=0) const;
75     ex evalf(int level=0) const;
76     ex simplify_ncmul(const exvector & v) const;
77 protected:
78     int compare_same_type(const basic & other) const;
79     unsigned return_type(void) const;
80     unsigned return_type_tinfo(void) const;
81
82     // new virtual functions which can be overridden by derived classes
83 public:
84     virtual ex lhs(void) const;
85     virtual ex rhs(void) const;
86
87     // non-virtual functions in this class
88 public:
89     operator bool(void) const;
90     
91 // member variables
92     
93 protected:
94     ex lh;
95     ex rh;
96     operators o;
97     static unsigned precedence;
98 };
99
100 // global constants
101
102 extern const relational some_relational;
103 extern const type_info & typeid_relational;
104
105 // utility functions
106 inline const relational &ex_to_relational(const ex &e)
107 {
108         return static_cast<const relational &>(*e.bp);
109 }
110
111 #ifndef NO_NAMESPACE_GINAC
112 } // namespace GiNaC
113 #endif // ndef NO_NAMESPACE_GINAC
114
115 #endif // ndef __GINAC_RELATIONAL_H__