ginac/idx.cpp

   1 /** @file idx.cpp
   2  *
   3  *  Implementation of GiNaC's indices. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2003 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 <sstream>
  25 #include <stdexcept>
  26
  27 #include "idx.h"
  28 #include "symbol.h"
  29 #include "lst.h"
  30 #include "relational.h"
  31 #include "operators.h"
  32 #include "print.h"
  33 #include "archive.h"
  34 #include "utils.h"
  35
  36 namespace GiNaC {
  37
  38 GINAC_IMPLEMENT_REGISTERED_CLASS(idx, basic)
  39 GINAC_IMPLEMENT_REGISTERED_CLASS(varidx, idx)
  40 GINAC_IMPLEMENT_REGISTERED_CLASS(spinidx, varidx)
  41
  42 //////////
  43 // default constructor
  44 //////////
  45
  46 idx::idx() : inherited(TINFO_idx) {}
  47
  48 varidx::varidx() : covariant(false)
  49 {
  50         tinfo_key = TINFO_varidx;
  51 }
  52
  53 spinidx::spinidx() : dotted(false)
  54 {
  55         tinfo_key = TINFO_spinidx;
  56 }
  57
  58 //////////
  59 // other constructors
  60 //////////
  61
  62 idx::idx(const ex & v, const ex & d) : inherited(TINFO_idx), value(v), dim(d)
  63 {
  64         if (is_dim_numeric())
  65                 if (!dim.info(info_flags::posint))
  66                         throw(std::invalid_argument("dimension of space must be a positive integer"));
  67 }
  68
  69 varidx::varidx(const ex & v, const ex & d, bool cov) : inherited(v, d), covariant(cov)
  70 {
  71         tinfo_key = TINFO_varidx;
  72 }
  73
  74 spinidx::spinidx(const ex & v, const ex & d, bool cov, bool dot) : inherited(v, d, cov), dotted(dot)
  75 {
  76         tinfo_key = TINFO_spinidx;
  77 }
  78
  79 //////////
  80 // archiving
  81 //////////
  82
  83 idx::idx(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
  84 {
  85         n.find_ex("value", value, sym_lst);
  86         n.find_ex("dim", dim, sym_lst);
  87 }
  88
  89 varidx::varidx(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
  90 {
  91         n.find_bool("covariant", covariant);
  92 }
  93
  94 spinidx::spinidx(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
  95 {
  96         n.find_bool("dotted", dotted);
  97 }
  98
  99 void idx::archive(archive_node &n) const
 100 {
 101         inherited::archive(n);
 102         n.add_ex("value", value);
 103         n.add_ex("dim", dim);
 104 }
 105
 106 void varidx::archive(archive_node &n) const
 107 {
 108         inherited::archive(n);
 109         n.add_bool("covariant", covariant);
 110 }
 111
 112 void spinidx::archive(archive_node &n) const
 113 {
 114         inherited::archive(n);
 115         n.add_bool("dotted", dotted);
 116 }
 117
 118 DEFAULT_UNARCHIVE(idx)
 119 DEFAULT_UNARCHIVE(varidx)
 120 DEFAULT_UNARCHIVE(spinidx)
 121
 122 //////////
 123 // functions overriding virtual functions from base classes
 124 //////////
 125
 126 void idx::print(const print_context & c, unsigned level) const
 127 {
 128         if (is_a<print_tree>(c)) {
 129
 130                 c.s << std::string(level, ' ') << class_name()
 131                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 132                     << std::endl;
 133                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 134                 value.print(c, level + delta_indent);
 135                 dim.print(c, level + delta_indent);
 136
 137         } else {
 138
 139                 if (is_a<print_latex>(c))
 140                         c.s << "{";
 141                 else
 142                         c.s << ".";
 143                 bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
 144                 if (need_parens)
 145                         c.s << "(";
 146                 value.print(c);
 147                 if (need_parens)
 148                         c.s << ")";
 149                 if (c.options & print_options::print_index_dimensions) {
 150                         c.s << "[";
 151                         dim.print(c);
 152                         c.s << "]";
 153                 }
 154                 if (is_a<print_latex>(c))
 155                         c.s << "}";
 156         }
 157 }
 158
 159 void varidx::print(const print_context & c, unsigned level) const
 160 {
 161         if (is_a<print_tree>(c)) {
 162
 163                 c.s << std::string(level, ' ') << class_name()
 164                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 165                     << (covariant ? ", covariant" : ", contravariant")
 166                     << std::endl;
 167                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 168                 value.print(c, level + delta_indent);
 169                 dim.print(c, level + delta_indent);
 170
 171         } else {
 172                 if (is_a<print_latex>(c))
 173                         c.s << "{";
 174                 else {
 175                         if (covariant)
 176                                 c.s << ".";
 177                         else
 178                                 c.s << "~";
 179                 }
 180                 bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
 181                 if (need_parens)
 182                         c.s << "(";
 183                 value.print(c);
 184                 if (need_parens)
 185                         c.s << ")";
 186                 if (c.options & print_options::print_index_dimensions) {
 187                         c.s << "[";
 188                         dim.print(c);
 189                         c.s << "]";
 190                 }
 191                 if (is_a<print_latex>(c))
 192                         c.s << "}";
 193         }
 194 }
 195
 196 void spinidx::print(const print_context & c, unsigned level) const
 197 {
 198         if (is_a<print_tree>(c)) {
 199
 200                 c.s << std::string(level, ' ') << class_name()
 201                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 202                     << (covariant ? ", covariant" : ", contravariant")
 203                     << (dotted ? ", dotted" : ", undotted")
 204                     << std::endl;
 205                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 206                 value.print(c, level + delta_indent);
 207                 dim.print(c, level + delta_indent);
 208
 209         } else {
 210
 211                 bool is_tex = is_a<print_latex>(c);
 212                 if (is_tex) {
 213                         if (covariant)
 214                                 c.s << "_{";
 215                         else
 216                                 c.s << "^{";
 217                 } else {
 218                         if (covariant)
 219                                 c.s << ".";
 220                         else
 221                                 c.s << "~";
 222                 }
 223                 if (dotted) {
 224                         if (is_tex)
 225                                 c.s << "\\dot{";
 226                         else
 227                                 c.s << "*";
 228                 }
 229                 bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
 230                 if (need_parens)
 231                         c.s << "(";
 232                 value.print(c);
 233                 if (need_parens)
 234                         c.s << ")";
 235                 if (is_tex && dotted)
 236                         c.s << "}";
 237                 if (is_tex)
 238                         c.s << "}";
 239         }
 240 }
 241
 242 bool idx::info(unsigned inf) const
 243 {
 244         if (inf == info_flags::idx)
 245                 return true;
 246         return inherited::info(inf);
 247 }
 248
 249 size_t idx::nops() const
 250 {
 251         // don't count the dimension as that is not really a sub-expression
 252         return 1;
 253 }
 254
 255 ex idx::op(size_t i) const
 256 {
 257         GINAC_ASSERT(i == 0);
 258         return value;
 259 }
 260
 261 ex idx::map(map_function & f) const
 262 {
 263         idx *copy = duplicate();
 264         copy->setflag(status_flags::dynallocated);
 265         copy->clearflag(status_flags::hash_calculated);
 266         copy->value = f(value);
 267         return *copy;
 268 }
 269
 270 /** Returns order relation between two indices of the same type. The order
 271  *  must be such that dummy indices lie next to each other. */
 272 int idx::compare_same_type(const basic & other) const
 273 {
 274         GINAC_ASSERT(is_a<idx>(other));
 275         const idx &o = static_cast<const idx &>(other);
 276
 277         int cmpval = value.compare(o.value);
 278         if (cmpval)
 279                 return cmpval;
 280         return dim.compare(o.dim);
 281 }
 282
 283 bool idx::match_same_type(const basic & other) const
 284 {
 285         GINAC_ASSERT(is_a<idx>(other));
 286         const idx &o = static_cast<const idx &>(other);
 287
 288         return dim.is_equal(o.dim);
 289 }
 290
 291 int varidx::compare_same_type(const basic & other) const
 292 {
 293         GINAC_ASSERT(is_a<varidx>(other));
 294         const varidx &o = static_cast<const varidx &>(other);
 295
 296         int cmpval = inherited::compare_same_type(other);
 297         if (cmpval)
 298                 return cmpval;
 299
 300         // Check variance last so dummy indices will end up next to each other
 301         if (covariant != o.covariant)
 302                 return covariant ? -1 : 1;
 303
 304         return 0;
 305 }
 306
 307 bool varidx::match_same_type(const basic & other) const
 308 {
 309         GINAC_ASSERT(is_a<varidx>(other));
 310         const varidx &o = static_cast<const varidx &>(other);
 311
 312         if (covariant != o.covariant)
 313                 return false;
 314
 315         return inherited::match_same_type(other);
 316 }
 317
 318 int spinidx::compare_same_type(const basic & other) const
 319 {
 320         GINAC_ASSERT(is_a<spinidx>(other));
 321         const spinidx &o = static_cast<const spinidx &>(other);
 322
 323         // Check dottedness first so dummy indices will end up next to each other
 324         if (dotted != o.dotted)
 325                 return dotted ? -1 : 1;
 326
 327         int cmpval = inherited::compare_same_type(other);
 328         if (cmpval)
 329                 return cmpval;
 330
 331         return 0;
 332 }
 333
 334 bool spinidx::match_same_type(const basic & other) const
 335 {
 336         GINAC_ASSERT(is_a<spinidx>(other));
 337         const spinidx &o = static_cast<const spinidx &>(other);
 338
 339         if (dotted != o.dotted)
 340                 return false;
 341         return inherited::match_same_type(other);
 342 }
 343
 344 /** By default, basic::evalf would evaluate the index value but we don't want
 345  *  a.1 to become a.(1.0). */
 346 ex idx::evalf(int level) const
 347 {
 348         return *this;
 349 }
 350
 351 ex idx::subs(const lst & ls, const lst & lr, unsigned options) const
 352 {
 353         GINAC_ASSERT(ls.nops() == lr.nops());
 354
 355         // First look for index substitutions
 356         lst::const_iterator its, itr;
 357         for (its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) {
 358                 if (is_equal(ex_to<basic>(*its))) {
 359
 360                         // Substitution index->index
 361                         if (is_a<idx>(*itr))
 362                                 return *itr;
 363
 364                         // Otherwise substitute value
 365                         idx *i_copy = duplicate();
 366                         i_copy->value = *itr;
 367                         i_copy->clearflag(status_flags::hash_calculated);
 368                         return i_copy->setflag(status_flags::dynallocated);
 369                 }
 370         }
 371
 372         // None, substitute objects in value (not in dimension)
 373         const ex &subsed_value = value.subs(ls, lr, options);
 374         if (are_ex_trivially_equal(value, subsed_value))
 375                 return *this;
 376
 377         idx *i_copy = duplicate();
 378         i_copy->value = subsed_value;
 379         i_copy->clearflag(status_flags::hash_calculated);
 380         return i_copy->setflag(status_flags::dynallocated);
 381 }
 382
 383 /** Implementation of ex::diff() for an index always returns 0.
 384  *
 385  *  @see ex::diff */
 386 ex idx::derivative(const symbol & s) const
 387 {
 388         return _ex0;
 389 }
 390
 391 //////////
 392 // new virtual functions
 393 //////////
 394
 395 bool idx::is_dummy_pair_same_type(const basic & other) const
 396 {
 397         const idx &o = static_cast<const idx &>(other);
 398
 399         // Only pure symbols form dummy pairs, "2n+1" doesn't
 400         if (!is_a<symbol>(value))
 401                 return false;
 402
 403         // Value must be equal, of course
 404         if (!value.is_equal(o.value))
 405                 return false;
 406
 407         // Dimensions need not be equal but must be comparable (so we can
 408         // determine the minimum dimension of contractions)
 409         if (dim.is_equal(o.dim))
 410                 return true;
 411
 412         return (dim < o.dim || dim > o.dim || (is_exactly_a<numeric>(dim) && is_a<symbol>(o.dim)) || (is_a<symbol>(dim) && is_exactly_a<numeric>(o.dim)));
 413 }
 414
 415 bool varidx::is_dummy_pair_same_type(const basic & other) const
 416 {
 417         const varidx &o = static_cast<const varidx &>(other);
 418
 419         // Variance must be opposite
 420         if (covariant == o.covariant)
 421                 return false;
 422
 423         return inherited::is_dummy_pair_same_type(other);
 424 }
 425
 426 bool spinidx::is_dummy_pair_same_type(const basic & other) const
 427 {
 428         const spinidx &o = static_cast<const spinidx &>(other);
 429
 430         // Dottedness must be the same
 431         if (dotted != o.dotted)
 432                 return false;
 433
 434         return inherited::is_dummy_pair_same_type(other);
 435 }
 436
 437
 438 //////////
 439 // non-virtual functions
 440 //////////
 441
 442 ex idx::replace_dim(const ex & new_dim) const
 443 {
 444         idx *i_copy = duplicate();
 445         i_copy->dim = new_dim;
 446         i_copy->clearflag(status_flags::hash_calculated);
 447         return i_copy->setflag(status_flags::dynallocated);
 448 }
 449
 450 ex idx::minimal_dim(const idx & other) const
 451 {
 452         return GiNaC::minimal_dim(dim, other.dim);
 453 }
 454
 455 ex varidx::toggle_variance() const
 456 {
 457         varidx *i_copy = duplicate();
 458         i_copy->covariant = !i_copy->covariant;
 459         i_copy->clearflag(status_flags::hash_calculated);
 460         return i_copy->setflag(status_flags::dynallocated);
 461 }
 462
 463 ex spinidx::toggle_dot() const
 464 {
 465         spinidx *i_copy = duplicate();
 466         i_copy->dotted = !i_copy->dotted;
 467         i_copy->clearflag(status_flags::hash_calculated);
 468         return i_copy->setflag(status_flags::dynallocated);
 469 }
 470
 471 ex spinidx::toggle_variance_dot() const
 472 {
 473         spinidx *i_copy = duplicate();
 474         i_copy->covariant = !i_copy->covariant;
 475         i_copy->dotted = !i_copy->dotted;
 476         i_copy->clearflag(status_flags::hash_calculated);
 477         return i_copy->setflag(status_flags::dynallocated);
 478 }
 479
 480 //////////
 481 // global functions
 482 //////////
 483
 484 bool is_dummy_pair(const idx & i1, const idx & i2)
 485 {
 486         // The indices must be of exactly the same type
 487         if (i1.tinfo() != i2.tinfo())
 488                 return false;
 489
 490         // Same type, let the indices decide whether they are paired
 491         return i1.is_dummy_pair_same_type(i2);
 492 }
 493
 494 bool is_dummy_pair(const ex & e1, const ex & e2)
 495 {
 496         // The expressions must be indices
 497         if (!is_a<idx>(e1) || !is_a<idx>(e2))
 498                 return false;
 499
 500         return is_dummy_pair(ex_to<idx>(e1), ex_to<idx>(e2));
 501 }
 502
 503 void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator itend, exvector & out_free, exvector & out_dummy)
 504 {
 505         out_free.clear();
 506         out_dummy.clear();
 507
 508         // No indices? Then do nothing
 509         if (it == itend)
 510                 return;
 511
 512         // Only one index? Then it is a free one if it's not numeric
 513         if (itend - it == 1) {
 514                 if (ex_to<idx>(*it).is_symbolic())
 515                         out_free.push_back(*it);
 516                 return;
 517         }
 518
 519         // Sort index vector. This will cause dummy indices come to lie next
 520         // to each other (because the sort order is defined to guarantee this).
 521         exvector v(it, itend);
 522         shaker_sort(v.begin(), v.end(), ex_is_less(), ex_swap());
 523
 524         // Find dummy pairs and free indices
 525         it = v.begin(); itend = v.end();
 526         exvector::const_iterator last = it++;
 527         while (it != itend) {
 528                 if (is_dummy_pair(*it, *last)) {
 529                         out_dummy.push_back(*last);
 530                         it++;
 531                         if (it == itend)
 532                                 return;
 533                 } else {
 534                         if (!it->is_equal(*last) && ex_to<idx>(*last).is_symbolic())
 535                                 out_free.push_back(*last);
 536                 }
 537                 last = it++;
 538         }
 539         if (ex_to<idx>(*last).is_symbolic())
 540                 out_free.push_back(*last);
 541 }
 542
 543 ex minimal_dim(const ex & dim1, const ex & dim2)
 544 {
 545         if (dim1.is_equal(dim2) || dim1 < dim2 || (is_exactly_a<numeric>(dim1) && is_a<symbol>(dim2)))
 546                 return dim1;
 547         else if (dim1 > dim2 || (is_a<symbol>(dim1) && is_exactly_a<numeric>(dim2)))
 548                 return dim2;
 549         else {
 550                 std::ostringstream s;
 551                 s << "minimal_dim(): index dimensions " << dim1 << " and " << dim2 << " cannot be ordered";
 552                 throw (std::runtime_error(s.str()));
 553         }
 554 }
 555
 556 } // namespace GiNaC