- prepared for 1.0.13 release
[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-2003 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 precedence(void) const {return 38;} // for clarity just below add::precedence
47         unsigned nops(void) const;
48         ex op(int i) const;
49         ex &let_op(int i);
50         int degree(const ex &s) const;
51         int ldegree(const ex &s) const;
52         ex coeff(const ex &s, int n = 1) const;
53         ex collect(const ex &s, bool distributed = false) const;
54         ex eval(int level=0) const;
55         ex evalf(int level=0) const;
56         ex series(const relational & r, int order, unsigned options = 0) const;
57         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
58         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
59         ex expand(unsigned options = 0) const;
60 protected:
61         ex derivative(const symbol & s) const;
62
63         // non-virtual functions in this class
64 public:
65         /** Get the expansion variable. */
66         ex get_var(void) const {return var;}
67
68         /** Get the expansion point. */
69         ex get_point(void) const {return point;}
70
71         /** Convert the pseries object to an ordinary polynomial.
72          *
73          *  @param no_order flag: discard higher order terms */
74         ex convert_to_poly(bool no_order = false) const;
75
76         /** Check whether series is compatible to another series (expansion
77          *  variable and point are the same. */
78         bool is_compatible_to(const pseries &other) const {return var.is_equal(other.var) && point.is_equal(other.point);}
79
80         /** Check whether series has the value zero. */
81         bool is_zero(void) const {return seq.size() == 0;}
82
83         /** Returns true if there is no order term, i.e. the series terminates and
84          *  false otherwise. */
85         bool is_terminating(void) const;
86
87         ex add_series(const pseries &other) const;
88         ex mul_const(const numeric &other) const;
89         ex mul_series(const pseries &other) const;
90         ex power_const(const numeric &p, int deg) const;
91         pseries shift_exponents(int deg) const;
92
93 protected:
94         /** Vector of {coefficient, power} pairs */
95         epvector seq;
96
97         /** Series variable (holds a symbol) */
98         ex var;
99
100         /** Expansion point */
101         ex point;
102 };
103
104
105 // utility functions
106
107 /** Specialization of is_exactly_a<pseries>(obj) for pseries objects. */
108 template<> inline bool is_exactly_a<pseries>(const basic & obj)
109 {
110         return obj.tinfo()==TINFO_pseries;
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_a<>
120  *  @see pseries::convert_to_poly */
121 inline ex series_to_poly(const ex &e)
122 {
123         return (ex_to<pseries>(e).convert_to_poly(true));
124 }
125
126 inline bool is_terminating(const pseries & s)
127 {
128         return s.is_terminating();
129 }
130
131 } // namespace GiNaC
132
133 #endif // ndef __GINAC_SERIES_H__