ginac/wildcard.h

   1 /** @file wildcard.h
   2  *
   3  *  Interface to GiNaC's wildcard objects. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2008 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_WILDCARD_H__
  24 #define __GINAC_WILDCARD_H__
  25
  26 #include "ex.h"
  27 #include "archive.h"
  28
  29 namespace GiNaC {
  30
  31
  32 /** This class acts as a wildcard for subs(), match(), has() and find(). An
  33  *  integer label is used to identify different wildcards. */
  34 class wildcard : public basic
  35 {
  36         GINAC_DECLARE_REGISTERED_CLASS(wildcard, basic)
  37
  38         // other constructors
  39 public:
  40         /** Construct wildcard with specified label. */
  41         wildcard(unsigned label);
  42
  43         // functions overriding virtual functions from base classes
  44 public:
  45         bool match(const ex & pattern, exmap& repl_lst) const;
  46
  47         /** Save (a.k.a. serialize) object into archive. */
  48         void archive(archive_node& n) const;
  49         /** Read (a.k.a. deserialize) object from archive. */
  50         void read_archive(const archive_node& n, lst& syms);
  51 protected:
  52         unsigned calchash() const;
  53
  54         // non-virtual functions in this class
  55 public:
  56         unsigned get_label() const {return label;}
  57
  58 protected:
  59         void do_print(const print_context & c, unsigned level) const;
  60         void do_print_tree(const print_tree & c, unsigned level) const;
  61         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
  62
  63         // member variables
  64 private:
  65         unsigned label; /**< Label used to distinguish different wildcards */
  66 };
  67 GINAC_DECLARE_UNARCHIVER(wildcard);
  68
  69
  70 // utility functions
  71
  72 /** Create a wildcard object with the specified label. */
  73 inline ex wild(unsigned label = 0)
  74 {
  75         return wildcard(label);
  76 }
  77
  78 /** Check whether x has a wildcard anywhere as a subexpression. */
  79 bool haswild(const ex & x);
  80
  81 } // namespace GiNaC
  82
  83 #endif // ndef __GINAC_WILDCARD_H__