ginac/clifford.h

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