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 #ifndef NO_NAMESPACE_GINAC
  30 namespace GiNaC {
  31 #endif // ndef NO_NAMESPACE_GINAC
  32
  33
  34 /** Base class for objects with indices. */
  35 class indexed : public exprseq
  36 {
  37         GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
  38
  39 // member functions
  40
  41         // default constructor, destructor, copy constructor assignment operator and helpers
  42 public:
  43         indexed();
  44         ~indexed();
  45         indexed(const indexed & other);
  46         const indexed & operator=(const indexed & other);
  47 protected:
  48         void copy(const indexed & other);
  49         void destroy(bool call_parent);
  50
  51         // other constructors
  52 public:
  53         indexed(const ex & i1);
  54         indexed(const ex & i1, const ex & i2);
  55         indexed(const ex & i1, const ex & i2, const ex & i3);
  56         indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4);
  57         indexed(const exvector & iv);
  58         indexed(exvector * iv);
  59
  60         // functions overriding virtual functions from base classes
  61 public:
  62         basic * duplicate() const;
  63         void printraw(std::ostream & os) const;
  64         void printtree(std::ostream & os, unsigned indent) const;
  65         void print(std::ostream & os, unsigned upper_precedence=0) const;
  66         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const;
  67         bool info(unsigned inf) const;
  68
  69         /** Return the vector of indices on this object. */
  70         exvector get_indices(void) const {return seq;}
  71
  72 protected:
  73         ex derivative(const symbol & s) const;
  74         int compare_same_type(const basic & other) const;
  75         bool is_equal_same_type(const basic & other) const;
  76         unsigned return_type(void) const;
  77         unsigned return_type_tinfo(void) const;
  78         ex thisexprseq(const exvector & v) const;
  79         ex thisexprseq(exvector * vp) const;
  80
  81         // new virtual functions which can be overridden by derived classes
  82         // none
  83
  84         // non-virtual functions in this class
  85 protected:
  86         void printrawindices(std::ostream & os) const;
  87         void printtreeindices(std::ostream & os, unsigned indent) const;
  88         void printindices(std::ostream & os) const;
  89         bool all_of_type_idx(void) const;
  90
  91 // member variables
  92         // none
  93 };
  94
  95 // global constants
  96
  97 extern const indexed some_indexed;
  98 extern const std::type_info & typeid_indexed;
  99
 100 // utility functions
 101 inline const indexed &ex_to_indexed(const ex &e)
 102 {
 103         return static_cast<const indexed &>(*e.bp);
 104 }
 105
 106 #ifndef NO_NAMESPACE_GINAC
 107 } // namespace GiNaC
 108 #endif // ndef NO_NAMESPACE_GINAC
 109
 110 #endif // ndef __GINAC_INDEXED_H__