documentation update
[ginac.git] / NEWS
1 This file records noteworthy changes.
2
3 1.2.0 (<insert date>)
4 * Added a structure<T> template class for the easy creation of user-defined
5   algebraic classes.
6 * Added support for (acyclic) visitors, to allow cleaner implementations of
7   algebraic algorithms.
8 * <iterators>
9 * Completely revamped the implementation of expression output. It is now
10   possible to add new output formats, to change the behavior of predefined
11   formats at run-time, and to have different output styles for algebraic
12   functions.
13 * Symbols can be made non-commutative.
14 * Improved the speed of subs(), normal(), to_rational() and to_polynomial()
15   by the use of maps instead of lists. The old forms
16     subs(const lst & ls, const lst & lr, unsigned options)
17     to_rational/to_polynomial(lst & repl)
18   are still available for compatibility, but using the new forms
19     subs(const exmap & m, unsigned options)
20     to_rational/to_polynomial(exmap & repl)
21   is more efficient, especially when the number of replacements is large.
22 * quo(), rem(), prem(), sprem(), decomp_rational(), unit(), content(),
23   primpart() and matrix::charpoly() now take a "const ex &" instead of a
24   "const symbol &".
25 * <object fusion>
26 * Lots of internal streamlining and optimizations.
27 * Caveats for class implementors:
28    - basic::copy() and basic::destroy() are gone; classes derived from
29      basic can use the defaults for the assignment operator and copy
30      constructor.
31    - basic::subs(), basic::normal(), basic::to_rational() and
32      basic::to_polynomial() take 'exmap' objects instead of lists.
33    - basic::subs() now descends into subexpressions (if accessible via
34      nops()/op()/let_op()). If you have a custom implementation of subs()
35      that calls basic::subs() after substituting subexpressions, this needs
36      to be changed to a call to subs_one_level().
37    - lst::thislst() and exprseq::thisexprseq() renamed to thiscontainer().
38    - thiscontainer() and associated constructors now take a std::auto_ptr.
39    - Overloading basic::print() is now deprecated. You should use
40      print_func<>() class options instead.
41
42 1.1.0 (3 April 2003)
43 * Removed deprecated macros is_ex_a, is_ex_exactly_a and friends for good.
44 * The scalar_products mechanism allows the specification of an index dimension.
45 * Removed dirac_gamma6/7().
46 * Added ex::to_polynomial().
47 * subs() accepts an optional "options" argument. The option
48   subs_option::subs_algebraic enables "smart" substitutions in products and
49   powers.
50 * Added stream manipulators "dflt", "latex", "python", "python_repr", "tree",
51   "csrc", "csrc_float", "csrc_double", "csrc_cl_N", "index_dimensions" and
52   "no_index_dimensions" to control the output format. Calling basic::print()
53   directly is now deprecated.
54 * Made the hashing more simple and efficient.
55 * Caveats for class implementors:
56    - basic::subs(): third argument changed from "bool" to "unsigned"
57    - unarchiving constructor and basic::unarchive(): "const" removed from
58      second argument
59    - basic::let_op() should only be implemented if write access to
60      subexpressions is desired
61    - simplify_ncmul() renamed to eval_ncmul()
62    - simplified_ncmul() renamed to hold_ncmul()
63    - nonsimplified_ncmul() renamed to reeval_ncmul()
64
65 1.0.14 (1 March 2003)
66 * Improved the C-source output: complex numbers are printed correctly (using
67   the STL complex<> template or cln::complex()), rational numbers use cl_RA()
68   in the CLN output, and small integers are printed in a more compact format
69   (e.g. "2.0" instead of "2.0000000e+00").
70 * function_options::set_return_type() and function_options::do_not_evalf_params()
71   now actually work.
72
73 1.0.13 (27 January 2003)
74 * Contracting epsilon tensors with Euclidean indices now works.
75 * Improved dummy index symmetrization in sums.
76 * Added dirac_gammaL/R(), which can be used instead of dirac_gamma6/7()
77   but are single objects, to allow for a more compact notation of Dirac
78   strings.
79 * Powers with negative numeric exponents are printed as fractions in the
80   LaTeX output.
81 * Added symbolic_matrix() for the convenient creation of matrices filled
82   with symbols.
83 * Added collect_common_factors() which collects common factors from the
84   terms of sums.
85 * simplify_indexed() converts "gamma~mu*p.mu" to "p\".
86
87 1.0.12 (30 October 2002)
88 * Fixed a bug in power::expand() that could produce invalid expressions.
89 * The input parser no longer ignores extra data following accepted input.
90 * Improved the CLN C-source output (integers are printed as integers, and
91   floating point numbers include the precision).
92 * Fixed a problem in the LaTeX-output of negative fractions.
93 * Added print_latex() and print_csrc() to ginsh.
94 * The sprem() function is now public.
95
96 1.0.11 (18 September 2002)
97 * Fixed a possible memory corruption in contractions of indexed objects with
98   delta or metric tensors.
99 * Computing the derivative of a power series object with respect to a symbol
100   that is not the expansion variable now works correctly.
101 * Several bugfixes in code generation.
102
103 1.0.10 (24 July 2002)
104 * Powers of indexed objects are now parenthesized correctly in LaTeX output.
105 * Input parser handles indices (they have to be specified in the same list
106   as the symbols).
107 * Added some limited support for subspaces in the idx and tensor classes.
108 * Fixed a bug in canonicalize() (antisymmetric canonicalization of an already
109   sorted list containing two or more equal objects failed to return 0).
110
111 1.0.9 (11 June 2002)
112 * simplify_indexed() now raises/lowers dummy indices to canonicalize the index
113   variance. This allows some simplifications that weren't possible before,
114   like eps~a.b~c~d*X.a*X~b -> 0 and X.a~a-X~a.a -> 0.
115 * Implemented relational::subs().
116 * Fixed bug in simplify_ncmul() for clifford objects.
117
118 1.0.8 (31 March 2002)
119 * Improvements in memory usage of the expand() methods.
120
121 1.0.7 (18 March 2002)
122 * Fixed LaTeX output of indexed and matrix objects.
123 * Fixed matrix::pow(n) for n==0 and added helper functions to create unit
124   matrices "ex unit_matrix(unsigned, unsigned)".
125
126 1.0.6 (4 March 2002)
127 * "(x+1).subs(x==x-1)" now returns the correct result "x" instead of "x-1".
128
129 1.0.5 (27 January 2002)
130 * (l)degree(s), coeff(s, n) and collect(s) were extended to accept expressions
131   of any class (except add/mul/ncmul/numeric) for "s". They should even work
132   if "s" is a "power" object, as long as the exponent is non-integer, but with
133   some limitations. For example, you can "collect(a*2^x+b*2^x, 2^x)" to get
134   "(a+b)*2^x", but "degree(2^(3*x), 2^x)" yields 0 instead of 3).
135 * Fixed a small output bug.
136
137 1.0.4 (24 January 2002)
138 * Speedup in expand().
139 * Faster Bernoulli numbers (Markus Nullmeier).
140 * Some minor bugfixes and documentation updates.
141
142 1.0.3 (21 December 2001)
143 * Fixed a bug where quo() would call vector::reserve() with a negative
144   argument.
145 * Fix several bugs in code generation.
146
147 1.0.2 (19 December 2001)
148 * Input parser recognizes "sqrt()", which is also used in the output.
149 * divide(a,b,q) only modifies q if the division succeeds; also, divide(a,b,a)
150   works now.
151 * Fixed small bug in dummy index renaming which could cause it to not
152   recognize renamable indices in some cases.
153 * power::degree() and power::ldegree() throw an exception when encountering
154   a non-integer exponent.
155 * Add output-support for Python bindings.
156
157 1.0.1 (22 November 2001)
158 * Function sqrfree() handles a few more cases now.
159 * Class relational has real canonical ordering now.
160 * Handle obscene libreadline version numbers when building ginsh.
161
162 1.0.0 (6 November 2001)
163 * Some internal reorganization resulting in a general speed-up.
164 * The last 3 evaluated expressions in ginsh are now referred to with the
165   tokens '%', '%%' and '%%%'. The old '"', '""' and '"""' remain for
166   compatibility but may be removed in a future version of GiNaC.
167
168 0.9.4 (20 September 2001)
169 * Functions have better support for external scripting languages.
170 * Interface cleanups and bugfixes.
171 * Fix silly bug in evalf() that prevented things like 2^Pi being computed.
172
173 0.9.3 (16 August 2001)
174 * series expansion now much more consistent for small order expansion.
175 * lsolve() accepts algorithmic hint as parameter.
176
177 0.9.2 (31 July 2001)
178 * Epsilon tensor is more functional.
179 * simplify_indexed() is better at detecting expressions that vanish for
180   symmetry reasons.
181 * Several little bugfixes and consistency enhancements.
182
183 0.9.1 (27 June 2001)
184 * Ctors of class numeric are not explicit any more.  All built-in callers for
185   pseudofunctions are now templated and default to ex arguments which relaxes
186   the need for explicit ctors.
187 * New functions/methods:
188    - find()
189    - remove_first(), remove_last(), sort() and unique() for lists
190    - symmetrize_cyclic()
191    - decomp_rational()
192 * Instead of just totally symmetric or antisymmetric, complex symmetries
193   can now be defined for indexed objects. Symmetries are described by a
194   tree of "symmetry" objects that is constructed with the sy_none(),
195   sy_symm(), sy_anti() and sy_cycl() functions. The symmetry of a function
196   with respect to its arguments can also be defined (this is currently
197   only used for the Beta function).
198 * Generalized map() to take a function object instead of a function pointer.
199   This allows passing an arbitrary number of additional state to the
200   function being called.
201 * color_trace(), dirac_trace(), diff(), expand(), evalf() and normal() work
202   better with container classes, e.g. using color_trace() on a relation will
203   take the trace on both sides, using diff() on a matrix differentiates every
204   element etc.
205 * diff() works properly with non-commutative products and indexed objects.
206 * New option flag "expand_function_args" for expand().
207 * Supplement some (now deprecated) macros by inlined template functions:
208   - is_of_type(foo, type) -> is_a<type>(foo)
209   - is_ex_of_type(foo, type) -> is_a<type>(foo)
210   - is_exaclty_of_type(foo, type) -> is_exaclty_a<type>(foo)
211   - is_ex_exaclty_of_type(foo, type) -> is_exaclty_a<type>(foo)
212   - ex_to_foobar(baz)  ->  ex_to<foobar>(baz)
213 * rem(c, p[x], x) (c: numeric, p[x]: polynomial) erroneously returned p[x]
214   instead of c.
215 * Small bugfixes in pattern matching.
216 * Updated libtool to version 1.4.
217
218 0.9.0 (7 June 2001)
219 * In the output and in ginsh, lists are now delimited by { } braces, and
220   matrices are delimited by single [ ] brackets.
221 * simplify_indexed() renames dummy indices so, e.g., "a.i*a.i+a.j*a.j" gets
222   simplified to "2*a.i*a.i" (or "2*a.j*a.j").
223 * New functions/methods:
224    - canonicalize_clifford() (helpful when comparing expressions containing
225      Dirac matrices)
226    - symmetrize() and antisymmetrize()
227    - numer_denom() (return numerator and denominator in one call)
228    - map() (apply function to subexpressions)
229    - evalm() (evaluate sums, products and integer powers of matrices)
230 * Added a new function match() for performing pattern matching. subs() and
231   has() also accept patterns as arguments. A pattern can be any expression,
232   optionally containing wildcard objects. These are constructed with the
233   call "wild(<unsigned>)" and are denoted as "$0", "$1" etc. in the output
234   and in ginsh.
235 * Positive integer powers of non-commutative expressions (except matrices)
236   are automatically expanded.
237 * Removed cint subdirectory, ginaccint is a separate package now due to 
238   packaging considerations.
239 * Several little bugfixes.
240
241 0.8.3 (11 May 2001)
242 * color and clifford classes are functional and documented.
243 * New "spinidx" class for dotted/undotted indices.
244 * Predefined spinor metric tensor (created by spinor_metric()).
245 * Symbols can have a LaTeX name, e.g. symbol s("s", "\\sigma");
246 * LaTeX output of indexed objects is much nicer.
247 * Fixed some build problems (with recent libreadline).
248 * Semantics of arithmetic operators now follows the C++ rules more strictly.
249
250 0.8.2 (24 April 2001)
251 * degree(), ldegree(), coeff(), lcoeff(), tcoeff() and collect() work with
252   non-symbols as the second argument in ginsh.
253 * the argument to collect() can be a list of objects in which case the
254   result is either a recursively collected polynomial, or a polynomial in
255   a distributed form with terms like coeff*x1^e1*...*xn^en, as specified by
256   the second argument to collect().
257 * Several bugfixes (including a nasty memory leak in .normal()).
258 * class matrix: solve() doesn't call algorithms redundantly any more and
259   inverse() falls back to solve() which works in more general cases.
260
261 0.8.1 (16 April 2001)
262 * degree(), ldegree(), coeff(), lcoeff(), tcoeff() and collect() can now
263   be used with constants, functions and indexed expressions as well, so you
264   can use it to collect by powers of Pi or sin(x), or to find the coefficient
265   of gamma~0.
266   Limitations:
267    - it only works with symbols, constants, functions and indexed expressions,
268      trying to find the coefficient of, e.g., "x^2" or "x+y" won't work;
269    - it does not know about dummy index summations; the coefficient of
270      gamma~0 in p.mu*gamma~mu should be p.0 but is returned as 0;
271    - using coeff(), tcoeff(), lcoeff() or collect() on elements of
272      noncommutative products might return wrong or surprising results.
273 * subs() no longer only substitutes symbols and indices but performs a more
274   general "syntactic substitution", i.e. it substitutes whole objects in sub-
275   expressions. You can subs((a+b)^2,a+b==3) and get 9, but subs(a+b+c,a+b==3)
276   doesn't do anything.
277   Limitations:
278    - substituting numerics (subs(expr, 2==4)) will not replace then in all
279      occurences; in general, you shouldn't substitute numerics, though.
280 * Added preliminary (re)implementations of color and clifford classes.
281 * simplify_indexed(): contraction of symmetric and antisymmetric tensors
282   is zero.
283 * Replaced the various print*() member functions by a single print() that
284   takes a print_context object that determines the output formatting. This
285   should make it easier to add more output types, such as LaTeX output,
286   which is based on work by Stefan Weinzierl.
287 * Added functions to retrieve the properties stored in archive objects
288   outside of unarchive() (for printing or debugging purposes).
289 * Some bugfixes (indexed objects, archive writing).
290 * .collect() on non-polynomials is now algebraically correct.
291
292 0.8.0 (24 March 2001)
293 * Complete revamp of indexed objects. Instead of multiple classes for
294   indexed things and their indices there is now only one "indexed" class
295   and two types of indices: "idx" for simple indices and "varidx" for
296   indices with variance. There are predefined delta, epsilon and metric
297   tensors, and a function simplify_indexed() that performs canonicalization
298   and dummy index summations. Matrix objects can be indexed for doing simple
299   linear algebra.
300 * Added an option "expand_indexed" to expand() to perform expansion of
301   indexed objects like (a+b).i -> a.i + b.i
302 * Renamed get_indices() to get_free_indices(), which no longer returns
303   dummy indices and checks the consistency of indices in sums.
304 * sqrfree() factorization fixed and improved syntactically.
305 * subs() works on matrices.
306 * Matrices can be constructed from flat list of elements; diagonal matrices
307   can be constructed from list of diagonal elements with diag_matrix().
308 * Fixed memory leak in expand().
309 * Operator% for objects of class ncmul has gone.  Use operator* now for that
310   case too, which is much more natural.
311
312 0.7.3 (28 February 2001)
313 * Several bugfixes and minor performance tunings.
314 * Added a section to the tutorial about adding new algebraic classes to GiNaC.
315 * Closed many in-source documentation gaps.
316
317 0.7.2 (17 February 2001)
318 * Several bugfixes in power series expansion, one of them critical.
319
320 0.7.1 (7 February 2001)
321 * Fix problems with Cint that were caused by CLN's overloaded operator new.
322 * Fix compilation errors with GCC3.
323 * normal() handles large sums of fractions better and normalizes the exponent
324   of power expressions.
325 * expand() always expands the exponent and transforms x^(a+b) -> x^a*x^b.
326 * Some bugfixes of series expansion around branch cuts of special functions.
327
328 0.7.0 (15 December 2000)
329 * Requires CLN 1.1 now.  Class numeric doesn't use an indirect pointer to the
330   actual representation any more.  This is a speedup.
331 * mul::expand() was reengineered to not allocate excess temporary memory.
332 * Non-integer powers of a symbol are treated as constants by (l)degree() and
333   coeff().  Using these functions on an expression containing such powers used
334   to fail with an internal error message.  The side-effect is that collect()
335   can be used on expressions which are not polynomials.
336 * Added a man page for the ginac-config script.
337 * Ctor of numeric from char* honors Digits.
338
339 0.6.4 (10 August 2000)
340 * Complete revamp of methods in class matrix.  Some redundant (and poor)
341   implementations of elimination schemes were thrown out.  The code is now
342   highly orthogonal, more flexible and much more efficient.
343 * Some long standing and quite nasty bugs were discovered and fixed in the
344   following functions: add::normal(), heur_gcd(), sr_gcd() and Order_eval().
345
346 0.6.3 (25 July 2000)
347 * Derivatives are now assembled in a slightly different manner (i.e. they
348   might 'look' different on first sight).  Under certain circumstances this
349   can result in a dramatic speedup because it gives hashing a better chance,
350   especially when computing higher derivatives.
351 * Some series expansions of built-in functions have been reengineered.
352 * The algorithm for computing determinants can be chosen by the user.  See
353   ginac/flags.h and ginac/matrix.h.
354 * The Dilogarithm (Li2) now has floating point evaluation, derivative and a
355   proper series expansion.
356 * Namespace 'std' cleanly disentangled, as demanded by ISO/EIC 14882-1998(E).
357 * Some minor bugfixes, one major lsolve()-bugfix and documentation updates.
358
359 0.6.2 (21 June 2000)
360 * ginaccint.bin is now launched by a binary program instead of by a scripts.
361   This allows us to write #!-scripts.  A small test suite for GiNaC-cint was
362   added.
363 * Several minor bugfixes.
364
365 0.6.1 (18 May 2000)
366 * Cleanup in the interface to Cint.  The required version is now Cint 5.14.38.
367 * Several bugfixes in target install.
368
369 0.6.0 (11 May 2000)
370 * IMPORTANT: Several interface changes make programs written with GiNaC 
371   much clearer but break compatibility with older versions:
372   - f(x).series(x,p[,o]) -> f(x).series(x==p,o)
373   - series(f(x),x,p[,o]) -> series(f(x),x==p,o)
374   - gamma() -> tgamma()  (The true Gamma function, there is now also
375     log(tgamma()), called lgamma(), in accord with ISO/IEC 9899:1999.)
376   - EulerGamma -> Euler
377 * #include'ing ginac.h defines the preprocessor symbols GINACLIB_MAJOR_VERSION,
378   GINACLIB_MINOR_VERSION, and GINACLIB_MICRO_VERSION with the respective GiNaC
379   library version numbers.
380 * Expressions can be constructed from strings like this:
381     ex e("2*x+y", lst(x, y));
382 * ex::to_rational() provides a way to extend the domain of functions like
383   gcd() and divide() that only work on polynomials or rational functions (the
384   good old ex::subs() method reverses this process)
385 * Calling diff() on a function that has no derivative defined returns the
386   inert derivative function "Derivative".
387 * Several new timings in the check target.  Some of them may be rather rude 
388   at your machine, feel free to interrupt them.
389
390 0.5.4 (15 March 2000)
391 * Some algorithms in class matrix (notably determinant) were replaced by
392   less brain-dead ones and should now have much better performance.
393 * Checks were completely reorganized and split up into three parts:
394   a) exams (small regression tests with predefined input)
395   b) checks (lenghty coherence checks with random input)
396   c) timings (for coherence and crude benchmarking)
397 * Behaviour of .evalf() was changed: it doesn't .evalf() any exponents.
398 * Expanded expressions now remember they are expanded to prevent
399   superfluous expansions.
400 * Small bugfixes and improvements in the series expansion.
401
402 0.5.3 (23 February 2000)
403 * A more flexible scheme for registering functions was implemented,
404   allowing for remembering, too.
405 * Some Bugfixes.
406
407 0.5.2 (16 February 2000)
408 * Mainly fixes a bug in the packaging of release 0.5.1.
409
410 0.5.1 (14 February 2000)
411 * Fixes a small number of bugs.
412
413 0.5.0 (7 February 2000)
414 * Expressions can be written ("archived") to files and read therefrom.
415 * Addition of GiNaC-cint, which lets you write complete programs in
416   an interactive shell-like manner in your favoured programming
417   language (i.e. C++).
418
419 0.4.1 (13 December 1999)
420 * Series Expansion of Gamma function and some other trigonometric
421   functions at their poles works now.
422 * Many more evaluations of special functions at points where
423   exact results exist.
424 * info_flags::rational doesn't return true for complex extensions
425   any more---use info_flags::crational for the old behaviour.
426   info_flags::integer and -::cinteger work similarly, the same
427   holds for types like info_flags::rational_polynomial.
428
429 0.4.0 (26 November 1999)
430 * First public release.