ginac/isospin.h

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