1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/********************* */
/*! \file term_registration_visitor.h
** \verbatim
** Top contributors (to current version):
** Dejan Jovanovic, Andrew Reynolds, Morgan Deters
** This file is part of the CVC4 project.
** Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
** in the top-level source directory and their institutional affiliations.
** All rights reserved. See the file COPYING in the top-level source
** directory for licensing information.\endverbatim
**
** [[ Add lengthier description here ]]
** \todo document this file
**/
#include "cvc4_private.h"
#pragma once
#include "context/context.h"
#include "theory/shared_terms_database.h"
#include <unordered_map>
namespace CVC4 {
class TheoryEngine;
/**
* Visitor that calls the appropriate theory to pre-register the term. The visitor also keeps track
* of the sets of theories that are involved in the terms, so that it can say if there are multiple
* theories involved.
*
* A sub-term has been visited if the theories of both the parent and the term itself have already
* visited this term.
*
* Computation of the set of theories in the original term are computed in the alreadyVisited method
* so as no to skip any theories.
*/
class PreRegisterVisitor {
/** The engine */
TheoryEngine* d_engine;
typedef context::CDHashMap<TNode, theory::TheoryIdSet, TNodeHashFunction>
TNodeToTheorySetMap;
/**
* Map from terms to the theories that have already had this term pre-registered.
*/
TNodeToTheorySetMap d_visited;
/**
* String representation of the visited map, for debugging purposes.
*/
std::string toString() const;
public:
/** required to instantiate template for NodeVisitor */
using return_type = void;
PreRegisterVisitor(TheoryEngine* engine, context::Context* c)
: d_engine(engine), d_visited(c)
{
}
/**
* Returns true is current has already been pre-registered with both current
* and parent theories.
*/
bool alreadyVisited(TNode current, TNode parent);
/**
* Pre-registeres current with any of the current and parent theories that
* haven't seen the term yet.
*/
void visit(TNode current, TNode parent);
/**
* Marks the node as the starting literal, which does nothing. This method
* is required to instantiate template for NodeVisitor.
*/
void start(TNode node);
/** Called when the visitor is finished with a term, do nothing */
void done(TNode node) {}
/**
* Preregister the term current occuring under term parent. This calls
* Theory::preRegisterTerm for the theories of current and parent, as well
* as the theory of current's type, if it is finite.
*
* This method takes a set of theories visitedTheories that have already
* preregistered current and updates this set with the theories that
* preregister current during this call
*
* @param te Pointer to the theory engine containing the theories
* @param visitedTheories The theories that have already preregistered current
* @param current The term to preregister
* @param parent The parent term of current
* @param preregTheories The theories that have already preregistered current.
* If there is no theory sharing, this coincides with visitedTheories.
* Otherwise, visitedTheories may be a subset of preregTheories.
*/
static void preRegister(TheoryEngine* te,
theory::TheoryIdSet& visitedTheories,
TNode current,
TNode parent,
theory::TheoryIdSet preregTheories);
private:
/**
* Helper for above, called whether we wish to register a term with a theory
* given by an identifier id.
*/
static void preRegisterWithTheory(TheoryEngine* te,
theory::TheoryIdSet& visitedTheories,
theory::TheoryId id,
TNode current,
TNode parent,
theory::TheoryIdSet preregTheories);
};
/**
* The reason why we need to make this outside of the pre-registration loop is because we need a shared term x to
* be associated with every atom that contains it. For example, if given f(x) >= 0 and f(x) + 1 >= 0, although f(x) has
* been visited already, we need to visit it again, since we need to associate it with both atoms.
*/
class SharedTermsVisitor {
using TNodeVisitedMap =
std::unordered_map<TNode, theory::TheoryIdSet, TNodeHashFunction>;
using TNodeToTheorySetMap =
context::CDHashMap<TNode, theory::TheoryIdSet, TNodeHashFunction>;
/**
* String representation of the visited map, for debugging purposes.
*/
std::string toString() const;
/**
* The initial atom.
*/
TNode d_atom;
public:
/** required to instantiate template for NodeVisitor */
using return_type = void;
SharedTermsVisitor(TheoryEngine* te,
SharedTermsDatabase& sharedTerms,
context::Context* c)
: d_engine(te), d_sharedTerms(sharedTerms), d_preregistered(c)
{
}
/**
* Returns true is current has already been pre-registered with both current and parent theories.
*/
bool alreadyVisited(TNode current, TNode parent) const;
/**
* Pre-registeres current with any of the current and parent theories that haven't seen the term yet.
*/
void visit(TNode current, TNode parent);
/**
* Marks the node as the starting literal, which clears the state.
*/
void start(TNode node);
/**
* Just clears the state.
*/
void done(TNode node);
/**
* Clears the internal state.
*/
void clear();
private:
/** The engine */
TheoryEngine* d_engine;
/** The shared terms database */
SharedTermsDatabase& d_sharedTerms;
/** Cache of nodes we have visited in this traversal */
TNodeVisitedMap d_visited;
/** (Global) cache of nodes we have preregistered in this SAT context */
TNodeToTheorySetMap d_preregistered;
};
}
|
