* New funny timing added: compute an antipode in Yukawa theory.
[ginac.git] / 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 namespace GiNaC {
30
31 /** Base class for isospin object */
32 class isospin : public indexed
33 {
34         GINAC_DECLARE_REGISTERED_CLASS(isospin, indexed)
35
36         // other constructors
37 public:
38         explicit isospin(const std::string & initname);
39
40         // functions overriding virtual functions from base classes
41 public:
42         void printraw(std::ostream & os) const;
43         void printtree(std::ostream & os, unsigned indent) const;
44         void print(std::ostream & os, unsigned upper_precedence=0) const;
45         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
46         bool info(unsigned inf) const;
47 protected:
48         ex simplify_ncmul(const exvector & v) const;
49         unsigned calchash(void) const;
50
51         // new virtual functions which can be overridden by derived classes
52         // none
53         
54         // non-virtual functions in this class
55 public:
56         void setname(const std::string & n);
57 private:
58         std::string & autoname_prefix(void);
59
60 // member variables
61
62 protected:
63         std::string name;
64         unsigned serial; // unique serial number for comparision
65 private:
66         static unsigned next_serial;
67 };
68
69 // utility functions
70 inline const isospin &ex_to_isospin(const ex &e)
71 {
72         return static_cast<const isospin &>(*e.bp);
73 }
74
75 } // namespace GiNaC
76
77 #endif // ndef __GINAC_ISOSPIN_H__