* Oops, forgot to cvs add the two new files in last commit.

[ginac.git] / ginac / pseries.h

diff --git a/ginac/pseries.h b/ginac/pseries.h
index 77b55fe862b1416b762348b2b52a5db4f59cc727..823c5ba2c8449192dc4e8ffba8196d8d045784d0 100644 (file)
--- a/ginac/pseries.h
+++ b/ginac/pseries.h
@@ -3,7 +3,7 @@
  *  Interface to class for extended truncated power series. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -36,41 +36,66 @@ class pseries : public basic
 {
        GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)
 
-       // other ctors
+       // other constructors
 public:
        pseries(const ex &rel_, const epvector &ops_);
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
-       unsigned nops(void) const;
-       ex op(int i) const;
-       ex &let_op(int i);
+       unsigned precedence() const {return 38;} // for clarity just below add::precedence
+       size_t nops() const;
+       ex op(size_t i) const;
        int degree(const ex &s) const;
        int ldegree(const ex &s) const;
        ex coeff(const ex &s, int n = 1) const;
-       ex collect(const ex &s) const;
+       ex collect(const ex &s, bool distributed = false) const;
        ex eval(int level=0) const;
        ex evalf(int level=0) const;
        ex series(const relational & r, int order, unsigned options = 0) const;
-       ex subs(const lst & ls, const lst & lr) const;
-       ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
+       ex subs(const exmap & m, unsigned options = 0) const;
+       ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
        ex expand(unsigned options = 0) const;
 protected:
        ex derivative(const symbol & s) const;
 
        // non-virtual functions in this class
 public:
+       /** Get the expansion variable. */
+       ex get_var() const {return var;}
+
+       /** Get the expansion point. */
+       ex get_point() const {return point;}
+
+       /** Convert the pseries object to an ordinary polynomial.
+        *
+        *  @param no_order flag: discard higher order terms */
        ex convert_to_poly(bool no_order = false) const;
-       bool is_compatible_to(const pseries &other) const {return var.compare(other.var) == 0 && point.compare(other.point) == 0;}
-       bool is_zero(void) const {return seq.size() == 0;}
-       bool is_terminating(void) const;
+
+       /** Check whether series is compatible to another series (expansion
+        *  variable and point are the same. */
+       bool is_compatible_to(const pseries &other) const {return var.is_equal(other.var) && point.is_equal(other.point);}
+
+       /** Check whether series has the value zero. */
+       bool is_zero() const {return seq.size() == 0;}
+
+       /** Returns true if there is no order term, i.e. the series terminates and
+        *  false otherwise. */
+       bool is_terminating() const;
+
        ex add_series(const pseries &other) const;
        ex mul_const(const numeric &other) const;
        ex mul_series(const pseries &other) const;
        ex power_const(const numeric &p, int deg) const;
        pseries shift_exponents(int deg) const;
 
+protected:
+       void print_series(const print_context & c, const char *openbrace, const char *closebrace, const char *mul_sym, const char *pow_sym, unsigned level) const;
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
+       void do_print_python(const print_python & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
+
 protected:
        /** Vector of {coefficient, power} pairs */
        epvector seq;
@@ -80,20 +105,15 @@ protected:
 
        /** Expansion point */
        ex point;
-
-       static unsigned precedence;
 };
 
-/** Return a reference to the pseries object embedded in an expression.
- *  The result is undefined if the expression does not contain a pseries
- *  object at its top level.
- *
- *  @param e expression
- *  @return reference to pseries object
- *  @see is_ex_of_type */
-inline const pseries &ex_to_pseries(const ex &e)
+
+// utility functions
+
+/** Specialization of is_exactly_a<pseries>(obj) for pseries objects. */
+template<> inline bool is_exactly_a<pseries>(const basic & obj)
 {
-       return static_cast<const pseries &>(*e.bp);
+       return obj.tinfo()==TINFO_pseries;
 }
 
 /** Convert the pseries object embedded in an expression to an ordinary
@@ -102,11 +122,11 @@ inline const pseries &ex_to_pseries(const ex &e)
  *
  *  @param e expression
  *  @return polynomial expression
- *  @see is_ex_of_type
+ *  @see is_a<>
  *  @see pseries::convert_to_poly */
 inline ex series_to_poly(const ex &e)
 {
-       return (static_cast<const pseries &>(*e.bp).convert_to_poly(true));
+       return (ex_to<pseries>(e).convert_to_poly(true));
 }
 
 inline bool is_terminating(const pseries & s)