- Added some comments for doxygen.
[ginac.git] / ginac / flags.h
1 /** @file flags.h
2  *
3  *  Collection of all flags used through the GiNaC framework. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 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_FLAGS_H__
24 #define __GINAC_FLAGS_H__
25
26 #ifndef NO_GINAC_NAMESPACE
27 namespace GiNaC {
28 #endif // ndef NO_GINAC_NAMESPACE
29
30 class expand_options {
31 public:
32     enum { expand_trigonometric      = 0x0001
33          };
34 };
35
36 class status_flags {
37 public:
38     enum { dynallocated              = 0x0001,
39            evaluated                 = 0x0002,
40            expanded                  = 0x0004,
41            hash_calculated           = 0x0008
42          };
43 };
44
45 /** Possible attributes an object can have. */
46 class info_flags {
47 public:
48     enum { 
49            // answered by class numeric
50            numeric,
51            real,
52            rational,
53            integer,
54            crational,
55            cinteger,
56            positive,
57            negative,
58            nonnegative,
59            posint,
60            negint,
61            nonnegint,
62            even,
63            odd,
64            prime,
65
66            // answered by class relation
67            relation,
68            relation_equal,
69            relation_not_equal,
70            relation_less,
71            relation_less_or_equal,
72            relation_greater,
73            relation_greater_or_equal,
74
75            // answered by class symbol
76            symbol,
77
78            // answered by class lst
79            list,
80
81            // answered by class exprseq
82            exprseq,
83
84            // answered by classes numeric, symbol, add, mul, power
85            polynomial,
86            integer_polynomial,
87            cinteger_polynomial,
88            rational_polynomial,
89            crational_polynomial,
90            rational_function,
91
92            // answered by class ex
93            normal_form,
94            
95            // answered by class indexed
96            indexed,      // class can carry indices
97            has_indices,  // object has at least one index
98
99            // answered by class idx
100            idx,
101
102            // answered by class coloridx
103            coloridx,
104
105            // answered by class lorentzidx
106            lorentzidx
107     };
108 };
109
110 class return_types {
111 public:
112     enum { commutative, noncommutative, noncommutative_composite};
113 };
114
115 class csrc_types {
116 public:
117         enum {
118                 ctype_float,
119                 ctype_double,
120                 ctype_cl_N
121         };
122 };
123
124 #ifndef NO_GINAC_NAMESPACE
125 } // namespace GiNaC
126 #endif // ndef NO_GINAC_NAMESPACE
127
128 #endif // ndef __GINAC_FLAGS_H__