pseries.h

Go to the documentation of this file.

/*
 *  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
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef GINAC_SERIES_H
#define GINAC_SERIES_H

#include "basic.h"
#include "expairseq.h"

namespace GiNaC {

class pseries : public basic
{
    GINAC_DECLARE_REGISTERED_CLASS(pseries, basic)

    // other constructors
public:
    pseries(const ex &rel_, const epvector &ops_);

    // functions overriding virtual functions from base classes
public:
    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;
    void archive(archive_node& n) const;
    void read_archive(const archive_node& n, lst& syms);
protected:
    ex derivative(const symbol & s) const;

    // non-virtual functions in this class
public:
    ex get_var() const {return var;}

    ex get_point() const {return point;}

    ex convert_to_poly(bool no_order = false) const;

    bool is_compatible_to(const pseries &other) const {return var.is_equal(other.var) && point.is_equal(other.point);}

    bool is_zero() const {return seq.size() == 0;}

    bool is_terminating() const;

    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:
    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;

protected:
    epvector seq;

    ex var;

    ex point;
};
GINAC_DECLARE_UNARCHIVER(pseries); 


// utility functions

inline ex series_to_poly(const ex &e)
{
    return (ex_to<pseries>(e).convert_to_poly(true));
}

inline bool is_terminating(const pseries & s)
{
    return s.is_terminating();
}

} // namespace GiNaC

#endif // ndef GINAC_SERIES_H