57cb08c7e37c8268a835f3ebab5bd0e912610060
[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-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_NCMUL_H__
24 #define __GINAC_NCMUL_H__
25
26 #include "exprseq.h"
27
28 namespace GiNaC {
29
30 /** Non-commutative product of expressions. */
31 class ncmul : public exprseq
32 {
33         GINAC_DECLARE_REGISTERED_CLASS(ncmul, exprseq)
34
35         friend class power;
36         friend ex reeval_ncmul(const exvector & v);
37         friend ex hold_ncmul(const exvector & v);
38
39 // member functions
40
41         // other constructors
42 public:
43         ncmul(const ex & lh, const ex & rh);
44         ncmul(const ex & f1, const ex & f2, const ex & f3);
45         ncmul(const ex & f1, const ex & f2, const ex & f3,
46               const ex & f4);
47         ncmul(const ex & f1, const ex & f2, const ex & f3,
48               const ex & f4, const ex & f5);
49         ncmul(const ex & f1, const ex & f2, const ex & f3,
50               const ex & f4, const ex & f5, const ex & f6);
51         ncmul(const exvector & v, bool discardable=false);
52         ncmul(exvector * vp); // vp will be deleted
53
54         // functions overriding virtual functions from base classes
55 public:
56         unsigned precedence() const {return 50;}
57         bool info(unsigned inf) const;
58         int degree(const ex & s) const;
59         int ldegree(const ex & s) const;
60         ex expand(unsigned options=0) const;
61         ex coeff(const ex & s, int n=1) const;
62         ex eval(int level=0) const;
63         ex evalm() const;
64         exvector get_free_indices() const;
65         ex thiscontainer(const exvector & v) const;
66         ex thiscontainer(exvector * vp) const;
67
68 protected:
69         ex derivative(const symbol & s) const;
70         unsigned return_type() const;
71         unsigned return_type_tinfo() const;
72         
73         // new virtual functions which can be overridden by derived classes
74         // none
75
76         // non-virtual functions in this class
77 protected:
78         void do_print(const print_context & c, unsigned level) const;
79         void do_print_csrc(const print_context & c, unsigned level) const;
80         size_t count_factors(const ex & e) const;
81         void append_factors(exvector & v, const ex & e) const;
82         exvector expandchildren(unsigned options) const;
83 public:
84         const exvector & get_factors() const;
85 };
86
87 // friend funtions 
88
89 ex reeval_ncmul(const exvector & v);
90 ex hold_ncmul(const exvector & v);
91
92 // utility functions
93
94 /** Specialization of is_exactly_a<ncmul>(obj) for ncmul objects. */
95 template<> inline bool is_exactly_a<ncmul>(const basic & obj)
96 {
97         return obj.tinfo()==TINFO_ncmul;
98 }
99
100 } // namespace GiNaC
101
102 #endif // ndef __GINAC_NCMUL_H__