ginac/relational.h

   1 /** @file relational.h
   2  *
   3  *  Interface to relations between 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_RELATIONAL_H__
  24 #define __GINAC_RELATIONAL_H__
  25
  26 #include "basic.h"
  27 #include "ex.h"
  28
  29 #ifndef NO_NAMESPACE_GINAC
  30 namespace GiNaC {
  31 #endif // ndef NO_NAMESPACE_GINAC
  32
  33 /** This class holds a relation consisting of two expressions and a logical
  34  *  relation between them. */
  35 class relational : public basic
  36 {
  37         GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
  38
  39 // types
  40 public:
  41         enum operators {
  42                 equal,
  43                 not_equal,
  44                 less,
  45                 less_or_equal,
  46                 greater,
  47                 greater_or_equal
  48         };
  49
  50         // other constructors
  51 public:
  52         relational(const ex & lhs, const ex & rhs, operators oper=equal);
  53
  54         // functions overriding virtual functions from bases classes
  55 public:
  56         void print(std::ostream & os, unsigned upper_precedence=0) const;
  57         void printraw(std::ostream & os) const;
  58         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  59         bool info(unsigned inf) const;
  60         unsigned nops() const;
  61         ex & let_op(int i);
  62         ex eval(int level=0) const;
  63         ex evalf(int level=0) const;
  64         ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
  65         ex simplify_ncmul(const exvector & v) const;
  66 protected:
  67         unsigned return_type(void) const;
  68         unsigned return_type_tinfo(void) const;
  69
  70         // new virtual functions which can be overridden by derived classes
  71 public:
  72         virtual ex lhs(void) const;
  73         virtual ex rhs(void) const;
  74
  75         // non-virtual functions in this class
  76 public:
  77         operator bool(void) const;
  78
  79 // member variables
  80
  81 protected:
  82         ex lh;
  83         ex rh;
  84         operators o;
  85         static unsigned precedence;
  86 };
  87
  88 // utility functions
  89 inline const relational &ex_to_relational(const ex &e)
  90 {
  91         return static_cast<const relational &>(*e.bp);
  92 }
  93
  94 #ifndef NO_NAMESPACE_GINAC
  95 } // namespace GiNaC
  96 #endif // ndef NO_NAMESPACE_GINAC
  97
  98 #endif // ndef __GINAC_RELATIONAL_H__