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-2001 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 nonsimplified_ncmul(const exvector & v);
  37         friend ex simplified_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         void print(const print_context & c, unsigned level = 0) const;
  57         unsigned precedence(void) const {return 50;}
  58         bool info(unsigned inf) const;
  59         int degree(const ex & s) const;
  60         int ldegree(const ex & s) const;
  61         ex expand(unsigned options=0) const;
  62         ex coeff(const ex & s, int n=1) const;
  63         ex eval(int level=0) const;
  64         ex evalm(void) const;
  65         exvector get_free_indices(void) const;
  66         ex thisexprseq(const exvector & v) const;
  67         ex thisexprseq(exvector * vp) const;
  68 protected:
  69         ex derivative(const symbol & s) const;
  70         unsigned return_type(void) const;
  71         unsigned return_type_tinfo(void) 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         unsigned count_factors(const ex & e) const;
  79         void append_factors(exvector & v, const ex & e) const;
  80         exvector expandchildren(unsigned options) const;
  81 public:
  82         const exvector & get_factors(void) const;
  83 };
  84
  85 // friend funtions
  86
  87 ex nonsimplified_ncmul(const exvector & v);
  88 ex simplified_ncmul(const exvector & v);
  89
  90 // utility functions
  91
  92 /** Specialization of is_exactly_a<ncmul>(obj) for ncmul objects. */
  93 template<> inline bool is_exactly_a<ncmul>(const basic & obj)
  94 {
  95         return obj.tinfo()==TINFO_ncmul;
  96 }
  97
  98 } // namespace GiNaC
  99
 100 #endif // ndef __GINAC_NCMUL_H__