Head

GCC Code Coverage Report

Directory:	.		Exec	Total	Coverage
File:	src/theory/quantifiers/ematching/instantiation_engine.cpp	Lines:	115	128	89.8 %
Date:	2021-09-18	Branches:	177	364	48.6 %


/******************************************************************************
 * Top contributors (to current version):
 *   Andrew Reynolds, Morgan Deters, Tim King
 *
 * This file is part of the cvc5 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.
 * ****************************************************************************
 *
 * Implementation of instantiation engine class
 */

#include "theory/quantifiers/ematching/instantiation_engine.h"

#include "options/quantifiers_options.h"
#include "theory/quantifiers/ematching/inst_strategy_e_matching.h"
#include "theory/quantifiers/ematching/inst_strategy_e_matching_user.h"
#include "theory/quantifiers/ematching/trigger.h"
#include "theory/quantifiers/first_order_model.h"
#include "theory/quantifiers/quantifiers_attributes.h"
#include "theory/quantifiers/term_database.h"
#include "theory/quantifiers/term_util.h"

using namespace cvc5::kind;
using namespace cvc5::context;
using namespace cvc5::theory::quantifiers::inst;

namespace cvc5 {
namespace theory {
namespace quantifiers {

InstantiationEngine::InstantiationEngine(Env& env,
                                         QuantifiersState& qs,
                                         QuantifiersInferenceManager& qim,
                                         QuantifiersRegistry& qr,
                                         TermRegistry& tr)
    : QuantifiersModule(env, qs, qim, qr, tr),
      d_instStrategies(),
      d_isup(),
      d_i_ag(),
      d_quants(),
      d_trdb(qs, qim, qr, tr),
      d_quant_rel(nullptr)
{
  if (options::relevantTriggers())
  {
    d_quant_rel.reset(new quantifiers::QuantRelevance(env));
  }
  if (options::eMatching()) {
    // these are the instantiation strategies for E-matching
    // user-provided patterns
    if (options::userPatternsQuant() != options::UserPatMode::IGNORE)
    {
      d_isup.reset(new InstStrategyUserPatterns(d_trdb, qs, qim, qr, tr));
      d_instStrategies.push_back(d_isup.get());
    }

    // auto-generated patterns
    d_i_ag.reset(new InstStrategyAutoGenTriggers(
        d_trdb, qs, qim, qr, tr, d_quant_rel.get()));
    d_instStrategies.push_back(d_i_ag.get());
  }
}

InstantiationEngine::~InstantiationEngine() {}

void InstantiationEngine::presolve() {
  for( unsigned i=0; i<d_instStrategies.size(); ++i ){
    d_instStrategies[i]->presolve();
  }
}

void InstantiationEngine::doInstantiationRound( Theory::Effort effort ){
  size_t lastWaiting = d_qim.numPendingLemmas();
  //iterate over an internal effort level e
  int e = 0;
  int eLimit = effort==Theory::EFFORT_LAST_CALL ? 10 : 2;
  bool finished = false;
  //while unfinished, try effort level=0,1,2....
  while( !finished && e<=eLimit ){
    Debug("inst-engine") << "IE: Prepare instantiation (" << e << ")." << std::endl;
    finished = true;
    //instantiate each quantifier
    for( unsigned i=0; i<d_quants.size(); i++ ){
      Node q = d_quants[i];
      Debug("inst-engine-debug") << "IE: Instantiate " << q << "..." << std::endl;
      //int e_use = d_quantEngine->getRelevance( q )==-1 ? e - 1 : e;
      int e_use = e;
      if( e_use>=0 ){
        Trace("inst-engine-debug") << "inst-engine : " << q << std::endl;
        //check each instantiation strategy
        for( unsigned j=0; j<d_instStrategies.size(); j++ ){
          InstStrategy* is = d_instStrategies[j];
          Trace("inst-engine-debug") << "Do " << is->identify() << " " << e_use << std::endl;
          InstStrategyStatus quantStatus = is->process(q, effort, e_use);
          Trace("inst-engine-debug")
              << " -> unfinished= "
              << (quantStatus == InstStrategyStatus::STATUS_UNFINISHED)
              << ", conflict=" << d_qstate.isInConflict() << std::endl;
          if (d_qstate.isInConflict())
          {
            return;
          }
          else if (quantStatus == InstStrategyStatus::STATUS_UNFINISHED)
          {
            finished = false;
          }
        }
      }
    }
    //do not consider another level if already added lemma at this level
    if (d_qim.numPendingLemmas() > lastWaiting)
    {
      finished = true;
    }
    e++;
  }
}

bool InstantiationEngine::needsCheck( Theory::Effort e ){
  return d_qstate.getInstWhenNeedsCheck(e);
}

void InstantiationEngine::reset_round( Theory::Effort e ){
  //if not, proceed to instantiation round
  //reset the instantiation strategies
  for( unsigned i=0; i<d_instStrategies.size(); ++i ){
    InstStrategy* is = d_instStrategies[i];
    is->processResetInstantiationRound( e );
  }
}

void InstantiationEngine::check(Theory::Effort e, QEffort quant_e)
{
  CodeTimer codeTimer(d_qstate.getStats().d_ematching_time);
  if (quant_e != QEFFORT_STANDARD)
  {
    return;
  }
  double clSet = 0;
  if (Trace.isOn("inst-engine"))
  {
    clSet = double(clock()) / double(CLOCKS_PER_SEC);
    Trace("inst-engine") << "---Instantiation Engine Round, effort = " << e
                         << "---" << std::endl;
  }
  // collect all active quantified formulas belonging to this
  bool quantActive = false;
  d_quants.clear();
  FirstOrderModel* m = d_treg.getModel();
  size_t nquant = m->getNumAssertedQuantifiers();
  for (size_t i = 0; i < nquant; i++)
  {
    Node q = m->getAssertedQuantifier(i, true);
    if (shouldProcess(q) && m->isQuantifierActive(q))
    {
      quantActive = true;
      d_quants.push_back(q);
    }
  }
  Trace("inst-engine-debug")
      << "InstEngine: check: # asserted quantifiers " << d_quants.size() << "/";
  Trace("inst-engine-debug") << nquant << " " << quantActive << std::endl;
  if (quantActive)
  {
    size_t lastWaiting = d_qim.numPendingLemmas();
    doInstantiationRound(e);
    if (d_qstate.isInConflict())
    {
      Assert(d_qim.numPendingLemmas() > lastWaiting);
      Trace("inst-engine") << "Conflict, added lemmas = "
                           << (d_qim.numPendingLemmas() - lastWaiting)
                           << std::endl;
    }
    else if (d_qim.hasPendingLemma())
    {
      Trace("inst-engine") << "Added lemmas = "
                           << (d_qim.numPendingLemmas() - lastWaiting)
                           << std::endl;
    }
  }
  else
  {
    d_quants.clear();
  }
  if (Trace.isOn("inst-engine"))
  {
    double clSet2 = double(clock()) / double(CLOCKS_PER_SEC);
    Trace("inst-engine") << "Finished instantiation engine, time = "
                         << (clSet2 - clSet) << std::endl;
  }
}

bool InstantiationEngine::checkCompleteFor( Node q ) {
  //TODO?
  return false;
}

void InstantiationEngine::checkOwnership(Node q)
{
  if (options::userPatternsQuant() == options::UserPatMode::STRICT
      && q.getNumChildren() == 3)
  {
    //if strict triggers, take ownership of this quantified formula
    if (QuantAttributes::hasPattern(q))
    {
      d_qreg.setOwner(q, this, 1);
    }
  }
}

void InstantiationEngine::registerQuantifier(Node q)
{
  if (!shouldProcess(q))
  {
    return;
  }
  if (d_quant_rel)
  {
    d_quant_rel->registerQuantifier(q);
  }
  // take into account user patterns
  if (q.getNumChildren() == 3)
  {
    Node subsPat = d_qreg.substituteBoundVariablesToInstConstants(q[2], q);
    // add patterns
    for (const Node& p : subsPat)
    {
      if (p.getKind() == INST_PATTERN)
      {
        addUserPattern(q, p);
      }
      else if (p.getKind() == INST_NO_PATTERN)
      {
        addUserNoPattern(q, p);
      }
    }
  }
}

void InstantiationEngine::addUserPattern(Node q, Node pat) {
  if (d_isup) {
    d_isup->addUserPattern(q, pat);
  }
}

void InstantiationEngine::addUserNoPattern(Node q, Node pat) {
  if (d_i_ag) {
    d_i_ag->addUserNoPattern(q, pat);
  }
}

bool InstantiationEngine::shouldProcess(Node q)
{
  if (!d_qreg.hasOwnership(q, this))
  {
    return false;
  }
  // also ignore internal quantifiers
  QuantAttributes& qattr = d_qreg.getQuantAttributes();
  if (qattr.isInternal(q))
  {
    return false;
  }
  return true;
}

}  // namespace quantifiers
}  // namespace theory
}  // namespace cvc5


Generated by: GCOVR (Version 3.2)

Line	Exec	Source
1		/******************************************************************************
2		* Top contributors (to current version):
3		* Andrew Reynolds, Morgan Deters, Tim King
4		*
5		* This file is part of the cvc5 project.
6		*
7		* Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8		* in the top-level source directory and their institutional affiliations.
9		* All rights reserved. See the file COPYING in the top-level source
10		* directory for licensing information.
11		* ****************************************************************************
12		*
13		* Implementation of instantiation engine class
14		*/
15
16		#include "theory/quantifiers/ematching/instantiation_engine.h"
17
18		#include "options/quantifiers_options.h"
19		#include "theory/quantifiers/ematching/inst_strategy_e_matching.h"
20		#include "theory/quantifiers/ematching/inst_strategy_e_matching_user.h"
21		#include "theory/quantifiers/ematching/trigger.h"
22		#include "theory/quantifiers/first_order_model.h"
23		#include "theory/quantifiers/quantifiers_attributes.h"
24		#include "theory/quantifiers/term_database.h"
25		#include "theory/quantifiers/term_util.h"
26
27		using namespace cvc5::kind;
28		using namespace cvc5::context;
29		using namespace cvc5::theory::quantifiers::inst;
30
31		namespace cvc5 {
32		namespace theory {
33		namespace quantifiers {
34
35	6577	InstantiationEngine::InstantiationEngine(Env& env,
36		QuantifiersState& qs,
37		QuantifiersInferenceManager& qim,
38		QuantifiersRegistry& qr,
39	6577	TermRegistry& tr)
40		: QuantifiersModule(env, qs, qim, qr, tr),
41		d_instStrategies(),
42		d_isup(),
43		d_i_ag(),
44		d_quants(),
45		d_trdb(qs, qim, qr, tr),
46	6577	d_quant_rel(nullptr)
47		{
48	6577	if (options::relevantTriggers())
49		{
50	4	d_quant_rel.reset(new quantifiers::QuantRelevance(env));
51		}
52	6577	if (options::eMatching()) {
53		// these are the instantiation strategies for E-matching
54		// user-provided patterns
55	6575	if (options::userPatternsQuant() != options::UserPatMode::IGNORE)
56		{
57	6575	d_isup.reset(new InstStrategyUserPatterns(d_trdb, qs, qim, qr, tr));
58	6575	d_instStrategies.push_back(d_isup.get());
59		}
60
61		// auto-generated patterns
62	13150	d_i_ag.reset(new InstStrategyAutoGenTriggers(
63	6575	d_trdb, qs, qim, qr, tr, d_quant_rel.get()));
64	6575	d_instStrategies.push_back(d_i_ag.get());
65		}
66	6577	}
67
68	13148	InstantiationEngine::~InstantiationEngine() {}
69
70	7899	void InstantiationEngine::presolve() {
71	23693	for( unsigned i=0; i<d_instStrategies.size(); ++i ){
72	15794	d_instStrategies[i]->presolve();
73		}
74	7899	}
75
76	2314	void InstantiationEngine::doInstantiationRound( Theory::Effort effort ){
77	2314	size_t lastWaiting = d_qim.numPendingLemmas();
78		//iterate over an internal effort level e
79	2314	int e = 0;
80	2314	int eLimit = effort==Theory::EFFORT_LAST_CALL ? 10 : 2;
81	2314	bool finished = false;
82		//while unfinished, try effort level=0,1,2....
83	11570	while( !finished && e<=eLimit ){
84	4628	Debug("inst-engine") << "IE: Prepare instantiation (" << e << ")." << std::endl;
85	4628	finished = true;
86		//instantiate each quantifier
87	88610	for( unsigned i=0; i<d_quants.size(); i++ ){
88	167964	Node q = d_quants[i];
89	83982	Debug("inst-engine-debug") << "IE: Instantiate " << q << "..." << std::endl;
90		//int e_use = d_quantEngine->getRelevance( q )==-1 ? e - 1 : e;
91	83982	int e_use = e;
92	83982	if( e_use>=0 ){
93	83982	Trace("inst-engine-debug") << "inst-engine : " << q << std::endl;
94		//check each instantiation strategy
95	251946	for( unsigned j=0; j<d_instStrategies.size(); j++ ){
96	167964	InstStrategy* is = d_instStrategies[j];
97	167964	Trace("inst-engine-debug") << "Do " << is->identify() << " " << e_use << std::endl;
98	167964	InstStrategyStatus quantStatus = is->process(q, effort, e_use);
99	335928	Trace("inst-engine-debug")
100	167964	<< " -> unfinished= "
101	335928	<< (quantStatus == InstStrategyStatus::STATUS_UNFINISHED)
102	167964	<< ", conflict=" << d_qstate.isInConflict() << std::endl;
103	167964	if (d_qstate.isInConflict())
104		{
105		return;
106		}
107	167964	else if (quantStatus == InstStrategyStatus::STATUS_UNFINISHED)
108		{
109	70528	finished = false;
110		}
111		}
112		}
113		}
114		//do not consider another level if already added lemma at this level
115	4628	if (d_qim.numPendingLemmas() > lastWaiting)
116		{
117	1183	finished = true;
118		}
119	4628	e++;
120		}
121		}
122
123	66803	bool InstantiationEngine::needsCheck( Theory::Effort e ){
124	66803	return d_qstate.getInstWhenNeedsCheck(e);
125		}
126
127	23904	void InstantiationEngine::reset_round( Theory::Effort e ){
128		//if not, proceed to instantiation round
129		//reset the instantiation strategies
130	71706	for( unsigned i=0; i<d_instStrategies.size(); ++i ){
131	47802	InstStrategy* is = d_instStrategies[i];
132	47802	is->processResetInstantiationRound( e );
133		}
134	23904	}
135
136	36522	void InstantiationEngine::check(Theory::Effort e, QEffort quant_e)
137		{
138	49083	CodeTimer codeTimer(d_qstate.getStats().d_ematching_time);
139	36522	if (quant_e != QEFFORT_STANDARD)
140		{
141	23961	return;
142		}
143	12561	double clSet = 0;
144	12561	if (Trace.isOn("inst-engine"))
145		{
146		clSet = double(clock()) / double(CLOCKS_PER_SEC);
147		Trace("inst-engine") << "---Instantiation Engine Round, effort = " << e
148		<< "---" << std::endl;
149		}
150		// collect all active quantified formulas belonging to this
151	12561	bool quantActive = false;
152	12561	d_quants.clear();
153	12561	FirstOrderModel* m = d_treg.getModel();
154	12561	size_t nquant = m->getNumAssertedQuantifiers();
155	71036	for (size_t i = 0; i < nquant; i++)
156		{
157	116950	Node q = m->getAssertedQuantifier(i, true);
158	58475	if (shouldProcess(q) && m->isQuantifierActive(q))
159		{
160	41991	quantActive = true;
161	41991	d_quants.push_back(q);
162		}
163		}
164	25122	Trace("inst-engine-debug")
165	12561	<< "InstEngine: check: # asserted quantifiers " << d_quants.size() << "/";
166	12561	Trace("inst-engine-debug") << nquant << " " << quantActive << std::endl;
167	12561	if (quantActive)
168		{
169	2314	size_t lastWaiting = d_qim.numPendingLemmas();
170	2314	doInstantiationRound(e);
171	2314	if (d_qstate.isInConflict())
172		{
173		Assert(d_qim.numPendingLemmas() > lastWaiting);
174		Trace("inst-engine") << "Conflict, added lemmas = "
175		<< (d_qim.numPendingLemmas() - lastWaiting)
176		<< std::endl;
177		}
178	2314	else if (d_qim.hasPendingLemma())
179		{
180	2366	Trace("inst-engine") << "Added lemmas = "
181	2366	<< (d_qim.numPendingLemmas() - lastWaiting)
182	1183	<< std::endl;
183		}
184		}
185		else
186		{
187	10247	d_quants.clear();
188		}
189	12561	if (Trace.isOn("inst-engine"))
190		{
191		double clSet2 = double(clock()) / double(CLOCKS_PER_SEC);
192		Trace("inst-engine") << "Finished instantiation engine, time = "
193		<< (clSet2 - clSet) << std::endl;
194		}
195		}
196
197	579	bool InstantiationEngine::checkCompleteFor( Node q ) {
198		//TODO?
199	579	return false;
200		}
201
202	22842	void InstantiationEngine::checkOwnership(Node q)
203		{
204	45684	if (options::userPatternsQuant() == options::UserPatMode::STRICT
205	22842	&& q.getNumChildren() == 3)
206		{
207		//if strict triggers, take ownership of this quantified formula
208		if (QuantAttributes::hasPattern(q))
209		{
210		d_qreg.setOwner(q, this, 1);
211		}
212		}
213	22842	}
214
215	22842	void InstantiationEngine::registerQuantifier(Node q)
216		{
217	22842	if (!shouldProcess(q))
218		{
219	3423	return;
220		}
221	19419	if (d_quant_rel)
222		{
223	344	d_quant_rel->registerQuantifier(q);
224		}
225		// take into account user patterns
226	19419	if (q.getNumChildren() == 3)
227		{
228	7906	Node subsPat = d_qreg.substituteBoundVariablesToInstConstants(q[2], q);
229		// add patterns
230	8338	for (const Node& p : subsPat)
231		{
232	4385	if (p.getKind() == INST_PATTERN)
233		{
234	3884	addUserPattern(q, p);
235		}
236	501	else if (p.getKind() == INST_NO_PATTERN)
237		{
238	8	addUserNoPattern(q, p);
239		}
240		}
241		}
242		}
243
244	3884	void InstantiationEngine::addUserPattern(Node q, Node pat) {
245	3884	if (d_isup) {
246	3884	d_isup->addUserPattern(q, pat);
247		}
248	3884	}
249
250	8	void InstantiationEngine::addUserNoPattern(Node q, Node pat) {
251	8	if (d_i_ag) {
252	8	d_i_ag->addUserNoPattern(q, pat);
253		}
254	8	}
255
256	81317	bool InstantiationEngine::shouldProcess(Node q)
257		{
258	81317	if (!d_qreg.hasOwnership(q, this))
259		{
260	16463	return false;
261		}
262		// also ignore internal quantifiers
263	64854	QuantAttributes& qattr = d_qreg.getQuantAttributes();
264	64854	if (qattr.isInternal(q))
265		{
266	3402	return false;
267		}
268	61452	return true;
269		}
270
271		} // namespace quantifiers
272		} // namespace theory
273	29574	} // namespace cvc5