8bf8c6a739c1b7e5c6307f21805c5f33cd879159
[ginac.git] / ginac / wildcard.cpp
1 /** @file wildcard.cpp
2  *
3  *  Implementation of GiNaC's wildcard objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2005 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 #include <iostream>
24
25 #include "wildcard.h"
26 #include "archive.h"
27 #include "utils.h"
28
29 namespace GiNaC {
30
31 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(wildcard, basic,
32   print_func<print_context>(&wildcard::do_print).
33   print_func<print_tree>(&wildcard::do_print_tree).
34   print_func<print_python_repr>(&wildcard::do_print_python_repr))
35
36 //////////
37 // default constructor
38 //////////
39
40 wildcard::wildcard() : inherited(TINFO_wildcard), label(0)
41 {
42         setflag(status_flags::evaluated | status_flags::expanded);
43 }
44
45 //////////
46 // other constructors
47 //////////
48
49 wildcard::wildcard(unsigned l) : inherited(TINFO_wildcard), label(l)
50 {
51         setflag(status_flags::evaluated | status_flags::expanded);
52 }
53
54 //////////
55 // archiving
56 //////////
57
58 wildcard::wildcard(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
59 {
60         n.find_unsigned("label", label);
61         setflag(status_flags::evaluated | status_flags::expanded);
62 }
63
64 void wildcard::archive(archive_node &n) const
65 {
66         inherited::archive(n);
67         n.add_unsigned("label", label);
68 }
69
70 DEFAULT_UNARCHIVE(wildcard)
71
72 //////////
73 // functions overriding virtual functions from base classes
74 //////////
75
76 int wildcard::compare_same_type(const basic & other) const
77 {
78         GINAC_ASSERT(is_a<wildcard>(other));
79         const wildcard &o = static_cast<const wildcard &>(other);
80
81         if (label == o.label)
82                 return 0;
83         else
84                 return label < o.label ? -1 : 1;
85 }
86
87 void wildcard::do_print(const print_context & c, unsigned level) const
88 {
89         c.s << "$" << label;
90 }
91
92 void wildcard::do_print_tree(const print_tree & c, unsigned level) const
93 {
94         c.s << std::string(level, ' ') << class_name() << "(" << label << ")" << " @" << this
95             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
96             << std::endl;
97 }
98
99 void wildcard::do_print_python_repr(const print_python_repr & c, unsigned level) const
100 {
101         c.s << class_name() << '(' << label << ')';
102 }
103
104 unsigned wildcard::calchash() const
105 {
106         // this is where the schoolbook method
107         // (golden_ratio_hash(tinfo()) ^ label)
108         // is not good enough yet...
109         hashvalue = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ label);
110         setflag(status_flags::hash_calculated);
111         return hashvalue;
112 }
113
114 bool wildcard::match(const ex & pattern, lst & repl_lst) const
115 {
116         // Wildcards must match each other exactly (this is required for
117         // subs() to work properly because in the final step it substitutes
118         // all wildcards by their matching expressions)
119         return is_equal(ex_to<basic>(pattern));
120 }
121
122 bool haswild(const ex & x)
123 {
124         if (is_a<wildcard>(x))
125                 return true;
126         for (size_t i=0; i<x.nops(); ++i)
127                 if (haswild(x.op(i)))
128                         return true;
129         return false;
130 }
131
132 } // namespace GiNaC