- implemented global class registry (for class basic and derived classes)
[ginac.git] / ginac / ncmul.h
1 /** @file ncmul.h
2  *
3  *  Interface to GiNaC's non-commutative products 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_NCMUL_H__
24 #define __GINAC_NCMUL_H__
25
26 #include <ginac/exprseq.h>
27
28 #ifndef NO_GINAC_NAMESPACE
29 namespace GiNaC {
30 #endif // ndef NO_GINAC_NAMESPACE
31
32 /** Non-commutative product of expressions. */
33 class ncmul : public exprseq
34 {
35     GINAC_DECLARE_REGISTERED_CLASS(ncmul, exprseq)
36
37     friend class power;
38     friend ex nonsimplified_ncmul(exvector const & v);
39     friend ex simplified_ncmul(exvector const & v);
40
41 // member functions
42
43     // default constructor, destructor, copy constructor assignment operator and helpers
44 public:
45     ncmul();
46     ~ncmul();
47     ncmul(ncmul const & other);
48     ncmul const & operator=(ncmul const & other);
49 protected:
50     void copy(ncmul const & other);
51     void destroy(bool call_parent);
52
53     // other constructors
54 public:
55     ncmul(ex const & lh, ex const & rh);
56     ncmul(ex const & f1, ex const & f2, ex const & f3);
57     ncmul(ex const & f1, ex const & f2, ex const & f3,
58           ex const & f4);
59     ncmul(ex const & f1, ex const & f2, ex const & f3,
60           ex const & f4, ex const & f5);
61     ncmul(ex const & f1, ex const & f2, ex const & f3,
62           ex const & f4, ex const & f5, ex const & f6);
63     ncmul(exvector const & v, bool discardable=false);
64     ncmul(exvector * vp); // vp will be deleted
65
66     // functions overriding virtual functions from bases classes
67 public:
68     basic * duplicate() const;
69     void print(ostream & os, unsigned upper_precedence) const;
70     void printraw(ostream & os) const;
71     void printcsrc(ostream & os, unsigned upper_precedence) const;
72     bool info(unsigned inf) const;
73     int degree(symbol const & s) const;
74     int ldegree(symbol const & s) const;
75     ex expand(unsigned options=0) const;
76     ex coeff(symbol const & s, int const n=1) const;
77     ex eval(int level=0) const;
78     ex diff(symbol const & s) const;
79     ex subs(lst const & ls, lst const & lr) const;
80     exvector get_indices(void) const;
81     ex thisexprseq(exvector const & v) const;
82     ex thisexprseq(exvector * vp) const;
83 protected:
84     int compare_same_type(basic const & other) const;
85     unsigned return_type(void) const;
86     unsigned return_type_tinfo(void) const;
87     
88     // new virtual functions which can be overridden by derived classes
89     // none
90
91     // non-virtual functions in this class
92 protected:
93     unsigned count_factors(ex const & e) const;
94     void append_factors(exvector & v, ex const & e) const;
95     exvector expandchildren(unsigned options) const;
96 public:
97     exvector const & get_factors(void) const;
98
99 // member variables
100
101 protected:
102     static unsigned precedence;
103 };
104
105 // global constants
106
107 extern const ncmul some_ncmul;
108 extern type_info const & typeid_ncmul;
109
110 // friend funtions 
111
112 ex nonsimplified_ncmul(exvector const & v);
113 ex simplified_ncmul(exvector const & v);
114
115 // utility functions
116 inline const ncmul &ex_to_ncmul(const ex &e)
117 {
118         return static_cast <const ncmul &>(*e.bp);
119 }
120
121 #ifndef NO_GINAC_NAMESPACE
122 } // namespace GiNaC
123 #endif // ndef NO_GINAC_NAMESPACE
124
125 #endif // ndef __GINAC_NCMUL_H__