3 * Collection of all flags used through the GiNaC framework. */
6 * GiNaC Copyright (C) 1999-2004 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_FLAGS_H__
24 #define __GINAC_FLAGS_H__
28 /** Flags to control the behavior of expand(). */
29 class expand_options {
32 expand_indexed = 0x0001, ///< expands (a+b).i to a.i+b.i
33 expand_function_args = 0x0002 ///< expands the arguments of functions
37 /** Flags to control the behavior of subs(). */
41 no_pattern = 0x0001, ///< disable pattern matching
42 subs_no_pattern = 0x0001, // for backwards compatibility
43 algebraic = 0x0002, ///< enable algebraic substitutions
44 subs_algebraic = 0x0002, // for backwards compatibility
45 pattern_is_product = 0x0004, ///< used internally by expairseq::subschildren()
46 pattern_is_not_product = 0x0008 ///< used internally by expairseq::subschildren()
50 /** Flags to decide how conjugate should treat a symbol */
51 class symbol_options {
54 /** Symbol is treated like a complex valued expression */
56 /** Symbol is treated like a real valued expression */
61 /** Flags to control series expansion. */
62 class series_options {
65 /** Suppress branch cuts in series expansion. Branch cuts manifest
66 * themselves as step functions, if this option is not passed. If
67 * it is passed and expansion at a point on a cut is performed, then
68 * the analytic continuation of the function is expanded. */
69 suppress_branchcut = 0x0001
73 /** Switch to control algorithm for determinant computation. */
74 class determinant_algo {
77 /** Let the system choose. A heuristics is applied for automatic
78 * determination of a suitable algorithm. */
80 /** Gauss elimination. If \f$m_{i,j}^{(0)}\f$ are the entries of the
81 * original matrix, then the matrix is transformed into triangular
82 * form by applying the rules
84 * m_{i,j}^{(k+1)} = m_{i,j}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)} / m_{k,k}^{(k)}
86 * The determinant is then just the product of diagonal elements.
87 * Choose this algorithm only for purely numerical matrices. */
89 /** Division-free elimination. This is a modification of Gauss
90 * elimination where the division by the pivot element is not
91 * carried out. If \f$m_{i,j}^{(0)}\f$ are the entries of the
92 * original matrix, then the matrix is transformed into triangular
93 * form by applying the rules
95 * m_{i,j}^{(k+1)} = m_{i,j}^{(k)} m_{k,k}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)}
97 * The determinant can later be computed by inspecting the diagonal
98 * elements only. This algorithm is only there for the purpose of
99 * cross-checks. It is never fast. */
101 /** Laplace elimination. This is plain recursive elimination along
102 * minors although multiple minors are avoided by the algorithm.
103 * Although the algorithm is exponential in complexity it is
104 * frequently the fastest one when the matrix is populated by
105 * complicated symbolic expressions. */
107 /** Bareiss fraction-free elimination. This is a modification of
108 * Gauss elimination where the division by the pivot element is
109 * <EM>delayed</EM> until it can be carried out without computing
110 * GCDs. If \f$m_{i,j}^{(0)}\f$ are the entries of the original
111 * matrix, then the matrix is transformed into triangular form by
114 * m_{i,j}^{(k+1)} = (m_{i,j}^{(k)} m_{k,k}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)}) / m_{k-1,k-1}^{(k-1)}
116 * (We have set \f$m_{-1,-1}^{(-1)}=1\f$ in order to avoid a case
117 * distinction in above formula.) It can be shown that nothing more
118 * than polynomial long division is needed for carrying out the
119 * division. The determinant can then be read of from the lower
120 * right entry. This algorithm is rarely fast for computing
126 /** Switch to control algorithm for linear system solving. */
130 /** Let the system choose. A heuristics is applied for automatic
131 * determination of a suitable algorithm. */
133 /** Gauss elimination. If \f$m_{i,j}^{(0)}\f$ are the entries of the
134 * original matrix, then the matrix is transformed into triangular
135 * form by applying the rules
137 * m_{i,j}^{(k+1)} = m_{i,j}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)} / m_{k,k}^{(k)}
139 * This algorithm is well-suited for numerical matrices but generally
140 * suffers from the expensive division (and computation of GCDs) at
143 /** Division-free elimination. This is a modification of Gauss
144 * elimination where the division by the pivot element is not
145 * carried out. If \f$m_{i,j}^{(0)}\f$ are the entries of the
146 * original matrix, then the matrix is transformed into triangular
147 * form by applying the rules
149 * m_{i,j}^{(k+1)} = m_{i,j}^{(k)} m_{k,k}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)}
151 * This algorithm is only there for the purpose of cross-checks.
152 * It suffers from exponential intermediate expression swell. Use it
153 * only for small systems. */
155 /** Bareiss fraction-free elimination. This is a modification of
156 * Gauss elimination where the division by the pivot element is
157 * <EM>delayed</EM> until it can be carried out without computing
158 * GCDs. If \f$m_{i,j}^{(0)}\f$ are the entries of the original
159 * matrix, then the matrix is transformed into triangular form by
162 * m_{i,j}^{(k+1)} = (m_{i,j}^{(k)} m_{k,k}^{(k)} - m_{i,k}^{(k)} m_{k,j}^{(k)}) / m_{k-1,k-1}^{(k-1)}
164 * (We have set \f$m_{-1,-1}^{(-1)}=1\f$ in order to avoid a case
165 * distinction in above formula.) It can be shown that nothing more
166 * than polynomial long division is needed for carrying out the
167 * division. This is generally the fastest algorithm for solving
168 * linear systems. In contrast to division-free elimination it only
169 * has a linear expression swell. For two-dimensional systems, the
170 * two algorithms are equivalent, however. */
175 /** Flags to store information about the state of an object.
176 * @see basic::flags */
180 dynallocated = 0x0001, ///< heap-allocated (i.e. created by new if we want to be clever and bypass the stack, @see ex::construct_from_basic() )
181 evaluated = 0x0002, ///< .eval() has already done its job
182 expanded = 0x0004, ///< .expand(0) has already done its job (other expand() options ignore this flag)
183 hash_calculated = 0x0008, ///< .calchash() has already done its job
184 not_shareable = 0x0010 ///< don't share instances of this object between different expressions unless explicitly asked to (used by ex::compare())
188 /** Possible attributes an object can have. */
192 // answered by class numeric
209 // answered by class relation
214 relation_less_or_equal,
216 relation_greater_or_equal,
218 // answered by class symbol
221 // answered by class lst
224 // answered by class exprseq
227 // answered by classes numeric, symbol, add, mul, power
232 crational_polynomial,
236 // answered by class indexed
237 indexed, // class can carry indices
238 has_indices, // object has at least one index
240 // answered by class idx
250 noncommutative_composite
254 /** Strategies how to clean up the function remember cache.
255 * @see remember_table */
256 class remember_strategies {
259 delete_never, ///< Let table grow undefinitely
260 delete_lru, ///< Least recently used
261 delete_lfu, ///< Least frequently used
262 delete_cyclic ///< First (oldest) one in list
268 #endif // ndef __GINAC_FLAGS_H__