ginac/isospin.h

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