Make .eval() evaluate top-level only.
[ginac.git] / ginac / indexed.cpp
1 /** @file indexed.cpp
2  *
3  *  Implementation of GiNaC's indexed expressions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2015 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 #include "indexed.h"
24 #include "idx.h"
25 #include "add.h"
26 #include "mul.h"
27 #include "ncmul.h"
28 #include "power.h"
29 #include "relational.h"
30 #include "symmetry.h"
31 #include "operators.h"
32 #include "lst.h"
33 #include "archive.h"
34 #include "symbol.h"
35 #include "utils.h"
36 #include "integral.h"
37 #include "matrix.h"
38 #include "inifcns.h"
39
40 #include <iostream>
41 #include <limits>
42 #include <sstream>
43 #include <stdexcept>
44
45 namespace GiNaC {
46
47 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(indexed, exprseq,
48   print_func<print_context>(&indexed::do_print).
49   print_func<print_latex>(&indexed::do_print_latex).
50   print_func<print_tree>(&indexed::do_print_tree))
51
52 //////////
53 // default constructor
54 //////////
55
56 indexed::indexed() : symtree(not_symmetric())
57 {
58 }
59
60 //////////
61 // other constructors
62 //////////
63
64 indexed::indexed(const ex & b) : inherited{b}, symtree(not_symmetric())
65 {
66         validate();
67 }
68
69 indexed::indexed(const ex & b, const ex & i1) : inherited{b, i1}, symtree(not_symmetric())
70 {
71         validate();
72 }
73
74 indexed::indexed(const ex & b, const ex & i1, const ex & i2) : inherited{b, i1, i2}, symtree(not_symmetric())
75 {
76         validate();
77 }
78
79 indexed::indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3) : inherited{b, i1, i2, i3}, symtree(not_symmetric())
80 {
81         validate();
82 }
83
84 indexed::indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4) : inherited{b, i1, i2, i3, i4}, symtree(not_symmetric())
85 {
86         validate();
87 }
88
89 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2) : inherited{b, i1, i2}, symtree(symm)
90 {
91         validate();
92 }
93
94 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3) : inherited{b, i1, i2, i3}, symtree(symm)
95 {
96         validate();
97 }
98
99 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4) : inherited{b, i1, i2, i3, i4}, symtree(symm)
100 {
101         validate();
102 }
103
104 indexed::indexed(const ex & b, const exvector & v) : inherited{b}, symtree(not_symmetric())
105 {
106         seq.insert(seq.end(), v.begin(), v.end());
107         validate();
108 }
109
110 indexed::indexed(const ex & b, const symmetry & symm, const exvector & v) : inherited{b}, symtree(symm)
111 {
112         seq.insert(seq.end(), v.begin(), v.end());
113         validate();
114 }
115
116 indexed::indexed(const symmetry & symm, const exprseq & es) : inherited(es), symtree(symm)
117 {
118 }
119
120 indexed::indexed(const symmetry & symm, const exvector & v) : inherited(v), symtree(symm)
121 {
122 }
123
124 indexed::indexed(const symmetry & symm, exvector && v) : inherited(std::move(v)), symtree(symm)
125 {
126 }
127
128 //////////
129 // archiving
130 //////////
131
132 void indexed::read_archive(const archive_node &n, lst &sym_lst)
133 {
134         inherited::read_archive(n, sym_lst);
135         if (!n.find_ex("symmetry", symtree, sym_lst)) {
136                 // GiNaC versions <= 0.9.0 had an unsigned "symmetry" property
137                 unsigned symm = 0;
138                 n.find_unsigned("symmetry", symm);
139                 switch (symm) {
140                         case 1:
141                                 symtree = sy_symm();
142                                 break;
143                         case 2:
144                                 symtree = sy_anti();
145                                 break;
146                         default:
147                                 symtree = not_symmetric();
148                                 break;
149                 }
150                 const_cast<symmetry &>(ex_to<symmetry>(symtree)).validate(seq.size() - 1);
151         }
152 }
153 GINAC_BIND_UNARCHIVER(indexed);
154
155 void indexed::archive(archive_node &n) const
156 {
157         inherited::archive(n);
158         n.add_ex("symmetry", symtree);
159 }
160
161 //////////
162 // functions overriding virtual functions from base classes
163 //////////
164
165 void indexed::printindices(const print_context & c, unsigned level) const
166 {
167         if (seq.size() > 1) {
168
169                 auto it = seq.begin() + 1, itend = seq.end();
170
171                 if (is_a<print_latex>(c)) {
172
173                         // TeX output: group by variance
174                         bool first = true;
175                         bool covariant = true;
176
177                         while (it != itend) {
178                                 bool cur_covariant = (is_a<varidx>(*it) ? ex_to<varidx>(*it).is_covariant() : true);
179                                 if (first || cur_covariant != covariant) { // Variance changed
180                                         // The empty {} prevents indices from ending up on top of each other
181                                         if (!first)
182                                                 c.s << "}{}";
183                                         covariant = cur_covariant;
184                                         if (covariant)
185                                                 c.s << "_{";
186                                         else
187                                                 c.s << "^{";
188                                 }
189                                 it->print(c, level);
190                                 c.s << " ";
191                                 first = false;
192                                 it++;
193                         }
194                         c.s << "}";
195
196                 } else {
197
198                         // Ordinary output
199                         while (it != itend) {
200                                 it->print(c, level);
201                                 it++;
202                         }
203                 }
204         }
205 }
206
207 void indexed::print_indexed(const print_context & c, const char *openbrace, const char *closebrace, unsigned level) const
208 {
209         if (precedence() <= level)
210                 c.s << openbrace << '(';
211         c.s << openbrace;
212         seq[0].print(c, precedence());
213         c.s << closebrace;
214         printindices(c, level);
215         if (precedence() <= level)
216                 c.s << ')' << closebrace;
217 }
218
219 void indexed::do_print(const print_context & c, unsigned level) const
220 {
221         print_indexed(c, "", "", level);
222 }
223
224 void indexed::do_print_latex(const print_latex & c, unsigned level) const
225 {
226         print_indexed(c, "{", "}", level);
227 }
228
229 void indexed::do_print_tree(const print_tree & c, unsigned level) const
230 {
231         c.s << std::string(level, ' ') << class_name() << " @" << this
232             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
233             << ", " << seq.size()-1 << " indices"
234             << ", symmetry=" << symtree << std::endl;
235         seq[0].print(c, level + c.delta_indent);
236         printindices(c, level + c.delta_indent);
237 }
238
239 bool indexed::info(unsigned inf) const
240 {
241         if (inf == info_flags::indexed) return true;
242         if (inf == info_flags::has_indices) return seq.size() > 1;
243         return inherited::info(inf);
244 }
245
246 bool indexed::all_index_values_are(unsigned inf) const
247 {
248         // No indices? Then no property can be fulfilled
249         if (seq.size() < 2)
250                 return false;
251
252         // Check all indices
253         return find_if(seq.begin() + 1, seq.end(),
254                        [inf](const ex & e) { return !(ex_to<idx>(e).get_value().info(inf)); }) == seq.end();
255 }
256
257 int indexed::compare_same_type(const basic & other) const
258 {
259         GINAC_ASSERT(is_a<indexed>(other));
260         return inherited::compare_same_type(other);
261 }
262
263 ex indexed::eval() const
264 {
265         const ex &base = seq[0];
266
267         // If the base object is 0, the whole object is 0
268         if (base.is_zero())
269                 return _ex0;
270
271         // If the base object is a product, pull out the numeric factor
272         if (is_exactly_a<mul>(base) && is_exactly_a<numeric>(base.op(base.nops() - 1))) {
273                 exvector v(seq);
274                 ex f = ex_to<numeric>(base.op(base.nops() - 1));
275                 v[0] = seq[0] / f;
276                 return f * thiscontainer(v);
277         }
278
279         if((typeid(*this) == typeid(indexed)) && seq.size()==1)
280                 return base;
281
282         // Canonicalize indices according to the symmetry properties
283         if (seq.size() > 2) {
284                 exvector v = seq;
285                 GINAC_ASSERT(is_exactly_a<symmetry>(symtree));
286                 int sig = canonicalize(v.begin() + 1, ex_to<symmetry>(symtree));
287                 if (sig != std::numeric_limits<int>::max()) {
288                         // Something has changed while sorting indices, more evaluations later
289                         if (sig == 0)
290                                 return _ex0;
291                         return ex(sig) * thiscontainer(v);
292                 }
293         }
294
295         // Let the class of the base object perform additional evaluations
296         return ex_to<basic>(base).eval_indexed(*this);
297 }
298
299 ex indexed::real_part() const
300 {
301         if(op(0).info(info_flags::real))
302                 return *this;
303         return real_part_function(*this).hold();
304 }
305
306 ex indexed::imag_part() const
307 {
308         if(op(0).info(info_flags::real))
309                 return 0;
310         return imag_part_function(*this).hold();
311 }
312
313 ex indexed::thiscontainer(const exvector & v) const
314 {
315         return indexed(ex_to<symmetry>(symtree), v);
316 }
317
318 ex indexed::thiscontainer(exvector && v) const
319 {
320         return indexed(ex_to<symmetry>(symtree), std::move(v));
321 }
322
323 unsigned indexed::return_type() const
324 {
325         if(is_a<matrix>(op(0)))
326                 return return_types::commutative;
327         else
328                 return op(0).return_type();
329 }
330
331 ex indexed::expand(unsigned options) const
332 {
333         GINAC_ASSERT(seq.size() > 0);
334
335         if (options & expand_options::expand_indexed) {
336                 ex newbase = seq[0].expand(options);
337                 if (is_exactly_a<add>(newbase)) {
338                         ex sum = _ex0;
339                         for (size_t i=0; i<newbase.nops(); i++) {
340                                 exvector s = seq;
341                                 s[0] = newbase.op(i);
342                                 sum += thiscontainer(s).expand(options);
343                         }
344                         return sum;
345                 }
346                 if (!are_ex_trivially_equal(newbase, seq[0])) {
347                         exvector s = seq;
348                         s[0] = newbase;
349                         return ex_to<indexed>(thiscontainer(s)).inherited::expand(options);
350                 }
351         }
352         return inherited::expand(options);
353 }
354
355 //////////
356 // virtual functions which can be overridden by derived classes
357 //////////
358
359 // none
360
361 //////////
362 // non-virtual functions in this class
363 //////////
364
365 /** Check whether all indices are of class idx and validate the symmetry
366  *  tree. This function is used internally to make sure that all constructed
367  *  indexed objects really carry indices and not some other classes. */
368 void indexed::validate() const
369 {
370         GINAC_ASSERT(seq.size() > 0);
371         auto it = seq.begin() + 1, itend = seq.end();
372         while (it != itend) {
373                 if (!is_a<idx>(*it))
374                         throw(std::invalid_argument("indices of indexed object must be of type idx"));
375                 it++;
376         }
377
378         if (!symtree.is_zero()) {
379                 if (!is_exactly_a<symmetry>(symtree))
380                         throw(std::invalid_argument("symmetry of indexed object must be of type symmetry"));
381                 const_cast<symmetry &>(ex_to<symmetry>(symtree)).validate(seq.size() - 1);
382         }
383 }
384
385 /** Implementation of ex::diff() for an indexed object always returns 0.
386  *
387  *  @see ex::diff */
388 ex indexed::derivative(const symbol & s) const
389 {
390         return _ex0;
391 }
392
393 //////////
394 // global functions
395 //////////
396
397 struct idx_is_equal_ignore_dim : public std::binary_function<ex, ex, bool> {
398         bool operator() (const ex &lh, const ex &rh) const
399         {
400                 if (lh.is_equal(rh))
401                         return true;
402                 else
403                         try {
404                                 // Replacing the dimension might cause an error (e.g. with
405                                 // index classes that only work in a fixed number of dimensions)
406                                 return lh.is_equal(ex_to<idx>(rh).replace_dim(ex_to<idx>(lh).get_dim()));
407                         } catch (...) {
408                                 return false;
409                         }
410         }
411 };
412
413 /** Check whether two sorted index vectors are consistent (i.e. equal). */
414 static bool indices_consistent(const exvector & v1, const exvector & v2)
415 {
416         // Number of indices must be the same
417         if (v1.size() != v2.size())
418                 return false;
419
420         return equal(v1.begin(), v1.end(), v2.begin(), idx_is_equal_ignore_dim());
421 }
422
423 exvector indexed::get_indices() const
424 {
425         GINAC_ASSERT(seq.size() >= 1);
426         return exvector(seq.begin() + 1, seq.end());
427 }
428
429 exvector indexed::get_dummy_indices() const
430 {
431         exvector free_indices, dummy_indices;
432         find_free_and_dummy(seq.begin() + 1, seq.end(), free_indices, dummy_indices);
433         return dummy_indices;
434 }
435
436 exvector indexed::get_dummy_indices(const indexed & other) const
437 {
438         exvector indices = get_free_indices();
439         exvector other_indices = other.get_free_indices();
440         indices.insert(indices.end(), other_indices.begin(), other_indices.end());
441         exvector dummy_indices;
442         find_dummy_indices(indices, dummy_indices);
443         return dummy_indices;
444 }
445
446 bool indexed::has_dummy_index_for(const ex & i) const
447 {
448         auto it = seq.begin() + 1, itend = seq.end();
449         while (it != itend) {
450                 if (is_dummy_pair(*it, i))
451                         return true;
452                 it++;
453         }
454         return false;
455 }
456
457 exvector indexed::get_free_indices() const
458 {
459         exvector free_indices, dummy_indices;
460         find_free_and_dummy(seq.begin() + 1, seq.end(), free_indices, dummy_indices);
461         return free_indices;
462 }
463
464 exvector add::get_free_indices() const
465 {
466         exvector free_indices;
467         for (size_t i=0; i<nops(); i++) {
468                 if (i == 0)
469                         free_indices = op(i).get_free_indices();
470                 else {
471                         exvector free_indices_of_term = op(i).get_free_indices();
472                         if (!indices_consistent(free_indices, free_indices_of_term))
473                                 throw (std::runtime_error("add::get_free_indices: inconsistent indices in sum"));
474                 }
475         }
476         return free_indices;
477 }
478
479 exvector mul::get_free_indices() const
480 {
481         // Concatenate free indices of all factors
482         exvector un;
483         for (size_t i=0; i<nops(); i++) {
484                 exvector free_indices_of_factor = op(i).get_free_indices();
485                 un.insert(un.end(), free_indices_of_factor.begin(), free_indices_of_factor.end());
486         }
487
488         // And remove the dummy indices
489         exvector free_indices, dummy_indices;
490         find_free_and_dummy(un, free_indices, dummy_indices);
491         return free_indices;
492 }
493
494 exvector ncmul::get_free_indices() const
495 {
496         // Concatenate free indices of all factors
497         exvector un;
498         for (size_t i=0; i<nops(); i++) {
499                 exvector free_indices_of_factor = op(i).get_free_indices();
500                 un.insert(un.end(), free_indices_of_factor.begin(), free_indices_of_factor.end());
501         }
502
503         // And remove the dummy indices
504         exvector free_indices, dummy_indices;
505         find_free_and_dummy(un, free_indices, dummy_indices);
506         return free_indices;
507 }
508
509 struct is_summation_idx : public std::unary_function<ex, bool> {
510         bool operator()(const ex & e)
511         {
512                 return is_dummy_pair(e, e);
513         }
514 };
515
516 exvector integral::get_free_indices() const
517 {
518         if (a.get_free_indices().size() || b.get_free_indices().size())
519                 throw (std::runtime_error("integral::get_free_indices: boundary values should not have free indices"));
520         return f.get_free_indices();
521 }
522
523 template<class T> size_t number_of_type(const exvector&v)
524 {
525         size_t number = 0;
526         for (auto & it : v)
527                 if (is_exactly_a<T>(it))
528                         ++number;
529         return number;
530 }
531
532 /** Rename dummy indices in an expression.
533  *
534  *  @param e Expression to work on
535  *  @param local_dummy_indices The set of dummy indices that appear in the
536  *    expression "e"
537  *  @param global_dummy_indices The set of dummy indices that have appeared
538  *    before and which we would like to use in "e", too. This gets updated
539  *    by the function */
540 template<class T> static ex rename_dummy_indices(const ex & e, exvector & global_dummy_indices, exvector & local_dummy_indices)
541 {
542         size_t global_size = number_of_type<T>(global_dummy_indices),
543                local_size = number_of_type<T>(local_dummy_indices);
544
545         // Any local dummy indices at all?
546         if (local_size == 0)
547                 return e;
548
549         if (global_size < local_size) {
550
551                 // More local indices than we encountered before, add the new ones
552                 // to the global set
553                 size_t old_global_size = global_size;
554                 int remaining = local_size - global_size;
555                 auto it = local_dummy_indices.begin(), itend = local_dummy_indices.end();
556                 while (it != itend && remaining > 0) {
557                         if (is_exactly_a<T>(*it) && find_if(global_dummy_indices.begin(), global_dummy_indices.end(), bind2nd(idx_is_equal_ignore_dim(), *it)) == global_dummy_indices.end()) {
558                                 global_dummy_indices.push_back(*it);
559                                 global_size++;
560                                 remaining--;
561                         }
562                         it++;
563                 }
564
565                 // If this is the first set of local indices, do nothing
566                 if (old_global_size == 0)
567                         return e;
568         }
569         GINAC_ASSERT(local_size <= global_size);
570
571         // Construct vectors of index symbols
572         exvector local_syms, global_syms;
573         local_syms.reserve(local_size);
574         global_syms.reserve(local_size);
575         for (size_t i=0; local_syms.size()!=local_size; i++)
576                 if(is_exactly_a<T>(local_dummy_indices[i]))
577                         local_syms.push_back(local_dummy_indices[i].op(0));
578         shaker_sort(local_syms.begin(), local_syms.end(), ex_is_less(), ex_swap());
579         for (size_t i=0; global_syms.size()!=local_size; i++) // don't use more global symbols than necessary
580                 if(is_exactly_a<T>(global_dummy_indices[i]))
581                         global_syms.push_back(global_dummy_indices[i].op(0));
582         shaker_sort(global_syms.begin(), global_syms.end(), ex_is_less(), ex_swap());
583
584         // Remove common indices
585         exvector local_uniq, global_uniq;
586         set_difference(local_syms.begin(), local_syms.end(), global_syms.begin(), global_syms.end(), std::back_insert_iterator<exvector>(local_uniq), ex_is_less());
587         set_difference(global_syms.begin(), global_syms.end(), local_syms.begin(), local_syms.end(), std::back_insert_iterator<exvector>(global_uniq), ex_is_less());
588
589         // Replace remaining non-common local index symbols by global ones
590         if (local_uniq.empty())
591                 return e;
592         else {
593                 while (global_uniq.size() > local_uniq.size())
594                         global_uniq.pop_back();
595                 return e.subs(lst(local_uniq.begin(), local_uniq.end()), lst(global_uniq.begin(), global_uniq.end()), subs_options::no_pattern);
596         }
597 }
598
599 /** Given a set of indices, extract those of class varidx. */
600 static void find_variant_indices(const exvector & v, exvector & variant_indices)
601 {
602         exvector::const_iterator it1, itend;
603         for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
604                 if (is_exactly_a<varidx>(*it1))
605                         variant_indices.push_back(*it1);
606         }
607 }
608
609 /** Raise/lower dummy indices in a single indexed objects to canonicalize their
610  *  variance.
611  *
612  *  @param e Object to work on
613  *  @param variant_dummy_indices The set of indices that might need repositioning (will be changed by this function)
614  *  @param moved_indices The set of indices that have been repositioned (will be changed by this function)
615  *  @return true if 'e' was changed */
616 bool reposition_dummy_indices(ex & e, exvector & variant_dummy_indices, exvector & moved_indices)
617 {
618         bool something_changed = false;
619
620         // Find dummy symbols that occur twice in the same indexed object.
621         exvector local_var_dummies;
622         local_var_dummies.reserve(e.nops()/2);
623         for (size_t i=1; i<e.nops(); ++i) {
624                 if (!is_a<varidx>(e.op(i)))
625                         continue;
626                 for (size_t j=i+1; j<e.nops(); ++j) {
627                         if (is_dummy_pair(e.op(i), e.op(j))) {
628                                 local_var_dummies.push_back(e.op(i));
629                                 for (auto k = variant_dummy_indices.begin(); k!=variant_dummy_indices.end(); ++k) {
630                                         if (e.op(i).op(0) == k->op(0)) {
631                                                 variant_dummy_indices.erase(k);
632                                                 break;
633                                         }
634                                 }
635                                 break;
636                         }
637                 }
638         }
639
640         // In the case where a dummy symbol occurs twice in the same indexed object
641         // we try all possibilities of raising/lowering and keep the least one in
642         // the sense of ex_is_less.
643         ex optimal_e = e;
644         size_t numpossibs = 1 << local_var_dummies.size();
645         for (size_t i=0; i<numpossibs; ++i) {
646                 ex try_e = e;
647                 for (size_t j=0; j<local_var_dummies.size(); ++j) {
648                         exmap m;
649                         if (1<<j & i) {
650                                 ex curr_idx = local_var_dummies[j];
651                                 ex curr_toggle = ex_to<varidx>(curr_idx).toggle_variance();
652                                 m[curr_idx] = curr_toggle;
653                                 m[curr_toggle] = curr_idx;
654                         }
655                         try_e = e.subs(m, subs_options::no_pattern);
656                 }
657                 if(ex_is_less()(try_e, optimal_e))
658                 {       optimal_e = try_e;
659                         something_changed = true;
660                 }
661         }
662         e = optimal_e;
663
664         if (!is_a<indexed>(e))
665                 return true;
666
667         exvector seq = ex_to<indexed>(e).seq;
668
669         // If a dummy index is encountered for the first time in the
670         // product, pull it up, otherwise, pull it down
671         for (auto it2 = seq.begin()+1, it2end = seq.end(); it2 != it2end; ++it2) {
672                 if (!is_exactly_a<varidx>(*it2))
673                         continue;
674
675                 exvector::iterator vit, vitend;
676                 for (vit = variant_dummy_indices.begin(), vitend = variant_dummy_indices.end(); vit != vitend; ++vit) {
677                         if (it2->op(0).is_equal(vit->op(0))) {
678                                 if (ex_to<varidx>(*it2).is_covariant()) {
679                                         /*
680                                          * N.B. we don't want to use
681                                          *
682                                          *  e = e.subs(lst{
683                                          *  *it2 == ex_to<varidx>(*it2).toggle_variance(),
684                                          *  ex_to<varidx>(*it2).toggle_variance() == *it2
685                                          *  }, subs_options::no_pattern);
686                                          *
687                                          * since this can trigger non-trivial repositioning of indices,
688                                          * e.g. due to non-trivial symmetry properties of e, thus
689                                          * invalidating iterators
690                                          */
691                                         *it2 = ex_to<varidx>(*it2).toggle_variance();
692                                         something_changed = true;
693                                 }
694                                 moved_indices.push_back(*vit);
695                                 variant_dummy_indices.erase(vit);
696                                 goto next_index;
697                         }
698                 }
699
700                 for (vit = moved_indices.begin(), vitend = moved_indices.end(); vit != vitend; ++vit) {
701                         if (it2->op(0).is_equal(vit->op(0))) {
702                                 if (ex_to<varidx>(*it2).is_contravariant()) {
703                                         *it2 = ex_to<varidx>(*it2).toggle_variance();
704                                         something_changed = true;
705                                 }
706                                 goto next_index;
707                         }
708                 }
709
710 next_index: ;
711         }
712
713         if (something_changed)
714                 e = ex_to<indexed>(e).thiscontainer(seq);
715
716         return something_changed;
717 }
718
719 /* Ordering that only compares the base expressions of indexed objects. */
720 struct ex_base_is_less : public std::binary_function<ex, ex, bool> {
721         bool operator() (const ex &lh, const ex &rh) const
722         {
723                 return (is_a<indexed>(lh) ? lh.op(0) : lh).compare(is_a<indexed>(rh) ? rh.op(0) : rh) < 0;
724         }
725 };
726
727 /* An auxiliary function used by simplify_indexed() and expand_dummy_sum() 
728  * It returns an exvector of factors from the supplied product */
729 static void product_to_exvector(const ex & e, exvector & v, bool & non_commutative)
730 {
731         // Remember whether the product was commutative or noncommutative
732         // (because we chop it into factors and need to reassemble later)
733         non_commutative = is_exactly_a<ncmul>(e);
734
735         // Collect factors in an exvector, store squares twice
736         v.reserve(e.nops() * 2);
737
738         if (is_exactly_a<power>(e)) {
739                 // We only get called for simple squares, split a^2 -> a*a
740                 GINAC_ASSERT(e.op(1).is_equal(_ex2));
741                 v.push_back(e.op(0));
742                 v.push_back(e.op(0));
743         } else {
744                 for (size_t i=0; i<e.nops(); i++) {
745                         ex f = e.op(i);
746                         if (is_exactly_a<power>(f) && f.op(1).is_equal(_ex2)) {
747                                 v.push_back(f.op(0));
748                                 v.push_back(f.op(0));
749                         } else if (is_exactly_a<ncmul>(f)) {
750                                 // Noncommutative factor found, split it as well
751                                 non_commutative = true; // everything becomes noncommutative, ncmul will sort out the commutative factors later
752                                 for (size_t j=0; j<f.nops(); j++)
753                                         v.push_back(f.op(j));
754                         } else
755                                 v.push_back(f);
756                 }
757         }
758 }
759
760 template<class T> ex idx_symmetrization(const ex& r,const exvector& local_dummy_indices)
761 {       exvector dummy_syms;
762         dummy_syms.reserve(r.nops());
763         for (auto & it : local_dummy_indices)
764                         if(is_exactly_a<T>(it))
765                                 dummy_syms.push_back(it.op(0));
766         if(dummy_syms.size() < 2)
767                 return r;
768         ex q=symmetrize(r, dummy_syms);
769         return q;
770 }
771
772 // Forward declaration needed in absence of friend injection, C.f. [namespace.memdef]:
773 ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp);
774
775 /** Simplify product of indexed expressions (commutative, noncommutative and
776  *  simple squares), return list of free indices. */
777 ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp)
778 {
779         // Collect factors in an exvector
780         exvector v;
781
782         // Remember whether the product was commutative or noncommutative
783         // (because we chop it into factors and need to reassemble later)
784         bool non_commutative;
785         product_to_exvector(e, v, non_commutative);
786
787         // Perform contractions
788         bool something_changed = false;
789         bool has_nonsymmetric = false;
790         GINAC_ASSERT(v.size() > 1);
791         exvector::iterator it1, itend = v.end(), next_to_last = itend - 1;
792         for (it1 = v.begin(); it1 != next_to_last; it1++) {
793
794 try_again:
795                 if (!is_a<indexed>(*it1))
796                         continue;
797
798                 bool first_noncommutative = (it1->return_type() != return_types::commutative);
799                 bool first_nonsymmetric = ex_to<symmetry>(ex_to<indexed>(*it1).get_symmetry()).has_nonsymmetric();
800
801                 // Indexed factor found, get free indices and look for contraction
802                 // candidates
803                 exvector free1, dummy1;
804                 find_free_and_dummy(ex_to<indexed>(*it1).seq.begin() + 1, ex_to<indexed>(*it1).seq.end(), free1, dummy1);
805
806                 exvector::iterator it2;
807                 for (it2 = it1 + 1; it2 != itend; it2++) {
808
809                         if (!is_a<indexed>(*it2))
810                                 continue;
811
812                         bool second_noncommutative = (it2->return_type() != return_types::commutative);
813
814                         // Find free indices of second factor and merge them with free
815                         // indices of first factor
816                         exvector un;
817                         find_free_and_dummy(ex_to<indexed>(*it2).seq.begin() + 1, ex_to<indexed>(*it2).seq.end(), un, dummy1);
818                         un.insert(un.end(), free1.begin(), free1.end());
819
820                         // Check whether the two factors share dummy indices
821                         exvector free, dummy;
822                         find_free_and_dummy(un, free, dummy);
823                         size_t num_dummies = dummy.size();
824                         if (num_dummies == 0)
825                                 continue;
826
827                         // At least one dummy index, is it a defined scalar product?
828                         bool contracted = false;
829                         if (free.empty() && it1->nops()==2 && it2->nops()==2) {
830
831                                 ex dim = minimal_dim(
832                                         ex_to<idx>(it1->op(1)).get_dim(),
833                                         ex_to<idx>(it2->op(1)).get_dim()
834                                 );
835
836                                 // User-defined scalar product?
837                                 if (sp.is_defined(*it1, *it2, dim)) {
838
839                                         // Yes, substitute it
840                                         *it1 = sp.evaluate(*it1, *it2, dim);
841                                         *it2 = _ex1;
842                                         goto contraction_done;
843                                 }
844                         }
845
846                         // Try to contract the first one with the second one
847                         contracted = ex_to<basic>(it1->op(0)).contract_with(it1, it2, v);
848                         if (!contracted) {
849
850                                 // That didn't work; maybe the second object knows how to
851                                 // contract itself with the first one
852                                 contracted = ex_to<basic>(it2->op(0)).contract_with(it2, it1, v);
853                         }
854                         if (contracted) {
855 contraction_done:
856                                 if (first_noncommutative || second_noncommutative
857                                  || is_exactly_a<add>(*it1) || is_exactly_a<add>(*it2)
858                                  || is_exactly_a<mul>(*it1) || is_exactly_a<mul>(*it2)
859                                  || is_exactly_a<ncmul>(*it1) || is_exactly_a<ncmul>(*it2)) {
860
861                                         // One of the factors became a sum or product:
862                                         // re-expand expression and run again
863                                         // Non-commutative products are always re-expanded to give
864                                         // eval_ncmul() the chance to re-order and canonicalize
865                                         // the product
866                                         bool is_a_product = (is_exactly_a<mul>(*it1) || is_exactly_a<ncmul>(*it1)) &&
867                                                             (is_exactly_a<mul>(*it2) || is_exactly_a<ncmul>(*it2));
868                                         ex r = (non_commutative ? ex(ncmul(std::move(v))) : ex(mul(std::move(v))));
869
870                                         // If new expression is a product we can call this function again,
871                                         // otherwise we need to pass argument to simplify_indexed() to be expanded
872                                         if (is_a_product)
873                                                 return simplify_indexed_product(r, free_indices, dummy_indices, sp);
874                                         else
875                                                 return simplify_indexed(r, free_indices, dummy_indices, sp);
876                                 }
877
878                                 // Both objects may have new indices now or they might
879                                 // even not be indexed objects any more, so we have to
880                                 // start over
881                                 something_changed = true;
882                                 goto try_again;
883                         }
884                         else if (!has_nonsymmetric &&
885                                         (first_nonsymmetric ||
886                                          ex_to<symmetry>(ex_to<indexed>(*it2).get_symmetry()).has_nonsymmetric())) {
887                                 has_nonsymmetric = true;
888                         }
889                 }
890         }
891
892         // Find free indices (concatenate them all and call find_free_and_dummy())
893         // and all dummy indices that appear
894         exvector un, individual_dummy_indices;
895         for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
896                 exvector free_indices_of_factor;
897                 if (is_a<indexed>(*it1)) {
898                         exvector dummy_indices_of_factor;
899                         find_free_and_dummy(ex_to<indexed>(*it1).seq.begin() + 1, ex_to<indexed>(*it1).seq.end(), free_indices_of_factor, dummy_indices_of_factor);
900                         individual_dummy_indices.insert(individual_dummy_indices.end(), dummy_indices_of_factor.begin(), dummy_indices_of_factor.end());
901                 } else
902                         free_indices_of_factor = it1->get_free_indices();
903                 un.insert(un.end(), free_indices_of_factor.begin(), free_indices_of_factor.end());
904         }
905         exvector local_dummy_indices;
906         find_free_and_dummy(un, free_indices, local_dummy_indices);
907         local_dummy_indices.insert(local_dummy_indices.end(), individual_dummy_indices.begin(), individual_dummy_indices.end());
908
909         // Filter out the dummy indices with variance
910         exvector variant_dummy_indices;
911         find_variant_indices(local_dummy_indices, variant_dummy_indices);
912
913         // Any indices with variance present at all?
914         if (!variant_dummy_indices.empty()) {
915
916                 // Yes, bring the product into a canonical order that only depends on
917                 // the base expressions of indexed objects
918                 if (!non_commutative)
919                         std::sort(v.begin(), v.end(), ex_base_is_less());
920
921                 exvector moved_indices;
922
923                 // Iterate over all indexed objects in the product
924                 for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
925                         if (!is_a<indexed>(*it1))
926                                 continue;
927
928                         if (reposition_dummy_indices(*it1, variant_dummy_indices, moved_indices))
929                                 something_changed = true;
930                 }
931         }
932
933         ex r;
934         if (something_changed)
935                 r = non_commutative ? ex(ncmul(std::move(v))) : ex(mul(std::move(v)));
936         else
937                 r = e;
938
939         // The result should be symmetric with respect to exchange of dummy
940         // indices, so if the symmetrization vanishes, the whole expression is
941         // zero. This detects things like eps.i.j.k * p.j * p.k = 0.
942         if (has_nonsymmetric) {
943                 ex q = idx_symmetrization<idx>(r, local_dummy_indices);
944                 if (q.is_zero()) {
945                         free_indices.clear();
946                         return _ex0;
947                 }
948                 q = idx_symmetrization<varidx>(q, local_dummy_indices);
949                 if (q.is_zero()) {
950                         free_indices.clear();
951                         return _ex0;
952                 }
953                 q = idx_symmetrization<spinidx>(q, local_dummy_indices);
954                 if (q.is_zero()) {
955                         free_indices.clear();
956                         return _ex0;
957                 }
958         }
959
960         // Dummy index renaming
961         r = rename_dummy_indices<idx>(r, dummy_indices, local_dummy_indices);
962         r = rename_dummy_indices<varidx>(r, dummy_indices, local_dummy_indices);
963         r = rename_dummy_indices<spinidx>(r, dummy_indices, local_dummy_indices);
964
965         // Product of indexed object with a scalar?
966         if (is_exactly_a<mul>(r) && r.nops() == 2
967          && is_exactly_a<numeric>(r.op(1)) && is_a<indexed>(r.op(0)))
968                 return ex_to<basic>(r.op(0).op(0)).scalar_mul_indexed(r.op(0), ex_to<numeric>(r.op(1)));
969         else
970                 return r;
971 }
972
973 /** This structure stores the original and symmetrized versions of terms
974  *  obtained during the simplification of sums. */
975 class terminfo {
976 public:
977         terminfo(const ex & orig_, const ex & symm_) : orig(orig_), symm(symm_) {}
978
979         ex orig; /**< original term */
980         ex symm; /**< symmetrized term */
981 };
982
983 class terminfo_is_less {
984 public:
985         bool operator() (const terminfo & ti1, const terminfo & ti2) const
986         {
987                 return (ti1.symm.compare(ti2.symm) < 0);
988         }
989 };
990
991 /** This structure stores the individual symmetrized terms obtained during
992  *  the simplification of sums. */
993 class symminfo {
994 public:
995         symminfo() : num(0) {}
996
997         symminfo(const ex & symmterm_, const ex & orig_, size_t num_) : orig(orig_), num(num_)
998         {
999                 if (is_exactly_a<mul>(symmterm_) && is_exactly_a<numeric>(symmterm_.op(symmterm_.nops()-1))) {
1000                         coeff = symmterm_.op(symmterm_.nops()-1);
1001                         symmterm = symmterm_ / coeff;
1002                 } else {
1003                         coeff = 1;
1004                         symmterm = symmterm_;
1005                 }
1006         }
1007
1008         ex symmterm;  /**< symmetrized term */
1009         ex coeff;     /**< coefficient of symmetrized term */
1010         ex orig;      /**< original term */
1011         size_t num; /**< how many symmetrized terms resulted from the original term */
1012 };
1013
1014 class symminfo_is_less_by_symmterm {
1015 public:
1016         bool operator() (const symminfo & si1, const symminfo & si2) const
1017         {
1018                 return (si1.symmterm.compare(si2.symmterm) < 0);
1019         }
1020 };
1021
1022 class symminfo_is_less_by_orig {
1023 public:
1024         bool operator() (const symminfo & si1, const symminfo & si2) const
1025         {
1026                 return (si1.orig.compare(si2.orig) < 0);
1027         }
1028 };
1029
1030 bool hasindex(const ex &x, const ex &sym)
1031 {       
1032         if(is_a<idx>(x) && x.op(0)==sym)
1033                 return true;
1034         else
1035                 for(size_t i=0; i<x.nops(); ++i)
1036                         if(hasindex(x.op(i), sym))
1037                                 return true;
1038         return false;
1039 }
1040
1041 /** Simplify indexed expression, return list of free indices. */
1042 ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp)
1043 {
1044         // Expand the expression
1045         ex e_expanded = e.expand();
1046
1047         // Simplification of single indexed object: just find the free indices
1048         // and perform dummy index renaming/repositioning
1049         if (is_a<indexed>(e_expanded)) {
1050
1051                 // Find the dummy indices
1052                 const indexed &i = ex_to<indexed>(e_expanded);
1053                 exvector local_dummy_indices;
1054                 find_free_and_dummy(i.seq.begin() + 1, i.seq.end(), free_indices, local_dummy_indices);
1055
1056                 // Filter out the dummy indices with variance
1057                 exvector variant_dummy_indices;
1058                 find_variant_indices(local_dummy_indices, variant_dummy_indices);
1059
1060                 // Any indices with variance present at all?
1061                 if (!variant_dummy_indices.empty()) {
1062
1063                         // Yes, reposition them
1064                         exvector moved_indices;
1065                         reposition_dummy_indices(e_expanded, variant_dummy_indices, moved_indices);
1066                 }
1067
1068                 // Rename the dummy indices
1069                 e_expanded = rename_dummy_indices<idx>(e_expanded, dummy_indices, local_dummy_indices);
1070                 e_expanded = rename_dummy_indices<varidx>(e_expanded, dummy_indices, local_dummy_indices);
1071                 e_expanded = rename_dummy_indices<spinidx>(e_expanded, dummy_indices, local_dummy_indices);
1072                 return e_expanded;
1073         }
1074
1075         // Simplification of sum = sum of simplifications, check consistency of
1076         // free indices in each term
1077         if (is_exactly_a<add>(e_expanded)) {
1078                 bool first = true;
1079                 ex sum;
1080                 free_indices.clear();
1081
1082                 for (size_t i=0; i<e_expanded.nops(); i++) {
1083                         exvector free_indices_of_term;
1084                         ex term = simplify_indexed(e_expanded.op(i), free_indices_of_term, dummy_indices, sp);
1085                         if (!term.is_zero()) {
1086                                 if (first) {
1087                                         free_indices = free_indices_of_term;
1088                                         sum = term;
1089                                         first = false;
1090                                 } else {
1091                                         if (!indices_consistent(free_indices, free_indices_of_term)) {
1092                                                 std::ostringstream s;
1093                                                 s << "simplify_indexed: inconsistent indices in sum: ";
1094                                                 s << exprseq(free_indices) << " vs. " << exprseq(free_indices_of_term);
1095                                                 throw (std::runtime_error(s.str()));
1096                                         }
1097                                         if (is_a<indexed>(sum) && is_a<indexed>(term))
1098                                                 sum = ex_to<basic>(sum.op(0)).add_indexed(sum, term);
1099                                         else
1100                                                 sum += term;
1101                                 }
1102                         }
1103                 }
1104
1105                 // If the sum turns out to be zero, we are finished
1106                 if (sum.is_zero()) {
1107                         free_indices.clear();
1108                         return sum;
1109                 }
1110
1111                 // More than one term and more than one dummy index?
1112                 size_t num_terms_orig = (is_exactly_a<add>(sum) ? sum.nops() : 1);
1113                 if (num_terms_orig < 2 || dummy_indices.size() < 2)
1114                         return sum;
1115
1116                 // Chop the sum into terms and symmetrize each one over the dummy
1117                 // indices
1118                 std::vector<terminfo> terms;
1119                 for (size_t i=0; i<sum.nops(); i++) {
1120                         const ex & term = sum.op(i);
1121                         exvector dummy_indices_of_term;
1122                         dummy_indices_of_term.reserve(dummy_indices.size());
1123                         for (auto & i : dummy_indices)
1124                                 if (hasindex(term,i.op(0)))
1125                                         dummy_indices_of_term.push_back(i);
1126                         ex term_symm = idx_symmetrization<idx>(term, dummy_indices_of_term);
1127                         term_symm = idx_symmetrization<varidx>(term_symm, dummy_indices_of_term);
1128                         term_symm = idx_symmetrization<spinidx>(term_symm, dummy_indices_of_term);
1129                         if (term_symm.is_zero())
1130                                 continue;
1131                         terms.push_back(terminfo(term, term_symm));
1132                 }
1133
1134                 // Sort by symmetrized terms
1135                 std::sort(terms.begin(), terms.end(), terminfo_is_less());
1136
1137                 // Combine equal symmetrized terms
1138                 std::vector<terminfo> terms_pass2;
1139                 for (std::vector<terminfo>::const_iterator i=terms.begin(); i!=terms.end(); ) {
1140                         size_t num = 1;
1141                         auto j = i + 1;
1142                         while (j != terms.end() && j->symm == i->symm) {
1143                                 num++;
1144                                 j++;
1145                         }
1146                         terms_pass2.push_back(terminfo(i->orig * num, i->symm * num));
1147                         i = j;
1148                 }
1149
1150                 // If there is only one term left, we are finished
1151                 if (terms_pass2.size() == 1)
1152                         return terms_pass2[0].orig;
1153
1154                 // Chop the symmetrized terms into subterms
1155                 std::vector<symminfo> sy;
1156                 for (auto & i : terms_pass2) {
1157                         if (is_exactly_a<add>(i.symm)) {
1158                                 size_t num = i.symm.nops();
1159                                 for (size_t j=0; j<num; j++)
1160                                         sy.push_back(symminfo(i.symm.op(j), i.orig, num));
1161                         } else
1162                                 sy.push_back(symminfo(i.symm, i.orig, 1));
1163                 }
1164
1165                 // Sort by symmetrized subterms
1166                 std::sort(sy.begin(), sy.end(), symminfo_is_less_by_symmterm());
1167
1168                 // Combine equal symmetrized subterms
1169                 std::vector<symminfo> sy_pass2;
1170                 exvector result;
1171                 for (auto i=sy.begin(); i!=sy.end(); ) {
1172
1173                         // Combine equal terms
1174                         auto j = i + 1;
1175                         if (j != sy.end() && j->symmterm == i->symmterm) {
1176
1177                                 // More than one term, collect the coefficients
1178                                 ex coeff = i->coeff;
1179                                 while (j != sy.end() && j->symmterm == i->symmterm) {
1180                                         coeff += j->coeff;
1181                                         j++;
1182                                 }
1183
1184                                 // Add combined term to result
1185                                 if (!coeff.is_zero())
1186                                         result.push_back(coeff * i->symmterm);
1187
1188                         } else {
1189
1190                                 // Single term, store for second pass
1191                                 sy_pass2.push_back(*i);
1192                         }
1193
1194                         i = j;
1195                 }
1196
1197                 // Were there any remaining terms that didn't get combined?
1198                 if (sy_pass2.size() > 0) {
1199
1200                         // Yes, sort by their original terms
1201                         std::sort(sy_pass2.begin(), sy_pass2.end(), symminfo_is_less_by_orig());
1202
1203                         for (std::vector<symminfo>::const_iterator i=sy_pass2.begin(); i!=sy_pass2.end(); ) {
1204
1205                                 // How many symmetrized terms of this original term are left?
1206                                 size_t num = 1;
1207                                 auto j = i + 1;
1208                                 while (j != sy_pass2.end() && j->orig == i->orig) {
1209                                         num++;
1210                                         j++;
1211                                 }
1212
1213                                 if (num == i->num) {
1214
1215                                         // All terms left, then add the original term to the result
1216                                         result.push_back(i->orig);
1217
1218                                 } else {
1219
1220                                         // Some terms were combined with others, add up the remaining symmetrized terms
1221                                         std::vector<symminfo>::const_iterator k;
1222                                         for (k=i; k!=j; k++)
1223                                                 result.push_back(k->coeff * k->symmterm);
1224                                 }
1225
1226                                 i = j;
1227                         }
1228                 }
1229
1230                 // Add all resulting terms
1231                 ex sum_symm = dynallocate<add>(result);
1232                 if (sum_symm.is_zero())
1233                         free_indices.clear();
1234                 return sum_symm;
1235         }
1236
1237         // Simplification of products
1238         if (is_exactly_a<mul>(e_expanded)
1239          || is_exactly_a<ncmul>(e_expanded)
1240          || (is_exactly_a<power>(e_expanded) && is_a<indexed>(e_expanded.op(0)) && e_expanded.op(1).is_equal(_ex2)))
1241                 return simplify_indexed_product(e_expanded, free_indices, dummy_indices, sp);
1242
1243         // Cannot do anything
1244         free_indices.clear();
1245         return e_expanded;
1246 }
1247
1248 /** Simplify/canonicalize expression containing indexed objects. This
1249  *  performs contraction of dummy indices where possible and checks whether
1250  *  the free indices in sums are consistent.
1251  *
1252  *  @param options Simplification options (currently unused)
1253  *  @return simplified expression */
1254 ex ex::simplify_indexed(unsigned options) const
1255 {
1256         exvector free_indices, dummy_indices;
1257         scalar_products sp;
1258         return GiNaC::simplify_indexed(*this, free_indices, dummy_indices, sp);
1259 }
1260
1261 /** Simplify/canonicalize expression containing indexed objects. This
1262  *  performs contraction of dummy indices where possible, checks whether
1263  *  the free indices in sums are consistent, and automatically replaces
1264  *  scalar products by known values if desired.
1265  *
1266  *  @param sp Scalar products to be replaced automatically
1267  *  @param options Simplification options (currently unused)
1268  *  @return simplified expression */
1269 ex ex::simplify_indexed(const scalar_products & sp, unsigned options) const
1270 {
1271         exvector free_indices, dummy_indices;
1272         return GiNaC::simplify_indexed(*this, free_indices, dummy_indices, sp);
1273 }
1274
1275 /** Symmetrize expression over its free indices. */
1276 ex ex::symmetrize() const
1277 {
1278         return GiNaC::symmetrize(*this, get_free_indices());
1279 }
1280
1281 /** Antisymmetrize expression over its free indices. */
1282 ex ex::antisymmetrize() const
1283 {
1284         return GiNaC::antisymmetrize(*this, get_free_indices());
1285 }
1286
1287 /** Symmetrize expression by cyclic permutation over its free indices. */
1288 ex ex::symmetrize_cyclic() const
1289 {
1290         return GiNaC::symmetrize_cyclic(*this, get_free_indices());
1291 }
1292
1293 //////////
1294 // helper classes
1295 //////////
1296
1297 spmapkey::spmapkey(const ex & v1_, const ex & v2_, const ex & dim_) : dim(dim_)
1298 {
1299         // If indexed, extract base objects
1300         ex s1 = is_a<indexed>(v1_) ? v1_.op(0) : v1_;
1301         ex s2 = is_a<indexed>(v2_) ? v2_.op(0) : v2_;
1302
1303         // Enforce canonical order in pair
1304         if (s1.compare(s2) > 0) {
1305                 v1 = s2;
1306                 v2 = s1;
1307         } else {
1308                 v1 = s1;
1309                 v2 = s2;
1310         }
1311 }
1312
1313 bool spmapkey::operator==(const spmapkey &other) const
1314 {
1315         if (!v1.is_equal(other.v1))
1316                 return false;
1317         if (!v2.is_equal(other.v2))
1318                 return false;
1319         if (is_a<wildcard>(dim) || is_a<wildcard>(other.dim))
1320                 return true;
1321         else
1322                 return dim.is_equal(other.dim);
1323 }
1324
1325 bool spmapkey::operator<(const spmapkey &other) const
1326 {
1327         int cmp = v1.compare(other.v1);
1328         if (cmp)
1329                 return cmp < 0;
1330         cmp = v2.compare(other.v2);
1331         if (cmp)
1332                 return cmp < 0;
1333
1334         // Objects are equal, now check dimensions
1335         if (is_a<wildcard>(dim) || is_a<wildcard>(other.dim))
1336                 return false;
1337         else
1338                 return dim.compare(other.dim) < 0;
1339 }
1340
1341 void spmapkey::debugprint() const
1342 {
1343         std::cerr << "(" << v1 << "," << v2 << "," << dim << ")";
1344 }
1345
1346 void scalar_products::add(const ex & v1, const ex & v2, const ex & sp)
1347 {
1348         spm[spmapkey(v1, v2)] = sp;
1349 }
1350
1351 void scalar_products::add(const ex & v1, const ex & v2, const ex & dim, const ex & sp)
1352 {
1353         spm[spmapkey(v1, v2, dim)] = sp;
1354 }
1355
1356 void scalar_products::add_vectors(const lst & l, const ex & dim)
1357 {
1358         // Add all possible pairs of products
1359         for (auto & it1 : l)
1360                 for (auto & it2 : l)
1361                         add(it1, it2, it1 * it2);
1362 }
1363
1364 void scalar_products::clear()
1365 {
1366         spm.clear();
1367 }
1368
1369 /** Check whether scalar product pair is defined. */
1370 bool scalar_products::is_defined(const ex & v1, const ex & v2, const ex & dim) const
1371 {
1372         return spm.find(spmapkey(v1, v2, dim)) != spm.end();
1373 }
1374
1375 /** Return value of defined scalar product pair. */
1376 ex scalar_products::evaluate(const ex & v1, const ex & v2, const ex & dim) const
1377 {
1378         return spm.find(spmapkey(v1, v2, dim))->second;
1379 }
1380
1381 void scalar_products::debugprint() const
1382 {
1383         std::cerr << "map size=" << spm.size() << std::endl;
1384         for (auto & it : spm) {
1385                 const spmapkey & k = it.first;
1386                 std::cerr << "item key=";
1387                 k.debugprint();
1388                 std::cerr << ", value=" << it.second << std::endl;
1389         }
1390 }
1391
1392 exvector get_all_dummy_indices_safely(const ex & e)
1393 {
1394         if (is_a<indexed>(e))
1395                 return ex_to<indexed>(e).get_dummy_indices();
1396         else if (is_a<power>(e) && e.op(1)==2) {
1397                 return e.op(0).get_free_indices();
1398         }       
1399         else if (is_a<mul>(e) || is_a<ncmul>(e)) {
1400                 exvector dummies;
1401                 exvector free_indices;
1402                 for (std::size_t i = 0; i < e.nops(); ++i) {
1403                         exvector dummies_of_factor = get_all_dummy_indices_safely(e.op(i));
1404                         dummies.insert(dummies.end(), dummies_of_factor.begin(),
1405                                 dummies_of_factor.end());
1406                         exvector free_of_factor = e.op(i).get_free_indices();
1407                         free_indices.insert(free_indices.begin(), free_of_factor.begin(),
1408                                 free_of_factor.end());
1409                 }
1410                 exvector free_out, dummy_out;
1411                 find_free_and_dummy(free_indices.begin(), free_indices.end(), free_out,
1412                         dummy_out);
1413                 dummies.insert(dummies.end(), dummy_out.begin(), dummy_out.end());
1414                 return dummies;
1415         }
1416         else if(is_a<add>(e)) {
1417                 exvector result;
1418                 for(std::size_t i = 0; i < e.nops(); ++i) {
1419                         exvector dummies_of_term = get_all_dummy_indices_safely(e.op(i));
1420                         sort(dummies_of_term.begin(), dummies_of_term.end());
1421                         exvector new_vec;
1422                         set_union(result.begin(), result.end(), dummies_of_term.begin(),
1423                                 dummies_of_term.end(), std::back_inserter<exvector>(new_vec),
1424                                 ex_is_less());
1425                         result.swap(new_vec);
1426                 }
1427                 return result;
1428         }
1429         return exvector();
1430 }
1431
1432 /** Returns all dummy indices from the exvector */
1433 exvector get_all_dummy_indices(const ex & e)
1434 {
1435         exvector p;
1436         bool nc;
1437         product_to_exvector(e, p, nc);
1438         auto ip = p.begin(), ipend = p.end();
1439         exvector v, v1;
1440         while (ip != ipend) {
1441                 if (is_a<indexed>(*ip)) {
1442                         v1 = ex_to<indexed>(*ip).get_dummy_indices();
1443                         v.insert(v.end(), v1.begin(), v1.end());
1444                         auto ip1 = ip + 1;
1445                         while (ip1 != ipend) {
1446                                 if (is_a<indexed>(*ip1)) {
1447                                         v1 = ex_to<indexed>(*ip).get_dummy_indices(ex_to<indexed>(*ip1));
1448                                         v.insert(v.end(), v1.begin(), v1.end());
1449                                 }
1450                                 ++ip1;
1451                         }
1452                 }
1453                 ++ip;
1454         }
1455         return v;
1456 }
1457
1458 lst rename_dummy_indices_uniquely(const exvector & va, const exvector & vb)
1459 {
1460         exvector common_indices;
1461         set_intersection(va.begin(), va.end(), vb.begin(), vb.end(), std::back_insert_iterator<exvector>(common_indices), ex_is_less());
1462         if (common_indices.empty()) {
1463                 return lst{lst{}, lst{}};
1464         } else {
1465                 exvector new_indices, old_indices;
1466                 old_indices.reserve(2*common_indices.size());
1467                 new_indices.reserve(2*common_indices.size());
1468                 exvector::const_iterator ip = common_indices.begin(), ipend = common_indices.end();
1469                 while (ip != ipend) {
1470                         ex newsym = dynallocate<symbol>();
1471                         ex newidx;
1472                         if(is_exactly_a<spinidx>(*ip))
1473                                 newidx = dynallocate<spinidx>(newsym, ex_to<spinidx>(*ip).get_dim(),
1474                                                               ex_to<spinidx>(*ip).is_covariant(),
1475                                                               ex_to<spinidx>(*ip).is_dotted());
1476                         else if (is_exactly_a<varidx>(*ip))
1477                                 newidx = dynallocate<varidx>(newsym, ex_to<varidx>(*ip).get_dim(),
1478                                                              ex_to<varidx>(*ip).is_covariant());
1479                         else
1480                                 newidx = dynallocate<idx>(newsym, ex_to<idx>(*ip).get_dim());
1481                         old_indices.push_back(*ip);
1482                         new_indices.push_back(newidx);
1483                         if(is_a<varidx>(*ip)) {
1484                                 old_indices.push_back(ex_to<varidx>(*ip).toggle_variance());
1485                                 new_indices.push_back(ex_to<varidx>(newidx).toggle_variance());
1486                         }
1487                         ++ip;
1488                 }
1489                 return lst{lst(old_indices.begin(), old_indices.end()), lst(new_indices.begin(), new_indices.end())};
1490         }
1491 }
1492
1493 ex rename_dummy_indices_uniquely(const exvector & va, const exvector & vb, const ex & b)
1494 {
1495         lst indices_subs = rename_dummy_indices_uniquely(va, vb);
1496         return (indices_subs.op(0).nops()>0 ? b.subs(ex_to<lst>(indices_subs.op(0)), ex_to<lst>(indices_subs.op(1)), subs_options::no_pattern|subs_options::no_index_renaming) : b);
1497 }
1498
1499 ex rename_dummy_indices_uniquely(const ex & a, const ex & b)
1500 {
1501         exvector va = get_all_dummy_indices_safely(a);
1502         if (va.size() > 0) {
1503                 exvector vb = get_all_dummy_indices_safely(b);
1504                 if (vb.size() > 0) {
1505                         sort(va.begin(), va.end(), ex_is_less());
1506                         sort(vb.begin(), vb.end(), ex_is_less());
1507                         lst indices_subs = rename_dummy_indices_uniquely(va, vb);
1508                         if (indices_subs.op(0).nops() > 0)
1509                                 return b.subs(ex_to<lst>(indices_subs.op(0)), ex_to<lst>(indices_subs.op(1)), subs_options::no_pattern|subs_options::no_index_renaming);
1510                 }
1511         }
1512         return b;
1513 }
1514
1515 ex rename_dummy_indices_uniquely(exvector & va, const ex & b, bool modify_va)
1516 {
1517         if (va.size() > 0) {
1518                 exvector vb = get_all_dummy_indices_safely(b);
1519                 if (vb.size() > 0) {
1520                         sort(vb.begin(), vb.end(), ex_is_less());
1521                         lst indices_subs = rename_dummy_indices_uniquely(va, vb);
1522                         if (indices_subs.op(0).nops() > 0) {
1523                                 if (modify_va) {
1524                                         for (auto & i : ex_to<lst>(indices_subs.op(1)))
1525                                                 va.push_back(i);
1526                                         exvector uncommon_indices;
1527                                         set_difference(vb.begin(), vb.end(), indices_subs.op(0).begin(), indices_subs.op(0).end(), std::back_insert_iterator<exvector>(uncommon_indices), ex_is_less());
1528                                         for (auto & ip : uncommon_indices)
1529                                                 va.push_back(ip);
1530                                         sort(va.begin(), va.end(), ex_is_less());
1531                                 }
1532                                 return b.subs(ex_to<lst>(indices_subs.op(0)), ex_to<lst>(indices_subs.op(1)), subs_options::no_pattern|subs_options::no_index_renaming);
1533                         }
1534                 }
1535         }
1536         return b;
1537 }
1538
1539 ex expand_dummy_sum(const ex & e, bool subs_idx)
1540 {
1541         ex e_expanded = e.expand();
1542         pointer_to_map_function_1arg<bool> fcn(expand_dummy_sum, subs_idx);
1543         if (is_a<add>(e_expanded) || is_a<lst>(e_expanded) || is_a<matrix>(e_expanded)) {
1544                 return e_expanded.map(fcn);
1545         } else if (is_a<ncmul>(e_expanded) || is_a<mul>(e_expanded) || is_a<power>(e_expanded) || is_a<indexed>(e_expanded)) {
1546                 exvector v;
1547                 if (is_a<indexed>(e_expanded))
1548                         v = ex_to<indexed>(e_expanded).get_dummy_indices();
1549                 else
1550                         v = get_all_dummy_indices(e_expanded);
1551                 ex result = e_expanded;
1552                 for (const auto & nu : v) {
1553                         if (ex_to<idx>(nu).get_dim().info(info_flags::nonnegint)) {
1554                                 int idim = ex_to<numeric>(ex_to<idx>(nu).get_dim()).to_int();
1555                                 ex en = 0;
1556                                 for (int i=0; i < idim; i++) {
1557                                         if (subs_idx && is_a<varidx>(nu)) {
1558                                                 ex other = ex_to<varidx>(nu).toggle_variance();
1559                                                 en += result.subs(lst{
1560                                                         nu == idx(i, idim),
1561                                                         other == idx(i, idim)
1562                                                 });
1563                                         } else {
1564                                                 en += result.subs( nu.op(0) == i );
1565                                         }
1566                                 }
1567                                 result = en;
1568                         }
1569                 }
1570                 return result;
1571         } else {
1572                 return e;
1573         }
1574 }
1575
1576 } // namespace GiNaC