- We now write f(x).series(x==3,5) instead of f(x).series(x,3,5) and
[ginac.git] / ginac / add.h
1 /** @file add.h
2  *
3  *  Interface to GiNaC's sums of expressions. */
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_ADD_H__
24 #define __GINAC_ADD_H__
25
26 #include "expairseq.h"
27
28 #ifndef NO_NAMESPACE_GINAC
29 namespace GiNaC {
30 #endif // ndef NO_NAMESPACE_GINAC
31
32 /** Sum of expressions. */
33 class add : public expairseq
34 {
35     GINAC_DECLARE_REGISTERED_CLASS(add, expairseq)
36
37     friend class mul;
38     friend class ncmul;
39     friend class power;
40
41 // member functions
42
43     // default constructor, destructor, copy constructor assignment operator and helpers
44 public:
45     add();
46     ~add();
47     add(const add & other);
48     const add & operator=(const add & other);
49 protected:
50     void copy(const add & other);
51     void destroy(bool call_parent);
52
53     // other constructors
54 public:
55     add(const ex & lh, const ex & rh);
56     add(const exvector & v);
57     add(const epvector & v);
58     //add(const epvector & v, bool do_not_canonicalize=0);
59     add(const epvector & v, const ex & oc);
60     add(epvector * vp, const ex & oc);
61
62     // functions overriding virtual functions from bases classes
63 public:
64     basic * duplicate() const;
65     void print(ostream & os, unsigned upper_precedence=0) const;
66     void printraw(ostream & os) const;
67     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
68     bool info(unsigned inf) const;
69     int degree(const symbol & s) const;
70     int ldegree(const symbol & s) const;
71     ex coeff(const symbol & s, int n=1) const;
72     ex eval(int level=0) const;
73     ex series(const relational & r, int order) const;
74     ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
75     numeric integer_content(void) const;
76     ex smod(const numeric &xi) const;
77     numeric max_coefficient(void) const;
78     exvector get_indices(void) const;
79     ex simplify_ncmul(const exvector & v) const;
80 protected:
81     ex derivative(const symbol & s) const;
82     int compare_same_type(const basic & other) const;
83     bool is_equal_same_type(const basic & other) const;
84     unsigned return_type(void) const;
85     unsigned return_type_tinfo(void) const;
86     ex thisexpairseq(const epvector & v, const ex & oc) const;
87     ex thisexpairseq(epvector * vp, const ex & oc) const;
88     expair split_ex_to_pair(const ex & e) const;
89     expair combine_ex_with_coeff_to_pair(const ex & e,
90                                          const ex & c) const;
91     expair combine_pair_with_coeff_to_pair(const expair & p,
92                                            const ex & c) const;
93     ex recombine_pair_to_ex(const expair & p) const;
94     ex expand(unsigned options=0) const;
95     
96     // new virtual functions which can be overridden by derived classes
97     // none
98     
99     // non-virtual functions in this class
100     // none
101
102 // member variables
103
104 protected:
105     static unsigned precedence;
106 };
107
108 // global constants
109
110 extern const add some_add;
111 extern const type_info & typeid_add;
112
113 // utility functions
114 inline const add &ex_to_add(const ex &e)
115 {
116         return static_cast<const add &>(*e.bp);
117 }
118
119 #ifndef NO_NAMESPACE_GINAC
120 } // namespace GiNaC
121 #endif // ndef NO_NAMESPACE_GINAC
122
123 #endif // ndef __GINAC_ADD_H__