- modified the comment blocks so the copyright message no longer appears in
[ginac.git] / ginac / coloridx.h
1 /** @file coloridx.h
2  *
3  *  Interface to GiNaC's color indices. */
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_COLORIDX_H__
24 #define __GINAC_COLORIDX_H__
25
26 #include <string>
27 #include <vector>
28 #include <ginac/idx.h>
29
30 class coloridx : public idx
31 {
32     friend class color;
33
34 // member functions
35
36     // default constructor, destructor, copy constructor assignment operator and helpers
37 public:
38     coloridx();
39     ~coloridx();
40     coloridx (coloridx const & other);
41     coloridx const & operator=(coloridx const & other);
42 protected:
43     void copy(coloridx const & other);
44     void destroy(bool call_parent);
45
46     // other constructors
47 public:
48     explicit coloridx(bool cov);
49     explicit coloridx(string const & n, bool cov=false);
50     explicit coloridx(char const * n, bool cov=false);
51     explicit coloridx(unsigned const v, bool cov=false); 
52
53     // functions overriding virtual functions from bases classes
54 public:
55     basic * duplicate() const;
56     void printraw(ostream & os) const;
57     void printtree(ostream & os, unsigned indent) const;
58     void print(ostream & os, unsigned upper_precedence=0) const;
59     bool info(unsigned inf) const;
60
61     // new virtual functions which can be overridden by derived classes
62     // none
63
64     // non-virtual functions in this class
65     // none
66
67     // member variables
68     // none
69 };
70
71 // global constants
72
73 extern const coloridx some_coloridx;
74 extern type_info const & typeid_coloridx;
75
76 // macros
77
78 #define ex_to_coloridx(X) (static_cast<coloridx const &>(*(X).bp))
79
80 #endif // ndef __GINAC_COLORIDX_H__