G_do_hoelder: fix case with real x values which are not of type cl_R.
[ginac.git] / ginac / wildcard.h
1 /** @file wildcard.h
2  *
3  *  Interface to GiNaC's wildcard objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2018 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 /** 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         bool match(const ex & pattern, exmap& repl_lst) const override;
45
46         /** Save (a.k.a. serialize) object into archive. */
47         void archive(archive_node& n) const override;
48         /** Read (a.k.a. deserialize) object from archive. */
49         void read_archive(const archive_node& n, lst& syms) override;
50 protected:
51         unsigned calchash() const override;
52
53         // non-virtual functions in this class
54 public:
55         unsigned get_label() const {return label;}
56
57 protected:
58         void do_print(const print_context & c, unsigned level) const;
59         void do_print_tree(const print_tree & c, unsigned level) const;
60         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
61
62         // member variables
63 private:
64         unsigned label; /**< Label used to distinguish different wildcards */
65 };
66 GINAC_DECLARE_UNARCHIVER(wildcard);
67
68
69 // utility functions
70
71 /** Create a wildcard object with the specified label. */
72 inline ex wild(unsigned label = 0)
73 {
74         return wildcard(label);
75 }
76
77 /** Check whether x has a wildcard anywhere as a subexpression. */
78 bool haswild(const ex & x);
79
80 } // namespace GiNaC
81
82 #endif // ndef GINAC_WILDCARD_H