]> www.ginac.de Git - ginac.git/blobdiff - ginac/pseries.h
- prepared for 1.0.13 release
[ginac.git] / ginac / pseries.h
index f7c32aa505bfd25423c1bdbb9951bafd50e1902a..26c27306250a03a03177764962efc32734349cfc 100644 (file)
@@ -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-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
@@ -26,9 +26,7 @@
 #include "basic.h"
 #include "expairseq.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 /** This class holds a extended truncated power series (positive and negative
  *  integer powers). It consists of expression coefficients (only non-zero
@@ -36,81 +34,80 @@ 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(const pseries &other);
-    const pseries &operator=(const pseries &other);
-protected:
-    void copy(const pseries &other);
-    void destroy(bool call_parent);
-
-    // other constructors
-public:
-    pseries(const ex &rel_, const epvector &ops_);
+       pseries(const ex &rel_, const epvector &ops_);
 
-    // functions overriding virtual functions from base classes
+       // functions overriding virtual functions from base classes
 public:
-    basic *duplicate() const;
-    void print(std::ostream &os, unsigned upper_precedence = 0) const;
-    void printraw(std::ostream &os) const;
-    void printtree(std::ostream & os, unsigned indent) const;
-    unsigned nops(void) const;
-    ex op(int i) const;
-    ex &let_op(int i);
-    int degree(const symbol &s) const;
-    int ldegree(const symbol &s) const;
-    ex coeff(const symbol &s, int n = 1) const;
-    ex collect(const symbol &s) const;
-    ex eval(int level=0) const;
-    ex evalf(int level=0) const;
-    ex series(const relational & r, int order, bool branchcut = true) const;
-    ex subs(const lst & ls, const lst & lr) const;
-    ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
-    ex expand(unsigned options = 0) const;
+       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;
+       ex derivative(const symbol & s) const;
 
-    // non-virtual functions in this class
+       // 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;}
-    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;
+       /** 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 const type_info & 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.
- *
- *  @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
@@ -119,20 +116,18 @@ 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)
 {
-    return s.is_terminating();
+       return s.is_terminating();
 }
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_SERIES_H__