ginac/relational.h

   1 /** @file relational.h
   2  *
   3  *  Interface to relations between expressions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #ifndef GINAC_RELATIONAL_H
  24 #define GINAC_RELATIONAL_H
  25
  26 #include "basic.h"
  27 #include "ex.h"
  28 #include "archive.h"
  29
  30 namespace GiNaC {
  31
  32 /** This class holds a relation consisting of two expressions and a logical
  33  *  relation between them. */
  34 class relational : public basic
  35 {
  36         GINAC_DECLARE_REGISTERED_CLASS(relational, basic)
  37
  38 // types
  39 public:
  40         enum operators {
  41                 equal,
  42                 not_equal,
  43                 less,
  44                 less_or_equal,
  45                 greater,
  46                 greater_or_equal
  47         };
  48
  49         // other constructors
  50 public:
  51         relational(const ex & lhs, const ex & rhs, operators oper=equal);
  52
  53         // functions overriding virtual functions from base classes
  54 public:
  55         unsigned precedence() const {return 20;}
  56         bool info(unsigned inf) const;
  57         size_t nops() const;
  58         ex op(size_t i) const;
  59         ex map(map_function & f) const;
  60         ex subs(const exmap & m, unsigned options = 0) const;
  61         ex eval(int level=0) const;
  62
  63         /** Save (a.k.a. serialize) object into archive. */
  64         void archive(archive_node& n) const;
  65         /** Read (a.k.a. deserialize) object from archive. */
  66         void read_archive(const archive_node& n, lst& syms);
  67 protected:
  68         ex eval_ncmul(const exvector & v) const;
  69         bool match_same_type(const basic & other) const;
  70         unsigned return_type() const;
  71         return_type_t return_type_tinfo() const;
  72         unsigned calchash() const;
  73
  74         // new virtual functions which can be overridden by derived classes
  75 protected:
  76         void do_print(const print_context & c, unsigned level) const;
  77         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
  78
  79 public:
  80         virtual ex lhs() const;
  81         virtual ex rhs() const;
  82
  83         // non-virtual functions in this class
  84 private:
  85         // For conversions to boolean, as would be used in an if conditional,
  86         // implicit conversions from bool to int have a large number of
  87         // undesirable side effects.  The following safe_bool type enables
  88         // use of relational objects in conditionals without those side effects
  89         struct safe_bool_helper {
  90                 void nonnull() {};
  91         };
  92
  93         typedef void (safe_bool_helper::*safe_bool)();
  94
  95         safe_bool make_safe_bool(bool) const;
  96
  97 public:
  98         operator safe_bool() const;
  99         safe_bool operator!() const;
 100
 101 // member variables
 102
 103 protected:
 104         ex lh;
 105         ex rh;
 106         operators o;
 107 };
 108 GINAC_DECLARE_UNARCHIVER(relational);
 109
 110 // utility functions
 111
 112 // inlined functions for efficiency
 113 inline relational::safe_bool relational::operator!() const
 114 {
 115         return make_safe_bool(!static_cast<bool>(*this));
 116 }
 117
 118 } // namespace GiNaC
 119
 120 #endif // ndef GINAC_RELATIONAL_H