ginac/relational.h

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