-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathgroup__ProgramInspection.html
204 lines (193 loc) · 14.7 KB
/
group__ProgramInspection.html
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
194
195
196
197
198
199
200
201
202
203
204
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Clingo C API: Program Inspection</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="clingo.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Clingo C API
</div>
<div id="projectbrief">C API for clingo providing high level functions to control grounding and solving.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Program Inspection<div class="ingroups"><a class="el" href="group__Control.html">Grounding and Solving</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions and data structures to inspect programs. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structclingo__ground__program__observer.html">clingo_ground_program_observer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An instance of this struct has to be registered with a solver to observe ground directives as they are passed to the solver. <a href="structclingo__ground__program__observer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaa67a416799cd19c6b46ed02233ea6947"><td class="memItemLeft" align="right" valign="top"><a id="gaa67a416799cd19c6b46ed02233ea6947"></a>
typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ProgramInspection.html#gaa67a416799cd19c6b46ed02233ea6947">clingo_heuristic_type_t</a></td></tr>
<tr class="memdesc:gaa67a416799cd19c6b46ed02233ea6947"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding type to <a class="el" href="group__ProgramInspection.html#ga1283342a922201778f9729a453d97524" title="Enumeration of different heuristic modifiers.">clingo_heuristic_type_e</a>. <br /></td></tr>
<tr class="separator:gaa67a416799cd19c6b46ed02233ea6947"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga176cf284ec38d9b3626d6584b3cb407e"><td class="memItemLeft" align="right" valign="top"><a id="ga176cf284ec38d9b3626d6584b3cb407e"></a>
typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ProgramInspection.html#ga176cf284ec38d9b3626d6584b3cb407e">clingo_external_type_t</a></td></tr>
<tr class="memdesc:ga176cf284ec38d9b3626d6584b3cb407e"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding type to <a class="el" href="group__ProgramInspection.html#ga66003e1c5b864b41a569b39e120cec18" title="Enumeration of different external statements.">clingo_external_type_e</a>. <br /></td></tr>
<tr class="separator:ga176cf284ec38d9b3626d6584b3cb407e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66dd90d4761c5cbf97ed73245ea5b562"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structclingo__ground__program__observer.html">clingo_ground_program_observer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ProgramInspection.html#ga66dd90d4761c5cbf97ed73245ea5b562">clingo_ground_program_observer_t</a></td></tr>
<tr class="memdesc:ga66dd90d4761c5cbf97ed73245ea5b562"><td class="mdescLeft"> </td><td class="mdescRight">An instance of this struct has to be registered with a solver to observe ground directives as they are passed to the solver. <a href="group__ProgramInspection.html#ga66dd90d4761c5cbf97ed73245ea5b562">More...</a><br /></td></tr>
<tr class="separator:ga66dd90d4761c5cbf97ed73245ea5b562"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga1283342a922201778f9729a453d97524"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ProgramInspection.html#ga1283342a922201778f9729a453d97524">clingo_heuristic_type_e</a> { <br />
  <a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a8eeb163846c75b11de9af6772438303a">clingo_heuristic_type_level</a> = 0,
<a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a922b4061aafa6239fb15a0985c2a3ae9">clingo_heuristic_type_sign</a> = 1,
<a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a8987b24f9738e211ff933e0863f8327d">clingo_heuristic_type_factor</a> = 2,
<a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a11307df0595c1e261a8e2421bd7a6046">clingo_heuristic_type_init</a> = 3,
<br />
  <a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a33a18c2fb9533de0a036e40b5cfe95ed">clingo_heuristic_type_true</a> = 4,
<a class="el" href="group__ProgramInspection.html#gga1283342a922201778f9729a453d97524a07e1bf4703553a1ed8fcd388b80fa5cc">clingo_heuristic_type_false</a> = 5
<br />
}</td></tr>
<tr class="memdesc:ga1283342a922201778f9729a453d97524"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of different heuristic modifiers. <a href="group__ProgramInspection.html#ga1283342a922201778f9729a453d97524">More...</a><br /></td></tr>
<tr class="separator:ga1283342a922201778f9729a453d97524"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66003e1c5b864b41a569b39e120cec18"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ProgramInspection.html#ga66003e1c5b864b41a569b39e120cec18">clingo_external_type_e</a> { <a class="el" href="group__ProgramInspection.html#gga66003e1c5b864b41a569b39e120cec18a475c9c8288d9ad4437bb7d6b4cc703e5">clingo_external_type_free</a> = 0,
<a class="el" href="group__ProgramInspection.html#gga66003e1c5b864b41a569b39e120cec18a5182f96c94477b5ce7c669218bb6070b">clingo_external_type_true</a> = 1,
<a class="el" href="group__ProgramInspection.html#gga66003e1c5b864b41a569b39e120cec18aa456c48e83b159db4b28d6b3924a16b8">clingo_external_type_false</a> = 2,
<a class="el" href="group__ProgramInspection.html#gga66003e1c5b864b41a569b39e120cec18aaa8a481558b9b9a4fc89016c6e94b117">clingo_external_type_release</a> = 3
}</td></tr>
<tr class="memdesc:ga66003e1c5b864b41a569b39e120cec18"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of different external statements. <a href="group__ProgramInspection.html#ga66003e1c5b864b41a569b39e120cec18">More...</a><br /></td></tr>
<tr class="separator:ga66003e1c5b864b41a569b39e120cec18"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga66dd90d4761c5cbf97ed73245ea5b562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66dd90d4761c5cbf97ed73245ea5b562">◆ </a></span>clingo_ground_program_observer_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structclingo__ground__program__observer.html">clingo_ground_program_observer</a> <a class="el" href="group__ProgramInspection.html#ga66dd90d4761c5cbf97ed73245ea5b562">clingo_ground_program_observer_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An instance of this struct has to be registered with a solver to observe ground directives as they are passed to the solver. </p>
<dl class="section note"><dt>Note</dt><dd>This interface is closely modeled after the aspif format. For more information please refer to the specification of the aspif format.</dd></dl>
<p>Not all callbacks have to be implemented and can be set to NULL if not needed. If one of the callbacks in the struct fails, grounding is stopped. If a non-recoverable clingo API call fails, a callback must return false. Otherwise <a class="el" href="group__BasicTypes.html#ggaebdf91a4187db9abdd2c6ceb971cf13eaf0ac62d4f86f97849bc7fd25dbbfb676" title="errors unrelated to clingo">clingo_error_unknown</a> should be set and false returned.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Control.html#gab364e82a488e4c9df956054caca80d08" title="Register a program observer with the control object.">clingo_control_register_observer()</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga66003e1c5b864b41a569b39e120cec18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66003e1c5b864b41a569b39e120cec18">◆ </a></span>clingo_external_type_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ProgramInspection.html#ga66003e1c5b864b41a569b39e120cec18">clingo_external_type_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of different external statements. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga66003e1c5b864b41a569b39e120cec18a475c9c8288d9ad4437bb7d6b4cc703e5"></a>clingo_external_type_free </td><td class="fielddoc"><p>allow an external to be assigned freely </p>
</td></tr>
<tr><td class="fieldname"><a id="gga66003e1c5b864b41a569b39e120cec18a5182f96c94477b5ce7c669218bb6070b"></a>clingo_external_type_true </td><td class="fielddoc"><p>assign an external to true </p>
</td></tr>
<tr><td class="fieldname"><a id="gga66003e1c5b864b41a569b39e120cec18aa456c48e83b159db4b28d6b3924a16b8"></a>clingo_external_type_false </td><td class="fielddoc"><p>assign an external to false </p>
</td></tr>
<tr><td class="fieldname"><a id="gga66003e1c5b864b41a569b39e120cec18aaa8a481558b9b9a4fc89016c6e94b117"></a>clingo_external_type_release </td><td class="fielddoc"><p>no longer treat an atom as external </p>
</td></tr>
</table>
</div>
</div>
<a id="ga1283342a922201778f9729a453d97524"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1283342a922201778f9729a453d97524">◆ </a></span>clingo_heuristic_type_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ProgramInspection.html#ga1283342a922201778f9729a453d97524">clingo_heuristic_type_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of different heuristic modifiers. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a8eeb163846c75b11de9af6772438303a"></a>clingo_heuristic_type_level </td><td class="fielddoc"><p>set the level of an atom </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a922b4061aafa6239fb15a0985c2a3ae9"></a>clingo_heuristic_type_sign </td><td class="fielddoc"><p>configure which sign to chose for an atom </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a8987b24f9738e211ff933e0863f8327d"></a>clingo_heuristic_type_factor </td><td class="fielddoc"><p>modify VSIDS factor of an atom </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a11307df0595c1e261a8e2421bd7a6046"></a>clingo_heuristic_type_init </td><td class="fielddoc"><p>modify the initial VSIDS score of an atom </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a33a18c2fb9533de0a036e40b5cfe95ed"></a>clingo_heuristic_type_true </td><td class="fielddoc"><p>set the level of an atom and choose a positive sign </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1283342a922201778f9729a453d97524a07e1bf4703553a1ed8fcd388b80fa5cc"></a>clingo_heuristic_type_false </td><td class="fielddoc"><p>set the level of an atom and choose a negative sign </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 16 2022 19:52:36 for Clingo C API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>