ginac/wildcard.h

   1 /** @file wildcard.h
   2  *
   3  *  Interface to GiNaC's wildcard objects. */
   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_WILDCARD_H__
  24 #define __GINAC_WILDCARD_H__
  25
  26 #include "ex.h"
  27
  28 namespace GiNaC {
  29
  30
  31 /** This class acts as a wildcard for subs(), match() and has(). An integer
  32  *  label is used to identify different wildcards. */
  33 class wildcard : public basic
  34 {
  35         GINAC_DECLARE_REGISTERED_CLASS(wildcard, basic)
  36
  37         // other constructors
  38 public:
  39         /** Construct wildcard with specified label. */
  40         wildcard(unsigned label);
  41
  42         // functions overriding virtual functions from base classes
  43 public:
  44         void print(const print_context & c, unsigned level = 0) const;
  45         unsigned calchash(void) const;
  46         bool match(const ex & pattern, lst & repl_lst) const;
  47
  48         // non-virtual functions in this class
  49 public:
  50         unsigned get_label(void) const {return label;}
  51
  52         // member variables
  53 private:
  54         unsigned label; /**< Label used to distinguish different wildcards */
  55 };
  56
  57
  58 // utility functions
  59
  60 /** Return the wildcard object handled by an ex.  Deprecated: use ex_to<wildcard>().
  61  *  This is unsafe: you need to check the type first. */
  62 inline const wildcard &ex_to_wildcard(const ex &e)
  63 {
  64         return static_cast<const wildcard &>(*e.bp);
  65 }
  66
  67 /** Specialization of is_exactly_a<wildcard>(obj) for wildcard objects. */
  68 template<> inline bool is_exactly_a<wildcard>(const basic & obj)
  69 {
  70         return obj.tinfo()==TINFO_wildcard;
  71 }
  72
  73 /** Create a wildcard object with the specified label. */
  74 inline ex wild(unsigned label = 0)
  75 {
  76         return wildcard(label);
  77 }
  78
  79 } // namespace GiNaC
  80
  81 #endif // ndef __GINAC_WILDCARD_H__