documentation update
[ginac.git] / ginac / wildcard.h
1 /** @file wildcard.h
2  *
3  *  Interface to GiNaC's wildcard objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2002 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(), has() and find(). An
32  *  integer 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         bool match(const ex & pattern, lst & repl_lst) const;
46
47 protected:
48         unsigned calchash(void) const;
49
50         // non-virtual functions in this class
51 public:
52         unsigned get_label(void) const {return label;}
53
54         // member variables
55 private:
56         unsigned label; /**< Label used to distinguish different wildcards */
57 };
58
59
60 // utility functions
61
62 /** Specialization of is_exactly_a<wildcard>(obj) for wildcard objects. */
63 template<> inline bool is_exactly_a<wildcard>(const basic & obj)
64 {
65         return obj.tinfo()==TINFO_wildcard;
66 }
67
68 /** Create a wildcard object with the specified label. */
69 inline ex wild(unsigned label = 0)
70 {
71         return wildcard(label);
72 }
73
74 } // namespace GiNaC
75
76 #endif // ndef __GINAC_WILDCARD_H__