* Interface to class for extended truncated power series. */
/*
- * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2011 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
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_SERIES_H__
-#define __GINAC_SERIES_H__
+#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
* 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 constructors
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_);
+ unsigned precedence() const {return 38;} // for clarity just below add::precedence
+ size_t nops() const;
+ ex op(size_t i) const;
+ 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 exmap & m, unsigned options = 0) const;
+ ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
+ ex expand(unsigned options = 0) const;
+ ex conjugate() const;
+ ex real_part() const;
+ ex imag_part() const;
+ ex eval_integ() const;
+ ex evalm() const;
+ /** Save (a.k.a. serialize) object into archive. */
+ void archive(archive_node& n) const;
+ /** Read (a.k.a. deserialize) object from archive. */
+ void read_archive(const archive_node& n, lst& syms);
+protected:
+ ex derivative(const symbol & s) const;
- // functions overriding virtual functions from base classes
-public:
- basic *duplicate() const;
- void print(ostream &os, unsigned upper_precedence=0) const;
- void printraw(ostream &os) const;
- unsigned nops(void) const;
- ex op(int i) const;
- ex &let_op(int i);
- 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
+ // 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() const {return var;}
+
+ /** Get the expansion point. */
+ ex get_point() 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() const {return seq.size() == 0;}
+
+ /** Returns true if there is no order term, i.e. the series terminates and
+ * false otherwise. */
+ bool is_terminating() const;
+
+ /** Get coefficients and exponents. */
+ ex coeffop(size_t i) const;
+ ex exponop(size_t i) 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;
+ void print_series(const print_context & c, const char *openbrace, const char *closebrace, const char *mul_sym, const char *pow_sym, unsigned level) const;
+ void do_print(const print_context & c, unsigned level) const;
+ void do_print_latex(const print_latex & c, unsigned level) const;
+ void do_print_tree(const print_tree & c, unsigned level) const;
+ void do_print_python(const print_python & c, unsigned level) const;
+ void do_print_python_repr(const print_python_repr & c, unsigned level) const;
- /** Series variable (holds a symbol) */
- ex var;
+protected:
+ /** Vector of {coefficient, power} pairs */
+ epvector seq;
+
+ /** Series variable (holds a symbol) */
+ ex var;
- /** Expansion point */
- ex point;
+ /** Expansion point */
+ ex point;
};
+GINAC_DECLARE_UNARCHIVER(pseries);
-// 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.
- *
- * @param e expression
- * @return reference to pseries object
- * @see is_ex_of_type */
-inline const pseries &ex_to_pseries(const ex &e)
-{
- return static_cast<const pseries &>(*e.bp);
-}
+// utility functions
/** Convert the pseries object embedded in an expression to an ordinary
* polynomial in the expansion variable. The result is undefined if the
*
* @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();
}
-#ifndef NO_GINAC_NAMESPACE
} // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
-#endif // ndef __GINAC_SERIES_H__
+#endif // ndef GINAC_SERIES_H