ginac/indexed.h

   1 /** @file indexed.h
   2  *
   3  *  Interface to GiNaC's index carrying objects. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_INDEXED_H__
  24 #define __GINAC_INDEXED_H__
  25
  26 #include <string>
  27 #include "exprseq.h"
  28
  29 namespace GiNaC {
  30
  31
  32 /** Base class for objects with indices. */
  33 class indexed : public exprseq
  34 {
  35         GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
  36
  37         // other constructors
  38 public:
  39         indexed(const ex & i1);
  40         indexed(const ex & i1, const ex & i2);
  41         indexed(const ex & i1, const ex & i2, const ex & i3);
  42         indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4);
  43         indexed(const exvector & iv);
  44         indexed(exvector * iv);
  45
  46         // functions overriding virtual functions from base classes
  47 public:
  48         void printraw(std::ostream & os) const;
  49         void printtree(std::ostream & os, unsigned indent) const;
  50         void print(std::ostream & os, unsigned upper_precedence=0) const;
  51         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const;
  52         bool info(unsigned inf) const;
  53
  54         /** Return the vector of indices on this object. */
  55         exvector get_indices(void) const {return seq;}
  56
  57 protected:
  58         ex derivative(const symbol & s) const;
  59         bool is_equal_same_type(const basic & other) const;
  60         unsigned return_type(void) const;
  61         unsigned return_type_tinfo(void) const;
  62         ex thisexprseq(const exvector & v) const;
  63         ex thisexprseq(exvector * vp) const;
  64
  65         // new virtual functions which can be overridden by derived classes
  66         // none
  67
  68         // non-virtual functions in this class
  69 protected:
  70         void printrawindices(std::ostream & os) const;
  71         void printtreeindices(std::ostream & os, unsigned indent) const;
  72         void printindices(std::ostream & os) const;
  73         bool all_of_type_idx(void) const;
  74
  75 // member variables
  76         // none
  77 };
  78
  79 // utility functions
  80 inline const indexed &ex_to_indexed(const ex &e)
  81 {
  82         return static_cast<const indexed &>(*e.bp);
  83 }
  84
  85 } // namespace GiNaC
  86
  87 #endif // ndef __GINAC_INDEXED_H__