ginac/indexed.h

   1 /** @file indexed.h
   2  *
   3  *  Interface to GiNaC's index carrying objects. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999 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 #ifndef __GINAC_INDEXED_H__
  24 #define __GINAC_INDEXED_H__
  25
  26 #include <string>
  27 #include <ginac/exprseq.h>
  28
  29 namespace GiNaC {
  30
  31 /** Base class for non-commutative indexed objects */
  32 class indexed : public exprseq
  33 {
  34 // member functions
  35
  36     // default constructor, destructor, copy constructor assignment operator and helpers
  37 public:
  38     indexed();
  39     ~indexed();
  40     indexed(indexed const & other);
  41     indexed const & operator=(indexed const & other);
  42 protected:
  43     void copy(indexed const & other);
  44     void destroy(bool call_parent);
  45
  46     // other constructors
  47 public:
  48     indexed(ex const & i1);
  49     indexed(ex const & i1, ex const & i2);
  50     indexed(ex const & i1, ex const & i2, ex const & i3);
  51     indexed(exvector const & iv);
  52     indexed(exvector * iv);
  53
  54     // functions overriding virtual functions from base classes
  55 public:
  56     basic * duplicate() const;
  57     void printraw(ostream & os) const;
  58     void printtree(ostream & os, unsigned indent) const;
  59     void print(ostream & os, unsigned upper_precedence=0) const;
  60     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const;
  61     bool info(unsigned inf) const;
  62     ex diff(symbol const & s) const;
  63     exvector get_indices(void) const;
  64 protected:
  65     int compare_same_type(basic const & other) const;
  66     bool is_equal_same_type(basic const & other) const;
  67     unsigned return_type(void) const;
  68     unsigned return_type_tinfo(void) const;
  69     ex thisexprseq(exvector const & v) const;
  70     ex thisexprseq(exvector * vp) const;
  71
  72     // new virtual functions which can be overridden by derived classes
  73     // none
  74
  75     // non-virtual functions in this class
  76 protected:
  77     void printrawindices(ostream & os) const;
  78     void printtreeindices(ostream & os, unsigned indent) const;
  79     void printindices(ostream & os) const;
  80     bool all_of_type_idx(void) const;
  81
  82 // member variables
  83     // none
  84 };
  85
  86 // global constants
  87
  88 extern const indexed some_indexed;
  89 extern type_info const & typeid_indexed;
  90
  91 // utility functions
  92 inline const indexed &ex_to_indexed(const ex &e)
  93 {
  94         return static_cast<const indexed &>(*e.bp);
  95 }
  96
  97 } // namespace GiNaC
  98
  99 #endif // ndef __GINAC_INDEXED_H__