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