#ifndef around namespace GiNaC { }
[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 #include <ginac/ex.h>
30
31 #ifndef NO_GINAC_NAMESPACE
32 namespace GiNaC {
33 #endif // ndef NO_GINAC_NAMESPACE
34
35 class coloridx : public idx
36 {
37     friend class color;
38
39 // member functions
40
41     // default constructor, destructor, copy constructor assignment operator and helpers
42 public:
43     coloridx();
44     ~coloridx();
45     coloridx (coloridx const & other);
46     coloridx const & operator=(coloridx const & other);
47 protected:
48     void copy(coloridx const & other);
49     void destroy(bool call_parent);
50
51     // other constructors
52 public:
53     explicit coloridx(bool cov);
54     explicit coloridx(string const & n, bool cov=false);
55     explicit coloridx(char const * n, bool cov=false);
56     explicit coloridx(unsigned const v, bool cov=false); 
57
58     // functions overriding virtual functions from bases classes
59 public:
60     basic * duplicate() const;
61     void printraw(ostream & os) const;
62     void printtree(ostream & os, unsigned indent) const;
63     void print(ostream & os, unsigned upper_precedence=0) const;
64     bool info(unsigned inf) const;
65
66     // new virtual functions which can be overridden by derived classes
67     // none
68
69     // non-virtual functions in this class
70     // none
71
72     // member variables
73     // none
74 };
75
76 // global constants
77
78 extern const coloridx some_coloridx;
79 extern type_info const & typeid_coloridx;
80
81 // utility functions
82 inline const coloridx &ex_to_coloridx(const ex &e)
83 {
84         return static_cast<const coloridx &>(*e.bp);
85 }
86
87 #ifndef NO_GINAC_NAMESPACE
88 } // namespace GiNaC
89 #endif // ndef NO_GINAC_NAMESPACE
90
91 #endif // ndef __GINAC_COLORIDX_H__