- renamed
[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-2001 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 namespace GiNaC {
30
31 /** This class holds a extended truncated power series (positive and negative
32  *  integer powers). It consists of expression coefficients (only non-zero
33  *  coefficients are stored), an expansion variable and an expansion point.
34  *  Other classes must provide members to convert into this type. */
35 class pseries : public basic
36 {
37         GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)
38
39         // other ctors
40 public:
41         pseries(const ex &rel_, const epvector &ops_);
42
43         // functions overriding virtual functions from base classes
44 public:
45         void print(const print_context & c, unsigned level = 0) const;
46         unsigned nops(void) const;
47         ex op(int i) const;
48         ex &let_op(int i);
49         int degree(const ex &s) const;
50         int ldegree(const ex &s) const;
51         ex coeff(const ex &s, int n = 1) const;
52         ex collect(const ex &s) const;
53         ex eval(int level=0) const;
54         ex evalf(int level=0) const;
55         ex series(const relational & r, int order, unsigned options = 0) const;
56         ex subs(const lst & ls, const lst & lr) const;
57         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
58         ex expand(unsigned options = 0) const;
59 protected:
60         ex derivative(const symbol & s) const;
61
62         // non-virtual functions in this class
63 public:
64         /** Get the expansion variable. */
65         ex get_var(void) const {return var;}
66
67         /** Get the expansion point. */
68         ex get_point(void) const {return point;}
69
70         /** Convert the pseries object to an ordinary polynomial.
71          *
72          *  @param no_order flag: discard higher order terms */
73         ex convert_to_poly(bool no_order = false) const;
74
75         /** Check whether series is compatible to another series (expansion
76          *  variable and point are the same. */
77         bool is_compatible_to(const pseries &other) const {return var.is_equal(other.var) && point.is_equal(other.point);}
78
79         /** Check whether series has the value zero. */
80         bool is_zero(void) const {return seq.size() == 0;}
81
82         /** Returns true if there is no order term, i.e. the series terminates and
83          *  false otherwise. */
84         bool is_terminating(void) const;
85
86         ex add_series(const pseries &other) const;
87         ex mul_const(const numeric &other) const;
88         ex mul_series(const pseries &other) const;
89         ex power_const(const numeric &p, int deg) const;
90         pseries shift_exponents(int deg) const;
91
92 protected:
93         /** Vector of {coefficient, power} pairs */
94         epvector seq;
95
96         /** Series variable (holds a symbol) */
97         ex var;
98
99         /** Expansion point */
100         ex point;
101
102         static unsigned precedence;
103 };
104
105 /** Return a reference to the pseries object embedded in an expression.
106  *  The result is undefined if the expression does not contain a pseries
107  *  object at its top level.
108  *
109  *  @param e expression
110  *  @return reference to pseries object
111  *  @see is_ex_of_type */
112 inline const pseries &ex_to_pseries(const ex &e)
113 {
114         return static_cast<const pseries &>(*e.bp);
115 }
116
117 /** Convert the pseries object embedded in an expression to an ordinary
118  *  polynomial in the expansion variable. The result is undefined if the
119  *  expression does not contain a pseries object at its top level.
120  *
121  *  @param e expression
122  *  @return polynomial expression
123  *  @see is_ex_of_type
124  *  @see pseries::convert_to_poly */
125 inline ex series_to_poly(const ex &e)
126 {
127         return (static_cast<const pseries &>(*e.bp).convert_to_poly(true));
128 }
129
130 inline bool is_terminating(const pseries & s)
131 {
132         return s.is_terminating();
133 }
134
135 } // namespace GiNaC
136
137 #endif // ndef __GINAC_SERIES_H__