moved some common code to the 'tensor' class
[ginac.git] / ginac / tensor.cpp
1 /** @file tensor.cpp
2  *
3  *  Implementation of GiNaC's special tensors. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2002 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 <iostream>
24 #include <stdexcept>
25 #include <vector>
26
27 #include "tensor.h"
28 #include "idx.h"
29 #include "indexed.h"
30 #include "symmetry.h"
31 #include "relational.h"
32 #include "lst.h"
33 #include "numeric.h"
34 #include "matrix.h"
35 #include "print.h"
36 #include "archive.h"
37 #include "utils.h"
38
39 namespace GiNaC {
40
41 GINAC_IMPLEMENT_REGISTERED_CLASS(tensor, basic)
42 GINAC_IMPLEMENT_REGISTERED_CLASS(tensdelta, tensor)
43 GINAC_IMPLEMENT_REGISTERED_CLASS(tensmetric, tensor)
44 GINAC_IMPLEMENT_REGISTERED_CLASS(minkmetric, tensmetric)
45 GINAC_IMPLEMENT_REGISTERED_CLASS(spinmetric, tensmetric)
46 GINAC_IMPLEMENT_REGISTERED_CLASS(tensepsilon, tensor)
47
48 //////////
49 // default ctor, dtor, copy ctor, assignment operator and helpers
50 //////////
51
52 DEFAULT_CTORS(tensor)
53 DEFAULT_CTORS(tensdelta)
54 DEFAULT_CTORS(tensmetric)
55 DEFAULT_COPY(spinmetric)
56 DEFAULT_DESTROY(spinmetric)
57 DEFAULT_DESTROY(minkmetric)
58 DEFAULT_DESTROY(tensepsilon)
59
60 minkmetric::minkmetric() : pos_sig(false)
61 {
62         tinfo_key = TINFO_minkmetric;
63 }
64
65 spinmetric::spinmetric()
66 {
67         tinfo_key = TINFO_spinmetric;
68 }
69
70 minkmetric::minkmetric(bool ps) : pos_sig(ps)
71 {
72         tinfo_key = TINFO_minkmetric;
73 }
74
75 void minkmetric::copy(const minkmetric & other)
76 {
77         inherited::copy(other);
78         pos_sig = other.pos_sig;
79 }
80
81 tensepsilon::tensepsilon() : minkowski(false), pos_sig(false)
82 {
83         tinfo_key = TINFO_tensepsilon;
84 }
85
86 tensepsilon::tensepsilon(bool mink, bool ps) : minkowski(mink), pos_sig(ps)
87 {
88         tinfo_key = TINFO_tensepsilon;
89 }
90
91 void tensepsilon::copy(const tensepsilon & other)
92 {
93         inherited::copy(other);
94         minkowski = other.minkowski;
95         pos_sig = other.pos_sig;
96 }
97
98 //////////
99 // archiving
100 //////////
101
102 DEFAULT_ARCHIVING(tensor)
103 DEFAULT_ARCHIVING(tensdelta)
104 DEFAULT_ARCHIVING(tensmetric)
105 DEFAULT_ARCHIVING(spinmetric)
106 DEFAULT_UNARCHIVE(minkmetric)
107 DEFAULT_UNARCHIVE(tensepsilon)
108
109 minkmetric::minkmetric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
110 {
111         n.find_bool("pos_sig", pos_sig);
112 }
113
114 void minkmetric::archive(archive_node &n) const
115 {
116         inherited::archive(n);
117         n.add_bool("pos_sig", pos_sig);
118 }
119
120 tensepsilon::tensepsilon(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
121 {
122         n.find_bool("minkowski", minkowski);
123         n.find_bool("pos_sig", pos_sig);
124 }
125
126 void tensepsilon::archive(archive_node &n) const
127 {
128         inherited::archive(n);
129         n.add_bool("minkowski", minkowski);
130         n.add_bool("pos_sig", pos_sig);
131 }
132
133 //////////
134 // functions overriding virtual functions from base classes
135 //////////
136
137 DEFAULT_COMPARE(tensor)
138 DEFAULT_COMPARE(tensdelta)
139 DEFAULT_COMPARE(tensmetric)
140 DEFAULT_COMPARE(spinmetric)
141
142 int minkmetric::compare_same_type(const basic & other) const
143 {
144         GINAC_ASSERT(is_a<minkmetric>(other));
145         const minkmetric &o = static_cast<const minkmetric &>(other);
146
147         if (pos_sig != o.pos_sig)
148                 return pos_sig ? -1 : 1;
149         else
150                 return inherited::compare_same_type(other);
151 }
152
153 int tensepsilon::compare_same_type(const basic & other) const
154 {
155         GINAC_ASSERT(is_a<tensepsilon>(other));
156         const tensepsilon &o = static_cast<const tensepsilon &>(other);
157
158         if (minkowski != o.minkowski)
159                 return minkowski ? -1 : 1;
160         else if (pos_sig != o.pos_sig)
161                 return pos_sig ? -1 : 1;
162         else
163                 return inherited::compare_same_type(other);
164 }
165
166 DEFAULT_PRINT_LATEX(tensdelta, "delta", "\\delta")
167 DEFAULT_PRINT(tensmetric, "g")
168 DEFAULT_PRINT_LATEX(minkmetric, "eta", "\\eta")
169 DEFAULT_PRINT_LATEX(spinmetric, "eps", "\\varepsilon")
170 DEFAULT_PRINT_LATEX(tensepsilon, "eps", "\\varepsilon")
171
172 /** Automatic symbolic evaluation of an indexed delta tensor. */
173 ex tensdelta::eval_indexed(const basic & i) const
174 {
175         GINAC_ASSERT(is_a<indexed>(i));
176         GINAC_ASSERT(i.nops() == 3);
177         GINAC_ASSERT(is_a<tensdelta>(i.op(0)));
178
179         const idx & i1 = ex_to<idx>(i.op(1));
180         const idx & i2 = ex_to<idx>(i.op(2));
181
182         // Trace of delta tensor is the dimension of the space
183         if (is_dummy_pair(i1, i2))
184                 return i1.get_dim();
185
186         // Numeric evaluation
187         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::integer)) {
188                 int n1 = ex_to<numeric>(i1.get_value()).to_int(), n2 = ex_to<numeric>(i2.get_value()).to_int();
189                 if (n1 == n2)
190                         return _ex1;
191                 else
192                         return _ex0;
193         }
194
195         // No further simplifications
196         return i.hold();
197 }
198
199 /** Automatic symbolic evaluation of an indexed metric tensor. */
200 ex tensmetric::eval_indexed(const basic & i) const
201 {
202         GINAC_ASSERT(is_a<indexed>(i));
203         GINAC_ASSERT(i.nops() == 3);
204         GINAC_ASSERT(is_a<tensmetric>(i.op(0)));
205         GINAC_ASSERT(is_a<varidx>(i.op(1)));
206         GINAC_ASSERT(is_a<varidx>(i.op(2)));
207
208         const varidx & i1 = ex_to<varidx>(i.op(1));
209         const varidx & i2 = ex_to<varidx>(i.op(2));
210
211         // A metric tensor with one covariant and one contravariant index gets
212         // replaced by a delta tensor
213         if (i1.is_covariant() != i2.is_covariant())
214                 return delta_tensor(i1, i2);
215
216         // No further simplifications
217         return i.hold();
218 }
219
220 /** Automatic symbolic evaluation of an indexed Lorentz metric tensor. */
221 ex minkmetric::eval_indexed(const basic & i) const
222 {
223         GINAC_ASSERT(is_a<indexed>(i));
224         GINAC_ASSERT(i.nops() == 3);
225         GINAC_ASSERT(is_a<minkmetric>(i.op(0)));
226         GINAC_ASSERT(is_a<varidx>(i.op(1)));
227         GINAC_ASSERT(is_a<varidx>(i.op(2)));
228
229         const varidx & i1 = ex_to<varidx>(i.op(1));
230         const varidx & i2 = ex_to<varidx>(i.op(2));
231
232         // Numeric evaluation
233         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint)) {
234                 int n1 = ex_to<numeric>(i1.get_value()).to_int(), n2 = ex_to<numeric>(i2.get_value()).to_int();
235                 if (n1 != n2)
236                         return _ex0;
237                 else if (n1 == 0)
238                         return pos_sig ? _ex_1 : _ex1;
239                 else
240                         return pos_sig ? _ex1 : _ex_1;
241         }
242
243         // Perform the usual evaluations of a metric tensor
244         return inherited::eval_indexed(i);
245 }
246
247 /** Automatic symbolic evaluation of an indexed metric tensor. */
248 ex spinmetric::eval_indexed(const basic & i) const
249 {
250         GINAC_ASSERT(is_a<indexed>(i));
251         GINAC_ASSERT(i.nops() == 3);
252         GINAC_ASSERT(is_a<spinmetric>(i.op(0)));
253         GINAC_ASSERT(is_a<spinidx>(i.op(1)));
254         GINAC_ASSERT(is_a<spinidx>(i.op(2)));
255
256         const spinidx & i1 = ex_to<spinidx>(i.op(1));
257         const spinidx & i2 = ex_to<spinidx>(i.op(2));
258
259         // Convolutions are zero
260         if (!(static_cast<const indexed &>(i).get_dummy_indices().empty()))
261                 return _ex0;
262
263         // Numeric evaluation
264         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint)) {
265                 int n1 = ex_to<numeric>(i1.get_value()).to_int(), n2 = ex_to<numeric>(i2.get_value()).to_int();
266                 if (n1 == n2)
267                         return _ex0;
268                 else if (n1 < n2)
269                         return _ex1;
270                 else
271                         return _ex_1;
272         }
273
274         // No further simplifications
275         return i.hold();
276 }
277
278 /** Automatic symbolic evaluation of an indexed epsilon tensor. */
279 ex tensepsilon::eval_indexed(const basic & i) const
280 {
281         GINAC_ASSERT(is_a<indexed>(i));
282         GINAC_ASSERT(i.nops() > 1);
283         GINAC_ASSERT(is_a<tensepsilon>(i.op(0)));
284
285         // Convolutions are zero
286         if (!(static_cast<const indexed &>(i).get_dummy_indices().empty()))
287                 return _ex0;
288
289         // Numeric evaluation
290         if (static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint)) {
291
292                 // Get sign of index permutation (the indices should already be in
293                 // a canonic order but we can't assume what exactly that order is)
294                 std::vector<int> v;
295                 v.reserve(i.nops() - 1);
296                 for (unsigned j=1; j<i.nops(); j++)
297                         v.push_back(ex_to<numeric>(ex_to<idx>(i.op(j)).get_value()).to_int());
298                 int sign = permutation_sign(v.begin(), v.end());
299
300                 // In a Minkowski space, check for covariant indices
301                 if (minkowski) {
302                         for (unsigned j=1; j<i.nops(); j++) {
303                                 const ex & x = i.op(j);
304                                 if (!is_ex_of_type(x, varidx))
305                                         throw(std::runtime_error("indices of epsilon tensor in Minkowski space must be of type varidx"));
306                                 if (ex_to<varidx>(x).is_covariant())
307                                         if (ex_to<idx>(x).get_value().is_zero())
308                                                 sign = (pos_sig ? -sign : sign);
309                                         else
310                                                 sign = (pos_sig ? sign : -sign);
311                         }
312                 }
313
314                 return sign;
315         }
316
317         // No further simplifications
318         return i.hold();
319 }
320
321 bool tensor::replace_contr_index(exvector::iterator self, exvector::iterator other) const
322 {
323         // Try to contract the first index
324         const idx *self_idx = &ex_to<idx>(self->op(1));
325         const idx *free_idx = &ex_to<idx>(self->op(2));
326         bool first_index_tried = false;
327
328 again:
329         if (self_idx->is_symbolic()) {
330                 for (unsigned i=1; i<other->nops(); i++) {
331                         const idx &other_idx = ex_to<idx>(other->op(i));
332                         if (is_dummy_pair(*self_idx, other_idx)) {
333
334                                 // Contraction found, remove this tensor and substitute the
335                                 // index in the second object
336                                 *self = _ex1;
337                                 *other = other->subs(other_idx == *free_idx);
338                                 return true;
339                         }
340                 }
341         }
342
343         if (!first_index_tried) {
344
345                 // No contraction with the first index found, try the second index
346                 self_idx = &ex_to<idx>(self->op(2));
347                 free_idx = &ex_to<idx>(self->op(1));
348                 first_index_tried = true;
349                 goto again;
350         }
351
352         return false;
353 }
354
355 /** Contraction of an indexed delta tensor with something else. */
356 bool tensdelta::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
357 {
358         GINAC_ASSERT(is_a<indexed>(*self));
359         GINAC_ASSERT(is_a<indexed>(*other));
360         GINAC_ASSERT(self->nops() == 3);
361         GINAC_ASSERT(is_a<tensdelta>(self->op(0)));
362
363         // Replace the dummy index with this tensor's other index and remove
364         // the tensor (this is valid for contractions with all other tensors)
365         return replace_contr_index(self, other);
366 }
367
368 /** Contraction of an indexed metric tensor with something else. */
369 bool tensmetric::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
370 {
371         GINAC_ASSERT(is_a<indexed>(*self));
372         GINAC_ASSERT(is_a<indexed>(*other));
373         GINAC_ASSERT(self->nops() == 3);
374         GINAC_ASSERT(is_a<tensmetric>(self->op(0)));
375
376         // If contracting with the delta tensor, let the delta do it
377         // (don't raise/lower delta indices)
378         if (is_ex_of_type(other->op(0), tensdelta))
379                 return false;
380
381         // Replace the dummy index with this tensor's other index and remove
382         // the tensor (this is valid for contractions with all other tensors)
383         return replace_contr_index(self, other);
384 }
385
386 /** Contraction of an indexed spinor metric with something else. */
387 bool spinmetric::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
388 {
389         GINAC_ASSERT(is_a<indexed>(*self));
390         GINAC_ASSERT(is_a<indexed>(*other));
391         GINAC_ASSERT(self->nops() == 3);
392         GINAC_ASSERT(is_a<spinmetric>(self->op(0)));
393
394         // Contractions between spinor metrics
395         if (is_ex_of_type(other->op(0), spinmetric)) {
396                 const idx &self_i1 = ex_to<idx>(self->op(1));
397                 const idx &self_i2 = ex_to<idx>(self->op(2));
398                 const idx &other_i1 = ex_to<idx>(other->op(1));
399                 const idx &other_i2 = ex_to<idx>(other->op(2));
400
401                 if (is_dummy_pair(self_i1, other_i1)) {
402                         if (is_dummy_pair(self_i2, other_i2))
403                                 *self = _ex2;
404                         else
405                                 *self = delta_tensor(self_i2, other_i2);
406                         *other = _ex1;
407                         return true;
408                 } else if (is_dummy_pair(self_i1, other_i2)) {
409                         if (is_dummy_pair(self_i2, other_i1))
410                                 *self = _ex_2;
411                         else
412                                 *self = -delta_tensor(self_i2, other_i1);
413                         *other = _ex1;
414                         return true;
415                 } else if (is_dummy_pair(self_i2, other_i1)) {
416                         *self = -delta_tensor(self_i1, other_i2);
417                         *other = _ex1;
418                         return true;
419                 } else if (is_dummy_pair(self_i2, other_i2)) {
420                         *self = delta_tensor(self_i1, other_i1);
421                         *other = _ex1;
422                         return true;
423                 }
424         }
425
426         // If contracting with the delta tensor, let the delta do it
427         // (don't raise/lower delta indices)
428         if (is_ex_of_type(other->op(0), tensdelta))
429                 return false;
430
431         // Try to contract first index
432         const idx *self_idx = &ex_to<idx>(self->op(1));
433         const idx *free_idx = &ex_to<idx>(self->op(2));
434         bool first_index_tried = false;
435         int sign = 1;
436
437 again:
438         if (self_idx->is_symbolic()) {
439                 for (unsigned i=1; i<other->nops(); i++) {
440                         const idx &other_idx = ex_to<idx>(other->op(i));
441                         if (is_dummy_pair(*self_idx, other_idx)) {
442
443                                 // Contraction found, remove metric tensor and substitute
444                                 // index in second object
445                                 *self = (static_cast<const spinidx *>(self_idx)->is_covariant() ? sign : -sign);
446                                 *other = other->subs(other_idx == *free_idx);
447                                 return true;
448                         }
449                 }
450         }
451
452         if (!first_index_tried) {
453
454                 // No contraction with first index found, try second index
455                 self_idx = &ex_to<idx>(self->op(2));
456                 free_idx = &ex_to<idx>(self->op(1));
457                 first_index_tried = true;
458                 sign = -sign;
459                 goto again;
460         }
461
462         return false;
463 }
464
465 /** Contraction of epsilon tensor with something else. */
466 bool tensepsilon::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
467 {
468         GINAC_ASSERT(is_a<indexed>(*self));
469         GINAC_ASSERT(is_a<indexed>(*other));
470         GINAC_ASSERT(is_a<tensepsilon>(self->op(0)));
471         unsigned num = self->nops() - 1;
472
473         if (is_ex_exactly_of_type(other->op(0), tensepsilon) && num+1 == other->nops()) {
474
475                 // Contraction of two epsilon tensors is a determinant
476                 ex dim = ex_to<idx>(self->op(1)).get_dim();
477                 matrix M(num, num);
478                 for (int i=0; i<num; i++) {
479                         for (int j=0; j<num; j++) {
480                                 if (minkowski)
481                                         M(i, j) = lorentz_g(self->op(i+1), other->op(j+1), pos_sig);
482                                 else
483                                         M(i, j) = metric_tensor(self->op(i+1), other->op(j+1));
484                         }
485                 }
486                 int sign = minkowski ? -1 : 1;
487                 *self = sign * M.determinant().simplify_indexed();
488                 *other = _ex1;
489                 return true;
490         }
491
492         return false;
493 }
494
495 //////////
496 // global functions
497 //////////
498
499 ex delta_tensor(const ex & i1, const ex & i2)
500 {
501         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx))
502                 throw(std::invalid_argument("indices of delta tensor must be of type idx"));
503
504         return indexed(tensdelta(), sy_symm(), i1, i2);
505 }
506
507 ex metric_tensor(const ex & i1, const ex & i2)
508 {
509         if (!is_ex_of_type(i1, varidx) || !is_ex_of_type(i2, varidx))
510                 throw(std::invalid_argument("indices of metric tensor must be of type varidx"));
511         ex dim = ex_to<idx>(i1).get_dim();
512         if (!dim.is_equal(ex_to<idx>(i2).get_dim()))
513                 throw(std::invalid_argument("all indices of metric tensor must have the same dimension"));
514
515         return indexed(tensmetric(), sy_symm(), i1, i2);
516 }
517
518 ex lorentz_g(const ex & i1, const ex & i2, bool pos_sig)
519 {
520         if (!is_ex_of_type(i1, varidx) || !is_ex_of_type(i2, varidx))
521                 throw(std::invalid_argument("indices of metric tensor must be of type varidx"));
522         ex dim = ex_to<idx>(i1).get_dim();
523         if (!dim.is_equal(ex_to<idx>(i2).get_dim()))
524                 throw(std::invalid_argument("all indices of metric tensor must have the same dimension"));
525
526         return indexed(minkmetric(pos_sig), sy_symm(), i1, i2);
527 }
528
529 ex spinor_metric(const ex & i1, const ex & i2)
530 {
531         if (!is_ex_of_type(i1, spinidx) || !is_ex_of_type(i2, spinidx))
532                 throw(std::invalid_argument("indices of spinor metric must be of type spinidx"));
533         if (!ex_to<idx>(i1).get_dim().is_equal(2) || !ex_to<idx>(i2).get_dim().is_equal(2))
534                 throw(std::runtime_error("index dimension for spinor metric must be 2"));
535
536         return indexed(spinmetric(), sy_anti(), i1, i2);
537 }
538
539 ex epsilon_tensor(const ex & i1, const ex & i2)
540 {
541         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx))
542                 throw(std::invalid_argument("indices of epsilon tensor must be of type idx"));
543
544         ex dim = ex_to<idx>(i1).get_dim();
545         if (!dim.is_equal(ex_to<idx>(i2).get_dim()))
546                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
547         if (!ex_to<idx>(i1).get_dim().is_equal(_ex2))
548                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
549
550         return indexed(tensepsilon(), sy_anti(), i1, i2);
551 }
552
553 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3)
554 {
555         if (!is_ex_of_type(i1, idx) || !is_ex_of_type(i2, idx) || !is_ex_of_type(i3, idx))
556                 throw(std::invalid_argument("indices of epsilon tensor must be of type idx"));
557
558         ex dim = ex_to<idx>(i1).get_dim();
559         if (!dim.is_equal(ex_to<idx>(i2).get_dim()) || !dim.is_equal(ex_to<idx>(i3).get_dim()))
560                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
561         if (!ex_to<idx>(i1).get_dim().is_equal(_ex3))
562                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
563
564         return indexed(tensepsilon(), sy_anti(), i1, i2, i3);
565 }
566
567 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig)
568 {
569         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))
570                 throw(std::invalid_argument("indices of Lorentz epsilon tensor must be of type varidx"));
571
572         ex dim = ex_to<idx>(i1).get_dim();
573         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()))
574                 throw(std::invalid_argument("all indices of epsilon tensor must have the same dimension"));
575         if (!ex_to<idx>(i1).get_dim().is_equal(_ex4))
576                 throw(std::runtime_error("index dimension of epsilon tensor must match number of indices"));
577
578         return indexed(tensepsilon(true, pos_sig), sy_anti(), i1, i2, i3, i4);
579 }
580
581 ex eps0123(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig)
582 {
583         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))
584                 throw(std::invalid_argument("indices of epsilon tensor must be of type varidx"));
585
586         ex dim = ex_to<idx>(i1).get_dim();
587         if (dim.is_equal(4))
588                 return lorentz_eps(i1, i2, i3, i4, pos_sig);
589         else
590                 return indexed(tensepsilon(true, pos_sig), sy_anti(), i1, i2, i3, i4);
591 }
592
593 } // namespace GiNaC