- Overwritten: pseries::printtree().
[ginac.git] / ginac / pseries.h
1 /** @file pseries.h
2  *
3  *  Interface to class for extended truncated power series. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_SERIES_H__
24 #define __GINAC_SERIES_H__
25
26 #include "basic.h"
27 #include "expairseq.h"
28
29 #ifndef NO_NAMESPACE_GINAC
30 namespace GiNaC {
31 #endif // ndef NO_NAMESPACE_GINAC
32
33 /** This class holds a extended truncated power series (positive and negative
34  *  integer powers). It consists of expression coefficients (only non-zero
35  *  coefficients are stored), an expansion variable and an expansion point.
36  *  Other classes must provide members to convert into this type. */
37 class pseries : public basic
38 {
39     GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)
40
41     // default constructor, destructor, copy constructor, assignment operator and helpers
42 public:
43     pseries();
44     ~pseries();
45     pseries(const pseries &other);
46     const pseries &operator=(const pseries &other);
47 protected:
48     void copy(const pseries &other);
49     void destroy(bool call_parent);
50
51     // other constructors
52 public:
53     pseries(const ex &rel_, const epvector &ops_);
54
55     // functions overriding virtual functions from base classes
56 public:
57     basic *duplicate() const;
58     void print(ostream &os, unsigned upper_precedence=0) const;
59     void printraw(ostream &os) const;
60     void printtree(ostream & os, unsigned indent) const;
61     unsigned nops(void) const;
62     ex op(int i) const;
63     ex &let_op(int i);
64     int degree(const symbol &s) const;
65     int ldegree(const symbol &s) const;
66     ex coeff(const symbol &s, int n=1) const;
67     ex collect(const symbol &s) const;
68     ex eval(int level=0) const;
69     ex evalf(int level=0) const;
70     ex series(const relational & r, int order) const;
71     ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
72     ex subs(const lst & ls, const lst & lr) const;
73 protected:
74     ex derivative(const symbol & s) const;
75
76     // non-virtual functions in this class
77 public:
78     ex convert_to_poly(bool no_order = false) const;
79     bool is_compatible_to(const pseries &other) const {return var.compare(other.var) == 0 && point.compare(other.point) == 0;}
80     bool is_zero(void) const {return seq.size() == 0;}
81     ex add_series(const pseries &other) const;
82     ex mul_const(const numeric &other) const;
83     ex mul_series(const pseries &other) const;
84     ex power_const(const numeric &p, int deg) const;
85
86 protected:
87     /** Vector of {coefficient, power} pairs */
88     epvector seq;
89
90     /** Series variable (holds a symbol) */
91     ex var;
92
93     /** Expansion point */
94     ex point;
95 };
96
97 // global constants
98 extern const pseries some_pseries;
99 extern const type_info & typeid_pseries;
100
101 /** Return a reference to the pseries object embedded in an expression.
102  *  The result is undefined if the expression does not contain a pseries
103  *  object at its top level.
104  *
105  *  @param e expression
106  *  @return reference to pseries object
107  *  @see is_ex_of_type */
108 inline const pseries &ex_to_pseries(const ex &e)
109 {
110         return static_cast<const pseries &>(*e.bp);
111 }
112
113 /** Convert the pseries object embedded in an expression to an ordinary
114  *  polynomial in the expansion variable. The result is undefined if the
115  *  expression does not contain a pseries object at its top level.
116  *
117  *  @param e expression
118  *  @return polynomial expression
119  *  @see is_ex_of_type
120  *  @see pseries::convert_to_poly */
121 inline ex series_to_poly(const ex &e)
122 {
123         return (static_cast<const pseries &>(*e.bp).convert_to_poly(true));
124 }
125
126 #ifndef NO_NAMESPACE_GINAC
127 } // namespace GiNaC
128 #endif // ndef NO_NAMESPACE_GINAC
129
130 #endif // ndef __GINAC_SERIES_H__