<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>CVC3: CVC3::SearchSatTheoryAPI Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3 <span id="projectnumber">2.4.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCVC3.html">CVC3</a> </li>
<li class="navelem"><a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html">SearchSatTheoryAPI</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">CVC3::SearchSatTheoryAPI Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CVC3::SearchSatTheoryAPI" --><!-- doxytag: inherits="SAT::DPLLT::TheoryAPI" --><div class="dynheader">
Inheritance diagram for CVC3::SearchSatTheoryAPI:</div>
<div class="dyncontent">
<div class="center">
<img src="classCVC3_1_1SearchSatTheoryAPI.png" usemap="#CVC3::SearchSatTheoryAPI_map" alt=""/>
<map id="CVC3::SearchSatTheoryAPI_map" name="CVC3::SearchSatTheoryAPI_map">
<area href="classSAT_1_1DPLLT_1_1TheoryAPI.html" alt="SAT::DPLLT::TheoryAPI" shape="rect" coords="0,0,171,24"/>
</map>
</div></div>
<p><a href="classCVC3_1_1SearchSatTheoryAPI-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#ae37ebadf06bdc0116ff7850bc2ea5dc6">SearchSatTheoryAPI</a> (<a class="el" href="classCVC3_1_1SearchSat.html">SearchSat</a> *ss)
<li><a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a4fe19299e276955c5c2f653510b98ef3">~SearchSatTheoryAPI</a> ()
<li>void <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#ab315cba0a7157225c0355b1136b511fc">push</a> ()
<dl class="el"><dd class="mdescRight">Set a checkpoint for backtracking. <a href="#ab315cba0a7157225c0355b1136b511fc"></a><br/></dl><li>void <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a22e462ee6d70a81cdf6610921068c9ed">pop</a> ()
<dl class="el"><dd class="mdescRight">Restore most recent checkpoint. <a href="#a22e462ee6d70a81cdf6610921068c9ed"></a><br/></dl><li>void <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a11363a1236f9d2520119a0d4533087a6">assertLit</a> (<a class="el" href="classSAT_1_1Lit.html">Lit</a> l)
<dl class="el"><dd class="mdescRight">Notify theory when a literal is set to true. <a href="#a11363a1236f9d2520119a0d4533087a6"></a><br/></dl><li><a class="el" href="classSAT_1_1DPLLT.html#ac612908684032ffe76ad97f04afd0ca8">SAT::DPLLT::ConsistentResult</a> <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a5f294c37fc9ba581b542a0639e47865f">checkConsistent</a> (<a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> &cnf, bool fullEffort)
<dl class="el"><dd class="mdescRight">Check consistency of the current assignment. <a href="#a5f294c37fc9ba581b542a0639e47865f"></a><br/></dl><li>bool <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#aad2fecc1799c5b79199995cf02fcd3fb">outOfResources</a> ()
<dl class="el"><dd class="mdescRight">Check if the work budget has been exceeded. <a href="#aad2fecc1799c5b79199995cf02fcd3fb"></a><br/></dl><li><a class="el" href="classSAT_1_1Lit.html">Lit</a> <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a06f33ae2c4b9020c9dd5c05b4dc3345f">getImplication</a> ()
<dl class="el"><dd class="mdescRight">Get a literal that is implied by the current assignment. <a href="#a06f33ae2c4b9020c9dd5c05b4dc3345f"></a><br/></dl><li>void <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a5faff1f37c64447f406fbd6c377f6cd2">getExplanation</a> (<a class="el" href="classSAT_1_1Lit.html">Lit</a> l, <a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> &cnf)
<dl class="el"><dd class="mdescRight">Get an explanation for a literal that was implied. <a href="#a5faff1f37c64447f406fbd6c377f6cd2"></a><br/></dl><li>bool <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a2e715dfb82483c9a78e80eea7dbb97aa">getNewClauses</a> (<a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> &cnf)
<dl class="el"><dd class="mdescRight">Get new clauses from the theory. <a href="#a2e715dfb82483c9a78e80eea7dbb97aa"></a><br/></dl></ul>
<h2><a name="pri-attribs"></a>
Private Attributes</h2>
<ul>
<li><a class="el" href="classCVC3_1_1ContextManager.html">ContextManager</a> * <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a23c983838f09ca499abe23c09381292c">d_cm</a>
<li><a class="el" href="classCVC3_1_1SearchSat.html">SearchSat</a> * <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#ac1c134629294189ad3728762588c51cd">d_ss</a>
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00072">72</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae37ebadf06bdc0116ff7850bc2ea5dc6"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::SearchSatTheoryAPI" ref="ae37ebadf06bdc0116ff7850bc2ea5dc6" args="(SearchSat *ss)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CVC3::SearchSatTheoryAPI::SearchSatTheoryAPI </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCVC3_1_1SearchSat.html">SearchSat</a> * </td>
<td class="paramname"><em>ss</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00076">76</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4fe19299e276955c5c2f653510b98ef3"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::~SearchSatTheoryAPI" ref="a4fe19299e276955c5c2f653510b98ef3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CVC3::SearchSatTheoryAPI::~SearchSatTheoryAPI </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00078">78</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab315cba0a7157225c0355b1136b511fc"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::push" ref="ab315cba0a7157225c0355b1136b511fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CVC3::SearchSatTheoryAPI::push </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a checkpoint for backtracking. </p>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a771e84ea6308cb7d3f7d02e7858b37db">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00079">79</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a22e462ee6d70a81cdf6610921068c9ed"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::pop" ref="a22e462ee6d70a81cdf6610921068c9ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CVC3::SearchSatTheoryAPI::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Restore most recent checkpoint. </p>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a51a08aab04c2185513676a316aee14b4">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00080">80</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a11363a1236f9d2520119a0d4533087a6"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::assertLit" ref="a11363a1236f9d2520119a0d4533087a6" args="(Lit l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CVC3::SearchSatTheoryAPI::assertLit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSAT_1_1Lit.html">Lit</a> </td>
<td class="paramname"><em>l</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notify theory when a literal is set to true. </p>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a3b3ef70567e0298cd3e971fd57d26fa6">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00081">81</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5f294c37fc9ba581b542a0639e47865f"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::checkConsistent" ref="a5f294c37fc9ba581b542a0639e47865f" args="(CNF_Formula &cnf, bool fullEffort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSAT_1_1DPLLT.html#ac612908684032ffe76ad97f04afd0ca8">SAT::DPLLT::ConsistentResult</a> CVC3::SearchSatTheoryAPI::checkConsistent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> & </td>
<td class="paramname"><em>cnf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>fullEffort</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check consistency of the current assignment. </p>
<p>The result is either INCONSISTENT, MAYBE_CONSISTENT, or CONSISTENT Most of the time, fullEffort should be false, and the result will most likely be either INCONSISTENT or MAYBE_CONSISTENT. To force a full check, set fullEffort to true. When fullEffort is set to true, the only way the result can be MAYBE_CONSISTENT is if there are new clauses to get (via getNewClauses). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cnf</td><td>should be empty initially. If INCONSISTENT is returned, then cnf will contain one or more clauses ruling out the current assignment when it returns. Otherwise, cnf is unchanged. </td></tr>
<tr><td class="paramname">fullEffort</td><td>true for a full check, false for a fast check </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a4b3f4a97dbac21236e479a157d866545">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00082">82</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aad2fecc1799c5b79199995cf02fcd3fb"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::outOfResources" ref="aad2fecc1799c5b79199995cf02fcd3fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CVC3::SearchSatTheoryAPI::outOfResources </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the work budget has been exceeded. </p>
<p>If true, it means that the engine should quit and return ABORT. Otherwise, it should proceed normally. This should be checked regularly. </p>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a6484231750edf5bd9d10d9408c6b5a59">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00084">84</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a06f33ae2c4b9020c9dd5c05b4dc3345f"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::getImplication" ref="a06f33ae2c4b9020c9dd5c05b4dc3345f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSAT_1_1Lit.html">Lit</a> CVC3::SearchSatTheoryAPI::getImplication </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a literal that is implied by the current assignment. </p>
<p>This is theory propagation. It can be called repeatedly and returns a Null literal when there are no more literals to propagate. It should only be called when the assignment is not known to be inconsistent. </p>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#ad61236a10860b9771e1e09505ab501b5">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00085">85</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5faff1f37c64447f406fbd6c377f6cd2"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::getExplanation" ref="a5faff1f37c64447f406fbd6c377f6cd2" args="(Lit l, CNF_Formula &cnf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CVC3::SearchSatTheoryAPI::getExplanation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSAT_1_1Lit.html">Lit</a> </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> & </td>
<td class="paramname"><em>c</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get an explanation for a literal that was implied. </p>
<p>Given a literal l that is true in the current assignment as a result of an earlier call to <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a06f33ae2c4b9020c9dd5c05b4dc3345f" title="Get a literal that is implied by the current assignment.">getImplication()</a>, this method returns a set of clauses which justifies the propagation of that literal. The clauses will contain the literal l as well as other literals that are in the current assignment. The clauses are such that they would have propagated l via unit propagation at the time <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a06f33ae2c4b9020c9dd5c05b4dc3345f" title="Get a literal that is implied by the current assignment.">getImplication()</a> was called. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">l</td><td>the literal </td></tr>
<tr><td class="paramname">c</td><td>should be empty initially. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#ab7a85a15823cb0771d1e9bb4c0ce0703">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00086">86</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2e715dfb82483c9a78e80eea7dbb97aa"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::getNewClauses" ref="a2e715dfb82483c9a78e80eea7dbb97aa" args="(CNF_Formula &cnf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CVC3::SearchSatTheoryAPI::getNewClauses </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSAT_1_1CNF__Formula.html">CNF_Formula</a> & </td>
<td class="paramname"><em>cnf</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get new clauses from the theory. </p>
<p>This is extended theory learning. Returns false if there are no new clauses to get. Otherwise, returns true and new clauses are added to cnf. Note that the new clauses (if any) are theory lemmas, i.e. clauses that are valid in the theory and not dependent on the current assignment. The clauses may contain new literals as well as literals that are true in the current assignment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cnf</td><td>should be empty initially. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classSAT_1_1DPLLT_1_1TheoryAPI.html#a7d4bf4b22f7e9f19174a4f2813294acd">SAT::DPLLT::TheoryAPI</a>.</p>
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00087">87</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a23c983838f09ca499abe23c09381292c"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::d_cm" ref="a23c983838f09ca499abe23c09381292c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCVC3_1_1ContextManager.html">ContextManager</a>* <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#a23c983838f09ca499abe23c09381292c">CVC3::SearchSatTheoryAPI::d_cm</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00073">73</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac1c134629294189ad3728762588c51cd"></a><!-- doxytag: member="CVC3::SearchSatTheoryAPI::d_ss" ref="ac1c134629294189ad3728762588c51cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCVC3_1_1SearchSat.html">SearchSat</a>* <a class="el" href="classCVC3_1_1SearchSatTheoryAPI.html#ac1c134629294189ad3728762588c51cd">CVC3::SearchSatTheoryAPI::d_ss</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="search__sat_8cpp_source.html#l00074">74</a> of file <a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="search__sat_8cpp_source.html">search_sat.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Sep 7 2011 for CVC3 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
