Skip to content

Commit

Permalink
docs: update doxygen documentation d9a61de
Browse files Browse the repository at this point in the history
  • Loading branch information
@S-Mazigh
S-Mazigh committed Oct 25, 2024
0 parents commit bd3cc00
Show file tree
Hide file tree
Showing 1,201 changed files with 135,073 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
163 changes: 163 additions & 0 deletions AllGatherSharing_8hpp_source.html

Large diffs are not rendered by default.

225 changes: 225 additions & 0 deletions Bitset_8hpp_source.html

Large diffs are not rendered by default.

190 changes: 190 additions & 0 deletions BloomFilter_8hpp_source.html

Large diffs are not rendered by default.

265 changes: 265 additions & 0 deletions Cadical_8hpp_source.html

Large diffs are not rendered by default.

275 changes: 275 additions & 0 deletions ClauseBuffer_8hpp_source.html

Large diffs are not rendered by default.

175 changes: 175 additions & 0 deletions ClauseDatabaseBufferPerEntity_8hpp_source.html

Large diffs are not rendered by default.

200 changes: 200 additions & 0 deletions ClauseDatabaseMallob_8hpp_source.html

Large diffs are not rendered by default.

179 changes: 179 additions & 0 deletions ClauseDatabasePerSize_8hpp_source.html

Large diffs are not rendered by default.

196 changes: 196 additions & 0 deletions ClauseDatabaseSingleBuffer_8hpp_source.html

Large diffs are not rendered by default.

159 changes: 159 additions & 0 deletions ClauseDatabase_8hpp_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
<!-- HTML header for doxygen 1.9.7-->
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=11" />
<meta name="generator" content="Doxygen 1.12.0" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Painless: /github/workspace/src/containers/ClauseDatabase.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link rel="icon" type="image/png" href="p-logo.png"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom-alternative.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><a href=index.html><img alt="Logo" src="p-logo.png" /></a></td>
<td id="projectalign">
<div id="projectname">Painless
</div>
<div id="projectbrief">A framework to ease parallelization of sequential CDCL SAT solvers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0b61c55142250c0cc363383afd8075a4.html">containers</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">ClauseDatabase.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;containers/ClauseExchange.hpp&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;atomic&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;numeric&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;sstream&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="};">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classClauseDatabase.html"> 26</a></span><span class="keyword">class </span><a class="code hl_class" href="classClauseDatabase.html">ClauseDatabase</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a58682b8221e4787424ad005e987eeb42"> 30</a></span> <a class="code hl_function" href="classClauseDatabase.html#a58682b8221e4787424ad005e987eeb42">ClauseDatabase</a>() {}</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a6ae6424d414d8116cdd0d231af3193dc"> 33</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classClauseDatabase.html#a6ae6424d414d8116cdd0d231af3193dc">~ClauseDatabase</a>() {}</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a4d25e6fa03efabaa1011920fc0ea5573"> 40</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classClauseDatabase.html#a4d25e6fa03efabaa1011920fc0ea5573">addClause</a>(ClauseExchangePtr clause) = 0;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#af351d9ca90de1baef43070bbd8f615cc"> 48</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classClauseDatabase.html#af351d9ca90de1baef43070bbd8f615cc">giveSelection</a>(std::vector&lt;ClauseExchangePtr&gt;&amp; selectedCls, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> literalCountLimit ) = 0;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a57206812d6df9a47f97a9f5c4d5a9f82"> 54</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classClauseDatabase.html#a57206812d6df9a47f97a9f5c4d5a9f82">getClauses</a>(std::vector&lt;ClauseExchangePtr&gt;&amp; v_cls) = 0;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a913ac1a1f391ba55da6d99f72f38da05"> 61</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classClauseDatabase.html#a913ac1a1f391ba55da6d99f72f38da05">getOneClause</a>(ClauseExchangePtr&amp; cls) = 0;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a90c045c33bf4050791adf412cd2a9981"> 67</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classClauseDatabase.html#a90c045c33bf4050791adf412cd2a9981">getSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a7047a3d8094c37cc9097d633cb6c91ca"> 73</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classClauseDatabase.html#a7047a3d8094c37cc9097d633cb6c91ca">shrinkDatabase</a>() = 0;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classClauseDatabase.html#a843082a87681cabc9bd6d2ebbeb7bf44"> 78</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classClauseDatabase.html#a843082a87681cabc9bd6d2ebbeb7bf44">clearDatabase</a>() = 0;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>};</div>
</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="ttc" id="aclassClauseDatabase_html"><div class="ttname"><a href="classClauseDatabase.html">ClauseDatabase</a></div><div class="ttdoc">Abstract base class defining the interface for clause storage and management.</div><div class="ttdef"><b>Definition</b> ClauseDatabase.hpp:27</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a4d25e6fa03efabaa1011920fc0ea5573"><div class="ttname"><a href="classClauseDatabase.html#a4d25e6fa03efabaa1011920fc0ea5573">ClauseDatabase::addClause</a></div><div class="ttdeci">virtual bool addClause(ClauseExchangePtr clause)=0</div><div class="ttdoc">Add a clause to the database.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a57206812d6df9a47f97a9f5c4d5a9f82"><div class="ttname"><a href="classClauseDatabase.html#a57206812d6df9a47f97a9f5c4d5a9f82">ClauseDatabase::getClauses</a></div><div class="ttdeci">virtual void getClauses(std::vector&lt; ClauseExchangePtr &gt; &amp;v_cls)=0</div><div class="ttdoc">Retrieve all clauses from the database.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a58682b8221e4787424ad005e987eeb42"><div class="ttname"><a href="classClauseDatabase.html#a58682b8221e4787424ad005e987eeb42">ClauseDatabase::ClauseDatabase</a></div><div class="ttdeci">ClauseDatabase()</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition</b> ClauseDatabase.hpp:30</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a6ae6424d414d8116cdd0d231af3193dc"><div class="ttname"><a href="classClauseDatabase.html#a6ae6424d414d8116cdd0d231af3193dc">ClauseDatabase::~ClauseDatabase</a></div><div class="ttdeci">virtual ~ClauseDatabase()</div><div class="ttdoc">Virtual destructor to ensure proper cleanup of derived classes.</div><div class="ttdef"><b>Definition</b> ClauseDatabase.hpp:33</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a7047a3d8094c37cc9097d633cb6c91ca"><div class="ttname"><a href="classClauseDatabase.html#a7047a3d8094c37cc9097d633cb6c91ca">ClauseDatabase::shrinkDatabase</a></div><div class="ttdeci">virtual size_t shrinkDatabase()=0</div><div class="ttdoc">Reduce the size of the database by removing some clauses.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a843082a87681cabc9bd6d2ebbeb7bf44"><div class="ttname"><a href="classClauseDatabase.html#a843082a87681cabc9bd6d2ebbeb7bf44">ClauseDatabase::clearDatabase</a></div><div class="ttdeci">virtual void clearDatabase()=0</div><div class="ttdoc">Remove all clauses from the database.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a90c045c33bf4050791adf412cd2a9981"><div class="ttname"><a href="classClauseDatabase.html#a90c045c33bf4050791adf412cd2a9981">ClauseDatabase::getSize</a></div><div class="ttdeci">virtual size_t getSize() const =0</div><div class="ttdoc">Get the current number of clauses in the database.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_a913ac1a1f391ba55da6d99f72f38da05"><div class="ttname"><a href="classClauseDatabase.html#a913ac1a1f391ba55da6d99f72f38da05">ClauseDatabase::getOneClause</a></div><div class="ttdeci">virtual bool getOneClause(ClauseExchangePtr &amp;cls)=0</div><div class="ttdoc">Retrieve a single clause from the database.</div></div>
<div class="ttc" id="aclassClauseDatabase_html_af351d9ca90de1baef43070bbd8f615cc"><div class="ttname"><a href="classClauseDatabase.html#af351d9ca90de1baef43070bbd8f615cc">ClauseDatabase::giveSelection</a></div><div class="ttdeci">virtual size_t giveSelection(std::vector&lt; ClauseExchangePtr &gt; &amp;selectedCls, unsigned int literalCountLimit)=0</div><div class="ttdoc">Fill the given buffer with a selection of clauses.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.12.0-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
<img class="footer" src="./p-logo.png"/>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
Doxygen Theme by&#160;<a href="https://github.com/jothepro/doxygen-awesome-css">doxygen-awesome</a>
</small></address>
</div><!-- doc-content -->
</body>
</html>
Loading

0 comments on commit bd3cc00

Please sign in to comment.