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