Prettified source code.
[ginac.git] / ginac / structure.h
1 /** @file structure.h
2  *
3  *  Wrapper template for making GiNaC classes out of C++ structures. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2009 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_STRUCTURE_H
24 #define GINAC_STRUCTURE_H
25
26 #include "ex.h"
27 #include "ncmul.h"
28 #include "numeric.h"
29 #include "operators.h"
30 #include "print.h"
31
32 #include <functional>
33
34 namespace GiNaC {
35
36 /** Comparison policy: all structures of one type are equal */
37 template <class T>
38 class compare_all_equal {
39 protected:
40         static bool struct_is_equal(const T * t1, const T * t2) { return true; }
41         static int struct_compare(const T * t1, const T * t2) { return 0; }
42
43         // disallow destruction of structure through a compare_all_equal*
44 protected:
45         ~compare_all_equal() {}
46 };
47
48
49 /** Comparison policy: use std::equal_to/std::less (defaults to operators
50  *  == and <) to compare structures. */
51 template <class T>
52 class compare_std_less {
53 protected:
54         static bool struct_is_equal(const T * t1, const T * t2)
55         {
56                 return std::equal_to<T>()(*t1, *t2);
57         }
58
59         static int struct_compare(const T * t1, const T * t2)
60         {
61                 if (std::less<T>()(*t1, *t2))
62                         return -1;
63                 else if (std::less<T>()(*t2, *t1))
64                         return 1;
65                 else
66                         return 0;
67         }
68
69         // disallow destruction of structure through a compare_std_less*
70 protected:
71         ~compare_std_less() {}
72 };
73
74
75 /** Comparison policy: use bit-wise comparison to compare structures. */
76 template <class T>
77 class compare_bitwise {
78 protected:
79         static bool struct_is_equal(const T * t1, const T * t2)
80         {
81                 const char * cp1 = reinterpret_cast<const char *>(t1);
82                 const char * cp2 = reinterpret_cast<const char *>(t2);
83
84                 return std::equal(cp1, cp1 + sizeof(T), cp2);
85         }
86
87         static int struct_compare(const T * t1, const T * t2)
88         {
89                 const unsigned char * cp1 = reinterpret_cast<const unsigned char *>(t1);
90                 const unsigned char * cp2 = reinterpret_cast<const unsigned char *>(t2);
91                 typedef std::pair<const unsigned char *, const unsigned char *> cppair;
92
93                 cppair res = std::mismatch(cp1, cp1 + sizeof(T), cp2);
94
95                 if (res.first == cp1 + sizeof(T))
96                         return 0;
97                 else if (*res.first < *res.second)
98                         return -1;
99                 else
100                         return 1;
101         }
102
103         // disallow destruction of structure through a compare_bitwise*
104 protected:
105         ~compare_bitwise() {}
106 };
107
108
109 // Select default comparison policy
110 template <class T, template <class> class ComparisonPolicy = compare_all_equal> class structure;
111
112
113 /** Wrapper template for making GiNaC classes out of C++ structures. */
114 template <class T, template <class> class ComparisonPolicy>
115 class structure : public basic, public ComparisonPolicy<T> {
116         GINAC_DECLARE_REGISTERED_CLASS(structure, basic)
117
118         // helpers
119         static const char *get_class_name() { return "structure"; }
120         // constructors
121 public:
122         /** Construct structure as a copy of a given C++ structure. */
123         structure(const T & t) : obj(t) { }
124
125         // functions overriding virtual functions from base classes
126         // All these are just defaults that can be specialized by the user
127 public:
128         // evaluation
129         ex eval(int level = 0) const { return hold(); }
130         ex evalf(int level = 0) const { return inherited::evalf(level); }
131         ex evalm() const { return inherited::evalm(); }
132 protected:
133         ex eval_ncmul(const exvector & v) const { return hold_ncmul(v); }
134 public:
135         ex eval_indexed(const basic & i) const { return i.hold(); }
136
137         // printing
138         void print(const print_context & c, unsigned level = 0) const { inherited::print(c, level); }
139         unsigned precedence() const { return 70; }
140
141         // info
142         bool info(unsigned inf) const { return false; }
143
144         // operand access
145         size_t nops() const { return 0; }
146         ex op(size_t i) const { return inherited::op(i); }
147         ex operator[](const ex & index) const { return inherited::operator[](index); }
148         ex operator[](size_t i) const { return inherited::operator[](i); }
149         ex & let_op(size_t i) { return inherited::let_op(i); }
150         ex & operator[](const ex & index) { return inherited::operator[](index); }
151         ex & operator[](size_t i) { return inherited::operator[](i); }
152
153         // pattern matching
154         bool has(const ex & other, unsigned options = 0) const { return inherited::has(other, options); }
155         bool match(const ex & pattern, exmap& repl_lst) const { return inherited::match(pattern, repl_lst); }
156 protected:
157         bool match_same_type(const basic & other) const { return true; }
158 public:
159
160         // substitutions
161         ex subs(const exmap & m, unsigned options = 0) const { return inherited::subs(m, options); }
162
163         // function mapping
164         ex map(map_function & f) const { return inherited::map(f); }
165
166         // degree/coeff
167         int degree(const ex & s) const { return inherited::degree(s); }
168         int ldegree(const ex & s) const { return inherited::ldegree(s); }
169         ex coeff(const ex & s, int n = 1) const { return inherited::coeff(s, n); }
170
171         // expand/collect
172         ex expand(unsigned options = 0) const { return inherited::expand(options); }
173         ex collect(const ex & s, bool distributed = false) const { return inherited::collect(s, distributed); }
174
175         // differentiation and series expansion
176 protected:
177         ex derivative(const symbol & s) const { return inherited::derivative(s); }
178 public:
179         ex series(const relational & r, int order, unsigned options = 0) const { return inherited::series(r, order, options); }
180
181         // rational functions
182         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const { return inherited::normal(repl, rev_lookup, level); }
183         ex to_rational(exmap & repl) const { return inherited::to_rational(repl); }
184         ex to_polynomial(exmap & repl) const { return inherited::to_polynomial(repl); }
185
186         // polynomial algorithms
187         numeric integer_content() const { return 1; }
188         ex smod(const numeric & xi) const { return *this; }
189         numeric max_coefficient() const { return 1; }
190
191         // indexed objects
192         exvector get_free_indices() const { return exvector(); }
193         ex add_indexed(const ex & self, const ex & other) const { return self + other; }
194         ex scalar_mul_indexed(const ex & self, const numeric & other) const { return self * ex(other); }
195         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const { return false; }
196
197         // noncommutativity
198         unsigned return_type() const { return return_types::commutative; }
199         return_type_t return_type_tinfo() const 
200         {
201                 return_type_t r;
202                 r.rl = 0;
203                 r.tinfo = &typeid(*this);
204                 return r;
205         }
206
207 protected:
208         bool is_equal_same_type(const basic & other) const
209         {
210                 GINAC_ASSERT(is_a<structure>(other));
211                 const structure & o = static_cast<const structure &>(other);
212
213                 return struct_is_equal(&obj, &o.obj);
214         }
215
216         unsigned calchash() const { return inherited::calchash(); }
217
218         // non-virtual functions in this class
219 public:
220         // access to embedded structure
221         const T *operator->() const { return &obj; }
222         T &get_struct() { return obj; }
223         const T &get_struct() const { return obj; }
224 private:
225         T obj;
226 };
227
228
229 /** Default constructor */
230 template <class T, template <class> class CP>
231 structure<T, CP>::structure() { }
232
233 /** Compare two structures of the same type. */
234 template <class T, template <class> class CP>
235 int structure<T, CP>::compare_same_type(const basic & other) const
236 {
237         GINAC_ASSERT(is_a<structure>(other));
238         const structure & o = static_cast<const structure &>(other);
239
240         return struct_compare(&obj, &o.obj);
241 }
242
243 template <class T, template <class> class CP>
244 registered_class_info structure<T, CP>::reg_info = registered_class_info(registered_class_options(structure::get_class_name(), "basic", typeid(structure<T, CP>)));
245
246 } // namespace GiNaC
247
248 #endif // ndef GINAC_STRUCTURE_H