- first implementation of pattern matching

[ginac.git] / ginac / pseries.h

diff --git a/ginac/pseries.h b/ginac/pseries.h
index 8f041d38d0ec6f08a0732859b7830f93b952f0d2..72586eaf96648cdff54627260afc8a1cc08c766d 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-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2001 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
@@ -23,12 +23,10 @@
 #ifndef __GINAC_SERIES_H__
 #define __GINAC_SERIES_H__
 
-#include <ginac/basic.h>
-#include <ginac/expairseq.h>
+#include "basic.h"
+#include "expairseq.h"
 
-#ifndef NO_GINAC_NAMESPACE
 namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
 
 /** This class holds a extended truncated power series (positive and negative
  *  integer powers). It consists of expression coefficients (only non-zero
@@ -36,61 +34,73 @@ namespace GiNaC {
  *  Other classes must provide members to convert into this type. */
 class pseries : public basic
 {
-    GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)
+       GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)
 
-    // default constructor, destructor, copy constructor, assignment operator and helpers
+       // other ctors
 public:
-    pseries();
-    ~pseries();
-    pseries(pseries const &other);
-    pseries const &operator=(pseries const &other);
-protected:
-    void copy(pseries const &other);
-    void destroy(bool call_parent);
+       pseries(const ex &rel_, const epvector &ops_);
 
-    // other constructors
+       // functions overriding virtual functions from base classes
 public:
-    pseries(ex const &var_, ex const &point_, epvector const &ops_);
+       void print(const print_context & c, unsigned level = 0) const;
+       unsigned precedence(void) const {return 38;} // for clarity just below add::precedence
+       unsigned nops(void) const;
+       ex op(int i) const;
+       ex &let_op(int i);
+       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, 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, bool no_pattern = false) const;
+       ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
+       ex expand(unsigned options = 0) const;
+protected:
+       ex derivative(const symbol & s) const;
 
-    // functions overriding virtual functions from base classes
+       // non-virtual functions in this class
 public:
-    basic *duplicate() const;
-    void print(ostream &os, unsigned upper_precedence=0) const;
-    void printraw(ostream &os) const;
-    int degree(symbol const &s) const;
-    int ldegree(symbol const &s) const;
-    ex coeff(symbol const &s, int const n=1) const;
-    ex eval(int level=0) const;
-    ex evalf(int level=0) const;
-    ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
-    ex diff(symbol const & s) const;
-    ex subs(lst const & ls, lst const & lr) const;
-
-    // non-virtual functions in this class
-public:
-    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;}
-    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;
+       /** Get the expansion variable. */
+       ex get_var(void) const {return var;}
+
+       /** Get the expansion point. */
+       ex get_point(void) 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;
+
+       /** 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(void) const {return seq.size() == 0;}
+
+       /** Returns true if there is no order term, i.e. the series terminates and
+        *  false otherwise. */
+       bool is_terminating(void) 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:
-    /** Vector of {coefficient, power} pairs */
-    epvector seq;
+       /** Vector of {coefficient, power} pairs */
+       epvector seq;
 
-    /** Series variable (holds a symbol) */
-    ex var;
+       /** Series variable (holds a symbol) */
+       ex var;
 
-    /** Expansion point */
-    ex point;
+       /** Expansion point */
+       ex point;
 };
 
-// global constants
-extern const pseries some_pseries;
-extern type_info const & typeid_pseries;
-
 /** 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.
@@ -116,8 +126,11 @@ inline ex series_to_poly(const ex &e)
        return (static_cast<const pseries &>(*e.bp).convert_to_poly(true));
 }
 
-#ifndef NO_GINAC_NAMESPACE
+inline bool is_terminating(const pseries & s)
+{
+       return s.is_terminating();
+}
+
 } // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
 
 #endif // ndef __GINAC_SERIES_H__