subs() performs "syntactic substitution" as in Maple; you can substitute
[ginac.git] / ginac / tensor.cpp
1 /** @file tensor.cpp
2  *
3  *  Implementation of GiNaC's special tensors. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 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 #include <stdexcept>
24 #include <vector>
25
26 #include "tensor.h"
27 #include "idx.h"
28 #include "indexed.h"
29 #include "relational.h"
30 #include "lst.h"
31 #include "numeric.h"
32 #include "archive.h"
33 #include "utils.h"
34 #include "debugmsg.h"
35
36 namespace GiNaC {
37
38 GINAC_IMPLEMENT_REGISTERED_CLASS(tensor, basic)
39 GINAC_IMPLEMENT_REGISTERED_CLASS(tensdelta, tensor)
40 GINAC_IMPLEMENT_REGISTERED_CLASS(tensmetric, tensor)
41 GINAC_IMPLEMENT_REGISTERED_CLASS(minkmetric, tensmetric)
42 GINAC_IMPLEMENT_REGISTERED_CLASS(tensepsilon, tensor)
43
44 //////////
45 // default constructor, destructor, copy constructor assignment operator and helpers
46 //////////
47
48 tensor::tensor(unsigned ti) : inherited(ti)
49 {
50         debugmsg("tensor constructor from unsigned", LOGLEVEL_CONSTRUCT); \
51 }
52
53 DEFAULT_CTORS(tensor)
54 DEFAULT_CTORS(tensdelta)
55 DEFAULT_CTORS(tensmetric)
56 DEFAULT_DESTROY(minkmetric)
57 DEFAULT_DESTROY(tensepsilon)
58
59 minkmetric::minkmetric() : pos_sig(false)
60 {
61         debugmsg("minkmetric default constructor", LOGLEVEL_CONSTRUCT);
62         tinfo_key = TINFO_minkmetric;
63 }
64
65 minkmetric::minkmetric(bool ps) : pos_sig(ps)
66 {
67         debugmsg("minkmetric constructor from bool", LOGLEVEL_CONSTRUCT);
68         tinfo_key = TINFO_minkmetric;
69 }
70
71 void minkmetric::copy(const minkmetric & other)
72 {
73         inherited::copy(other);
74         pos_sig = other.pos_sig;
75 }
76
77 tensepsilon::tensepsilon() : minkowski(false), pos_sig(false)
78 {
79         debugmsg("tensepsilon default constructor", LOGLEVEL_CONSTRUCT);
80         tinfo_key = TINFO_tensepsilon;
81 }
82
83 tensepsilon::tensepsilon(bool mink, bool ps) : minkowski(mink), pos_sig(ps)
84 {
85         debugmsg("tensepsilon constructor from bool,bool", LOGLEVEL_CONSTRUCT);
86         tinfo_key = TINFO_tensepsilon;
87 }
88
89 void tensepsilon::copy(const tensepsilon & other)
90 {
91         inherited::copy(other);
92         minkowski = other.minkowski;
93         pos_sig = other.pos_sig;
94 }
95
96 //////////
97 // archiving
98 //////////
99
100 DEFAULT_ARCHIVING(tensor)
101 DEFAULT_ARCHIVING(tensdelta)
102 DEFAULT_ARCHIVING(tensmetric)
103 DEFAULT_UNARCHIVE(minkmetric)
104 DEFAULT_UNARCHIVE(tensepsilon)
105
106 minkmetric::minkmetric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
107 {
108         debugmsg("minkmetric constructor from archive_node", LOGLEVEL_CONSTRUCT);
109         n.find_bool("pos_sig", pos_sig);
110 }
111
112 void minkmetric::archive(archive_node &n) const
113 {
114         inherited::archive(n);
115         n.add_bool("pos_sig", pos_sig);
116 }
117
118 tensepsilon::tensepsilon(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
119 {
120         debugmsg("tensepsilon constructor from archive_node", LOGLEVEL_CONSTRUCT);
121         n.find_bool("minkowski", minkowski);
122         n.find_bool("pos_sig", pos_sig);
123 }
124
125 void tensepsilon::archive(archive_node &n) const
126 {
127         inherited::archive(n);
128         n.add_bool("minkowski", minkowski);
129         n.add_bool("pos_sig", pos_sig);
130 }
131
132 //////////
133 // functions overriding virtual functions from bases classes
134 //////////
135
136 DEFAULT_COMPARE(tensor)
137 DEFAULT_COMPARE(tensdelta)
138 DEFAULT_COMPARE(tensmetric)
139
140 int minkmetric::compare_same_type(const basic & other) const
141 {
142         GINAC_ASSERT(is_of_type(other, minkmetric));
143         const minkmetric &o = static_cast<const minkmetric &>(other);
144
145         if (pos_sig != o.pos_sig)
146                 return pos_sig ? -1 : 1;
147         else
148                 return inherited::compare_same_type(other);
149 }
150
151 int tensepsilon::compare_same_type(const basic & other) const
152 {
153         GINAC_ASSERT(is_of_type(other, tensepsilon));
154         const tensepsilon &o = static_cast<const tensepsilon &>(other);
155
156         if (minkowski != o.minkowski)
157                 return minkowski ? -1 : 1;
158         else if (pos_sig != o.pos_sig)
159                 return pos_sig ? -1 : 1;
160         else
161                 return inherited::compare_same_type(other);
162 }
163
164 DEFAULT_PRINT(tensdelta, "delta")
165 DEFAULT_PRINT(tensmetric, "g")
166 DEFAULT_PRINT(minkmetric, "eta")
167 DEFAULT_PRINT(tensepsilon, "eps")
168
169 /** Automatic symbolic evaluation of an indexed delta tensor. */
170 ex tensdelta::eval_indexed(const basic & i) const
171 {
172         GINAC_ASSERT(is_of_type(i, indexed));
173         GINAC_ASSERT(i.nops() == 3);
174         GINAC_ASSERT(is_ex_of_type(i.op(0), tensdelta));
175
176         const idx & i1 = ex_to_idx(i.op(1));
177         const idx & i2 = ex_to_idx(i.op(2));
178
179         // Trace of delta tensor is the dimension of the space
180         if (is_dummy_pair(i1, i2))
181                 return i1.get_dim();
182
183         // Numeric evaluation
184         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::integer)) {
185                 int n1 = ex_to_numeric(i1.get_value()).to_int(), n2 = ex_to_numeric(i2.get_value()).to_int();
186                 if (n1 == n2)
187                         return _ex1();
188                 else
189                         return _ex0();
190         }
191
192         // No further simplifications
193         return i.hold();
194 }
195
196 /** Automatic symbolic evaluation of an indexed metric tensor. */
197 ex tensmetric::eval_indexed(const basic & i) const
198 {
199         GINAC_ASSERT(is_of_type(i, indexed));
200         GINAC_ASSERT(i.nops() == 3);
201         GINAC_ASSERT(is_ex_of_type(i.op(0), tensmetric));
202         GINAC_ASSERT(is_ex_of_type(i.op(1), varidx));
203         GINAC_ASSERT(is_ex_of_type(i.op(2), varidx));
204
205         const varidx & i1 = ex_to_varidx(i.op(1));
206         const varidx & i2 = ex_to_varidx(i.op(2));
207
208         // A metric tensor with one covariant and one contravariant index gets
209         // replaced by a delta tensor
210         if (i1.is_covariant() != i2.is_covariant())
211                 return delta_tensor(i1, i2);
212
213         // No further simplifications
214         return i.hold();
215 }
216
217 /** Automatic symbolic evaluation of an indexed Lorentz metric tensor. */
218 ex minkmetric::eval_indexed(const basic & i) const
219 {
220         GINAC_ASSERT(is_of_type(i, indexed));
221         GINAC_ASSERT(i.nops() == 3);
222         GINAC_ASSERT(is_ex_of_type(i.op(0), minkmetric));
223         GINAC_ASSERT(is_ex_of_type(i.op(1), varidx));
224         GINAC_ASSERT(is_ex_of_type(i.op(2), varidx));
225
226         const varidx & i1 = ex_to_varidx(i.op(1));
227         const varidx & i2 = ex_to_varidx(i.op(2));
228
229         // Numeric evaluation
230         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint)) {
231                 int n1 = ex_to_numeric(i1.get_value()).to_int(), n2 = ex_to_numeric(i2.get_value()).to_int();
232                 if (n1 != n2)
233                         return _ex0();
234                 else if (n1 == 0)
235                         return pos_sig ? _ex_1() : _ex1();
236                 else
237                         return pos_sig ? _ex1() : _ex_1();
238         }
239
240         // Perform the usual evaluations of a metric tensor
241         return inherited::eval_indexed(i);
242 }
243
244 /** Automatic symbolic evaluation of an indexed epsilon tensor. */
245 ex tensepsilon::eval_indexed(const basic & i) const
246 {
247         GINAC_ASSERT(is_of_type(i, indexed));
248         GINAC_ASSERT(i.nops() > 1);
249         GINAC_ASSERT(is_ex_of_type(i.op(0), tensepsilon));
250
251         // Convolutions are zero
252         if (static_cast<const indexed &>(i).get_dummy_indices().size() != 0)
253                 return _ex0();
254
255         // Numeric evaluation
256         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint)) {
257
258                 // Get sign of index permutation (the indices should already be in
259                 // a canonic order but we can't assume what exactly that order is)
260                 std::vector<int> v;
261                 v.reserve(i.nops() - 1);
262                 for (unsigned j=1; j<i.nops(); j++)
263                         v.push_back(ex_to_numeric(ex_to_idx(i.op(j)).get_value()).to_int());
264                 int sign = permutation_sign(v);
265
266                 // In a Minkowski space, check for covariant indices
267                 if (minkowski) {
268                         for (unsigned j=1; j<i.nops(); j++) {
269                                 const ex & x = i.op(j);
270                                 if (!is_ex_of_type(x, varidx))
271                                         throw(std::runtime_error("indices of epsilon tensor in Minkowski space must be of type varidx"));
272                                 if (ex_to_varidx(x).is_covariant())
273                                         if (ex_to_idx(x).get_value().is_zero())
274                                                 sign = (pos_sig ? -sign : sign);
275                                         else
276                                                 sign = (pos_sig ? sign : -sign);
277                         }
278                 }
279
280                 return sign;
281         }
282
283         // No further simplifications
284         return i.hold();
285 }
286
287 /** Contraction of an indexed delta tensor with something else. */
288 bool tensdelta::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
289 {
290         GINAC_ASSERT(is_ex_of_type(*self, indexed));
291         GINAC_ASSERT(is_ex_of_type(*other, indexed));
292         GINAC_ASSERT(self->nops() == 3);
293         GINAC_ASSERT(is_ex_of_type(self->op(0), tensdelta));
294
295         // Try to contract first index
296         const idx *self_idx = &ex_to_idx(self->op(1));
297         const idx *free_idx = &ex_to_idx(self->op(2));
298         bool first_index_tried = false;
299
300 again:
301         if (self_idx->is_symbolic()) {
302                 for (int i=1; i<other->nops(); i++) {
303                         const idx &other_idx = ex_to_idx(other->op(i));
304                         if (is_dummy_pair(*self_idx, other_idx)) {
305
306                                 // Contraction found, remove delta tensor and substitute
307                                 // index in second object
308                                 *self = _ex1();
309                                 *other = other->subs(other_idx == *free_idx);
310                                 return true;
311                         }
312                 }
313         }
314
315         if (!first_index_tried) {
316
317                 // No contraction with first index found, try second index
318                 self_idx = &ex_to_idx(self->op(2));
319                 free_idx = &ex_to_idx(self->op(1));
320                 first_index_tried = true;
321                 goto again;
322         }
323
324         return false;
325 }
326
327 /** Contraction of an indexed metric tensor with something else. */
328 bool tensmetric::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
329 {
330         GINAC_ASSERT(is_ex_of_type(*self, indexed));
331         GINAC_ASSERT(is_ex_of_type(*other, indexed));
332         GINAC_ASSERT(self->nops() == 3);
333         GINAC_ASSERT(is_ex_of_type(self->op(0), tensmetric));
334
335         // If contracting with the delta tensor, let the delta do it
336         // (don't raise/lower delta indices)
337         if (is_ex_of_type(other->op(0), tensdelta))
338                 return false;
339
340         // Try to contract first index
341         const idx *self_idx = &ex_to_idx(self->op(1));
342         const idx *free_idx = &ex_to_idx(self->op(2));
343         bool first_index_tried = false;
344
345 again:
346         if (self_idx->is_symbolic()) {
347                 for (int i=1; i<other->nops(); i++) {
348                         const idx &other_idx = ex_to_idx(other->op(i));
349                         if (is_dummy_pair(*self_idx, other_idx)) {
350
351                                 // Contraction found, remove metric tensor and substitute
352                                 // index in second object
353                                 *self = _ex1();
354                                 *other = other->subs(other_idx == *free_idx);
355                                 return true;
356                         }
357                 }
358         }
359
360         if (!first_index_tried) {
361
362                 // No contraction with first index found, try second index
363                 self_idx = &ex_to_idx(self->op(2));
364                 free_idx = &ex_to_idx(self->op(1));
365                 first_index_tried = true;
366                 goto again;
367         }
368
369         return false;
370 }
371
372 //////////
373 // global functions
374 //////////
375
376 ex delta_tensor(const ex & i1, const ex & i2)
377 {
378         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx))
379                 throw(std::invalid_argument("indices of delta tensor must be of type idx"));
380
381         return indexed(tensdelta(), indexed::symmetric, i1, i2);
382 }
383
384 ex metric_tensor(const ex & i1, const ex & i2)
385 {
386         if (!is_ex_of_type(i1, varidx) || !is_ex_of_type(i2, varidx))
387                 throw(std::invalid_argument("indices of metric tensor must be of type varidx"));
388
389         return indexed(tensmetric(), indexed::symmetric, i1, i2);
390 }
391
392 ex lorentz_g(const ex & i1, const ex & i2, bool pos_sig)
393 {
394         if (!is_ex_of_type(i1, varidx) || !is_ex_of_type(i2, varidx))
395                 throw(std::invalid_argument("indices of metric tensor must be of type varidx"));
396
397         return indexed(minkmetric(pos_sig), indexed::symmetric, i1, i2);
398 }
399
400 ex epsilon_tensor(const ex & i1, const ex & i2)
401 {
402         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx))
403                 throw(std::invalid_argument("indices of epsilon tensor must be of type idx"));
404
405         ex dim = ex_to_idx(i1).get_dim();
406         if (!dim.is_equal(ex_to_idx(i2).get_dim()))
407                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
408         if (!ex_to_idx(i1).get_dim().is_equal(_ex2()))
409                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
410
411         return indexed(tensepsilon(), indexed::antisymmetric, i1, i2);
412 }
413
414 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3)
415 {
416         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx) || !is_ex_of_type(i3, idx))
417                 throw(std::invalid_argument("indices of epsilon tensor must be of type idx"));
418
419         ex dim = ex_to_idx(i1).get_dim();
420         if (!dim.is_equal(ex_to_idx(i2).get_dim()) || !dim.is_equal(ex_to_idx(i3).get_dim()))
421                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
422         if (!ex_to_idx(i1).get_dim().is_equal(_ex3()))
423                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
424
425         return indexed(tensepsilon(), indexed::antisymmetric, i1, i2, i3);
426 }
427
428 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig)
429 {
430         if (!is_ex_of_type(i1, varidx) || !is_ex_of_type(i2, varidx) || !is_ex_of_type(i3, varidx) || !is_ex_of_type(i4, varidx))
431                 throw(std::invalid_argument("indices of Lorentz epsilon tensor must be of type varidx"));
432
433         ex dim = ex_to_idx(i1).get_dim();
434         if (!dim.is_equal(ex_to_idx(i2).get_dim()) || !dim.is_equal(ex_to_idx(i3).get_dim()) || !dim.is_equal(ex_to_idx(i4).get_dim()))
435                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
436         if (!ex_to_idx(i1).get_dim().is_equal(_ex4()))
437                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
438
439         return indexed(tensepsilon(true, pos_sig), indexed::antisymmetric, i1, i2, i3, i4);
440 }
441
442 } // namespace GiNaC