3 * Interface to GiNaC's wildcard objects. */
6 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_WILDCARD_H__
24 #define __GINAC_WILDCARD_H__
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
35 GINAC_DECLARE_REGISTERED_CLASS(wildcard, basic)
39 /** Construct wildcard with specified label. */
40 wildcard(unsigned label);
42 // functions overriding virtual functions from base classes
44 void print(const print_context & c, unsigned level = 0) const;
45 bool match(const ex & pattern, lst & repl_lst) const;
48 unsigned calchash(void) const;
50 // non-virtual functions in this class
52 unsigned get_label(void) const {return label;}
56 unsigned label; /**< Label used to distinguish different wildcards */
62 /** Return the wildcard object handled by an ex. Deprecated: use ex_to<wildcard>().
63 * This is unsafe: you need to check the type first. */
64 inline const wildcard &ex_to_wildcard(const ex &e)
66 return static_cast<const wildcard &>(*e.bp);
69 /** Specialization of is_exactly_a<wildcard>(obj) for wildcard objects. */
70 template<> inline bool is_exactly_a<wildcard>(const basic & obj)
72 return obj.tinfo()==TINFO_wildcard;
75 /** Create a wildcard object with the specified label. */
76 inline ex wild(unsigned label = 0)
78 return wildcard(label);
83 #endif // ndef __GINAC_WILDCARD_H__