ginac/clifford.h

   1 /** @file clifford.h
   2  *
   3  *  Interface to GiNaC's clifford 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_CLIFFORD_H__
  24 #define __GINAC_CLIFFORD_H__
  25
  26 #include <string>
  27 #include "indexed.h"
  28 #include "ex.h"
  29
  30 #ifndef NO_NAMESPACE_GINAC
  31 namespace GiNaC {
  32 #endif // ndef NO_NAMESPACE_GINAC
  33
  34 /** Base class for clifford object */
  35 class clifford : public indexed
  36 {
  37 // member functions
  38
  39         // default constructor, destructor, copy constructor assignment operator and helpers
  40 public:
  41         clifford();
  42         ~clifford();
  43         clifford(const clifford & other);
  44         const clifford & operator=(const clifford & other);
  45 protected:
  46         void copy(const clifford & other);
  47         void destroy(bool call_parent);
  48
  49         // other constructors
  50 public:
  51         explicit clifford(const std::string & initname);
  52
  53         // functions overriding virtual functions from base classes
  54 public:
  55         basic * duplicate() const;
  56         void printraw(std::ostream & os) const;
  57         void printtree(std::ostream & os, unsigned indent) const;
  58         void print(std::ostream & os, unsigned upper_precedence=0) const;
  59         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  60         bool info(unsigned inf) const;
  61 protected:
  62         int compare_same_type(const basic & other) const;
  63         ex simplify_ncmul(const exvector & v) const;
  64         unsigned calchash(void) const;
  65
  66         // new virtual functions which can be overridden by derived classes
  67         // none
  68
  69         // non-virtual functions in this class
  70 public:
  71         void setname(const std::string & n);
  72 private:
  73         std::string & autoname_prefix(void);
  74
  75 // member variables
  76
  77 protected:
  78         std::string name;
  79         unsigned serial; // unique serial number for comparision
  80 private:
  81         static unsigned next_serial;
  82 };
  83
  84 // global constants
  85
  86 extern const clifford some_clifford;
  87 extern const std::type_info & typeid_clifford;
  88
  89 // utility functions
  90 inline const clifford &ex_to_clifford(const ex &e)
  91 {
  92         return static_cast<const clifford &>(*e.bp);
  93 }
  94
  95 #ifndef NO_NAMESPACE_GINAC
  96 } // namespace GiNaC
  97 #endif // ndef NO_NAMESPACE_GINAC
  98
  99 #endif // ndef __GINAC_CLIFFORD_H__