ginac/relational.h

   1 /** @file relational.h
   2  *
   3  *  Interface to relations between 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_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 // member functions
  51
  52         // default constructor, destructor, copy constructor assignment operator and helpers
  53 public:
  54         relational();
  55         ~relational();
  56         relational(const relational & other);
  57         const relational & operator=(const relational & other);
  58 protected:
  59         void copy(const relational & other);
  60         void destroy(bool call_parent);
  61
  62         // other constructors
  63 public:
  64         relational(const ex & lhs, const ex & rhs, operators oper=equal);
  65
  66         // functions overriding virtual functions from bases classes
  67 public:
  68         basic * duplicate() const;
  69         void print(std::ostream & os, unsigned upper_precedence=0) const;
  70         void printraw(std::ostream & os) const;
  71         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  72         bool info(unsigned inf) const;
  73         unsigned nops() const;
  74         ex & let_op(int i);
  75         ex eval(int level=0) const;
  76         ex evalf(int level=0) const;
  77         ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
  78         ex simplify_ncmul(const exvector & v) const;
  79 protected:
  80         int compare_same_type(const basic & other) const;
  81         unsigned return_type(void) const;
  82         unsigned return_type_tinfo(void) const;
  83
  84         // new virtual functions which can be overridden by derived classes
  85 public:
  86         virtual ex lhs(void) const;
  87         virtual ex rhs(void) const;
  88
  89         // non-virtual functions in this class
  90 public:
  91         operator bool(void) const;
  92
  93 // member variables
  94
  95 protected:
  96         ex lh;
  97         ex rh;
  98         operators o;
  99         static unsigned precedence;
 100 };
 101
 102 // global constants
 103
 104 extern const relational some_relational;
 105 extern const type_info & typeid_relational;
 106
 107 // utility functions
 108 inline const relational &ex_to_relational(const ex &e)
 109 {
 110         return static_cast<const relational &>(*e.bp);
 111 }
 112
 113 #ifndef NO_NAMESPACE_GINAC
 114 } // namespace GiNaC
 115 #endif // ndef NO_NAMESPACE_GINAC
 116
 117 #endif // ndef __GINAC_RELATIONAL_H__