Clingo C API
C API for clingo providing high level functions to control grounding and solving.
clingo.h
Go to the documentation of this file.
1 // {{{ MIT License
2 
3 // Copyright 2017 Roland Kaminski
4 
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to
7 // deal in the Software without restriction, including without limitation the
8 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 // sell copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
11 
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
14 
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 // IN THE SOFTWARE.
22 
23 // }}}
24 
29 
44 
45 #ifndef CLINGO_H
46 #define CLINGO_H
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #include <stddef.h>
53 #include <stdint.h>
54 #include <stdbool.h>
55 
56 #if defined _WIN32 || defined __CYGWIN__
57 # define CLINGO_WIN
58 #endif
59 #ifdef CLINGO_NO_VISIBILITY
60 # define CLINGO_VISIBILITY_DEFAULT
61 # define CLINGO_VISIBILITY_PRIVATE
62 #else
63 # ifdef CLINGO_WIN
64 # ifdef CLINGO_BUILD_LIBRARY
65 # define CLINGO_VISIBILITY_DEFAULT __declspec (dllexport)
66 # else
67 # define CLINGO_VISIBILITY_DEFAULT __declspec (dllimport)
68 # endif
69 # define CLINGO_VISIBILITY_PRIVATE
70 # else
71 # if __GNUC__ >= 4
72 # define CLINGO_VISIBILITY_DEFAULT __attribute__ ((visibility ("default")))
73 # define CLINGO_VISIBILITY_PRIVATE __attribute__ ((visibility ("hidden")))
74 # else
75 # define CLINGO_VISIBILITY_DEFAULT
76 # define CLINGO_VISIBILITY_PRIVATE
77 # endif
78 # endif
79 #endif
80 
81 #if defined __GNUC__
82 #define CLINGO_DEPRECATED __attribute__((deprecated))
83 #elif defined _MSC_VER
84 #define CLINGO_DEPRECATED __declspec(deprecated)
85 #else
86 #define CLINGO_DEPRECATED
87 #endif
88 
89 // {{{1 basic types and error/warning handling
90 
102 
107 
110 
112 #define CLINGO_VERSION_MAJOR 5
113 #define CLINGO_VERSION_MINOR 3
115 #define CLINGO_VERSION_REVISION 0
117 #define CLINGO_VERSION "5.3.0"
119 
121 typedef int32_t clingo_literal_t;
123 typedef uint32_t clingo_atom_t;
125 typedef uint32_t clingo_id_t;
127 typedef int32_t clingo_weight_t;
128 
141 };
143 typedef int clingo_error_t;
145 CLINGO_VISIBILITY_DEFAULT char const *clingo_error_string(clingo_error_t code);
149 CLINGO_VISIBILITY_DEFAULT clingo_error_t clingo_error_code();
153 CLINGO_VISIBILITY_DEFAULT char const *clingo_error_message();
157 CLINGO_VISIBILITY_DEFAULT void clingo_set_error(clingo_error_t code, char const *message);
158 
168 };
170 typedef int clingo_warning_t;
172 CLINGO_VISIBILITY_DEFAULT char const *clingo_warning_string(clingo_warning_t code);
182 typedef void (*clingo_logger_t)(clingo_warning_t code, char const *message, void *data);
183 
189 CLINGO_VISIBILITY_DEFAULT void clingo_version(int *major, int *minor, int *revision);
190 
196 };
199 
204 typedef struct clingo_location {
205  char const *begin_file;
206  char const *end_file;
207  size_t begin_line;
208  size_t end_line;
209  size_t begin_column;
210  size_t end_column;
212 
214 
215 // {{{1 signature and symbols
216 
233 
240 
243 
248 typedef uint64_t clingo_signature_t;
249 
252 
261 CLINGO_VISIBILITY_DEFAULT bool clingo_signature_create(char const *name, uint32_t arity, bool positive, clingo_signature_t *signature);
266 CLINGO_VISIBILITY_DEFAULT char const *clingo_signature_name(clingo_signature_t signature);
271 CLINGO_VISIBILITY_DEFAULT uint32_t clingo_signature_arity(clingo_signature_t signature);
276 CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_positive(clingo_signature_t signature);
281 CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_negative(clingo_signature_t signature);
287 CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_equal_to(clingo_signature_t a, clingo_signature_t b);
296 CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_less_than(clingo_signature_t a, clingo_signature_t b);
301 CLINGO_VISIBILITY_DEFAULT size_t clingo_signature_hash(clingo_signature_t signature);
302 
304 
312 };
315 
320 typedef uint64_t clingo_symbol_t;
321 
324 
329 CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_number(int number, clingo_symbol_t *symbol);
333 CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_supremum(clingo_symbol_t *symbol);
337 CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_infimum(clingo_symbol_t *symbol);
344 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_string(char const *string, clingo_symbol_t *symbol);
355 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_id(char const *name, bool positive, clingo_symbol_t *symbol);
367 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_function(char const *name, clingo_symbol_t const *arguments, size_t arguments_size, bool positive, clingo_symbol_t *symbol);
368 
370 
373 
380 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_number(clingo_symbol_t symbol, int *number);
387 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_name(clingo_symbol_t symbol, char const **name);
394 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_string(clingo_symbol_t symbol, char const **string);
401 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_positive(clingo_symbol_t symbol, bool *positive);
408 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_negative(clingo_symbol_t symbol, bool *negative);
416 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_arguments(clingo_symbol_t symbol, clingo_symbol_t const **arguments, size_t *arguments_size);
421 CLINGO_VISIBILITY_DEFAULT clingo_symbol_type_t clingo_symbol_type(clingo_symbol_t symbol);
428 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_to_string_size(clingo_symbol_t symbol, size_t *size);
438 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_to_string(clingo_symbol_t symbol, char *string, size_t size);
439 
441 
444 
450 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_equal_to(clingo_symbol_t a, clingo_symbol_t b);
460 CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_less_than(clingo_symbol_t a, clingo_symbol_t b);
465 CLINGO_VISIBILITY_DEFAULT size_t clingo_symbol_hash(clingo_symbol_t symbol);
466 
468 
479 CLINGO_VISIBILITY_DEFAULT bool clingo_add_string(char const *string, char const **result);
493 CLINGO_VISIBILITY_DEFAULT bool clingo_parse_term(char const *string, clingo_logger_t logger, void *logger_data, unsigned message_limit, clingo_symbol_t *symbol);
494 
496 
497 // {{{1 symbolic atoms
498 
513 
519 
522 
527 typedef struct clingo_symbolic_atoms clingo_symbolic_atoms_t;
543 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_size(clingo_symbolic_atoms_t *atoms, size_t *size);
551 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_begin(clingo_symbolic_atoms_t *atoms, clingo_signature_t const *signature, clingo_symbolic_atom_iterator_t *iterator);
557 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_end(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t *iterator);
565 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_find(clingo_symbolic_atoms_t *atoms, clingo_symbol_t symbol, clingo_symbolic_atom_iterator_t *iterator);
573 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_iterator_is_equal_to(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t a, clingo_symbolic_atom_iterator_t b, bool *equal);
580 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_symbol(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_symbol_t *symbol);
591 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_fact(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *fact);
601 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_external(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *external);
612 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_literal(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_literal_t *literal);
618 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_signatures_size(clingo_symbolic_atoms_t *atoms, size_t *size);
629 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_signatures(clingo_symbolic_atoms_t *atoms, clingo_signature_t *signatures, size_t size);
636 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_next(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_symbolic_atom_iterator_t *next);
645 CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_valid(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *valid);
646 
655 typedef bool (*clingo_symbol_callback_t) (clingo_symbol_t const *symbols, size_t symbols_size, void *data);
657 
658 // {{{1 theory atoms
659 
681 
694 
697 
706 };
709 
711 typedef struct clingo_theory_atoms clingo_theory_atoms_t;
712 
715 
722 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_type(clingo_theory_atoms_t *atoms, clingo_id_t term, clingo_theory_term_type_t *type);
730 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_number(clingo_theory_atoms_t *atoms, clingo_id_t term, int *number);
738 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_name(clingo_theory_atoms_t *atoms, clingo_id_t term, char const **name);
747 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_arguments(clingo_theory_atoms_t *atoms, clingo_id_t term, clingo_id_t const **arguments, size_t *size);
755 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t term, size_t *size);
767 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_to_string(clingo_theory_atoms_t *atoms, clingo_id_t term, char *string, size_t size);
769 
772 
780 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_tuple(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_id_t const **tuple, size_t *size);
788 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_condition(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_literal_t const **condition, size_t *size);
800 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_condition_id(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_literal_t *condition);
808 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t element, size_t *size);
818 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_to_string(clingo_theory_atoms_t *atoms, clingo_id_t element, char *string, size_t size);
820 
823 
829 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_size(clingo_theory_atoms_t *atoms, size_t *size);
836 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_term(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_id_t *term);
844 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_elements(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_id_t const **elements, size_t *size);
851 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_has_guard(clingo_theory_atoms_t *atoms, clingo_id_t atom, bool *has_guard);
859 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_guard(clingo_theory_atoms_t *atoms, clingo_id_t atom, char const **connective, clingo_id_t *term);
866 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_literal(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_literal_t *literal);
874 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t atom, size_t *size);
884 CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_to_string(clingo_theory_atoms_t *atoms, clingo_id_t atom, char *string, size_t size);
886 
888 
889 // {{{1 propagator
890 
902 
908 
911 
921 typedef struct clingo_assignment clingo_assignment_t;
922 
925 
930 CLINGO_VISIBILITY_DEFAULT uint32_t clingo_assignment_decision_level(clingo_assignment_t *assignment);
935 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_has_conflict(clingo_assignment_t *assignment);
941 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_has_literal(clingo_assignment_t *assignment, clingo_literal_t literal);
948 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_level(clingo_assignment_t *assignment, clingo_literal_t literal, uint32_t *level);
955 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_decision(clingo_assignment_t *assignment, uint32_t level, clingo_literal_t *literal);
962 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_fixed(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_fixed);
970 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_true(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_true);
978 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_false(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_false);
985 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_truth_value(clingo_assignment_t *assignment, clingo_literal_t literal, clingo_truth_value_t *value);
990 CLINGO_VISIBILITY_DEFAULT size_t clingo_assignment_size(clingo_assignment_t *assignment);
995 CLINGO_VISIBILITY_DEFAULT size_t clingo_assignment_max_size(clingo_assignment_t *assignment);
1000 CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_total(clingo_assignment_t *assignment);
1001 
1003 
1009 };
1012 
1022 typedef struct clingo_propagate_init clingo_propagate_init_t;
1023 
1026 
1033 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_solver_literal(clingo_propagate_init_t *init, clingo_literal_t aspif_literal, clingo_literal_t *solver_literal);
1039 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_add_watch(clingo_propagate_init_t *init, clingo_literal_t solver_literal);
1046 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_add_watch_to_thread(clingo_propagate_init_t *init, clingo_literal_t solver_literal, uint32_t thread_id);
1052 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_symbolic_atoms(clingo_propagate_init_t *init, clingo_symbolic_atoms_t **atoms);
1058 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_theory_atoms(clingo_propagate_init_t *init, clingo_theory_atoms_t **atoms);
1064 CLINGO_VISIBILITY_DEFAULT int clingo_propagate_init_number_of_threads(clingo_propagate_init_t *init);
1070 CLINGO_VISIBILITY_DEFAULT void clingo_propagate_init_set_check_mode(clingo_propagate_init_t *init, clingo_propagator_check_mode_t mode);
1076 CLINGO_VISIBILITY_DEFAULT clingo_propagator_check_mode_t clingo_propagate_init_get_check_mode(clingo_propagate_init_t *init);
1082 
1084 
1094 };
1097 
1099 typedef struct clingo_propagate_control clingo_propagate_control_t;
1100 
1103 
1110 CLINGO_VISIBILITY_DEFAULT clingo_id_t clingo_propagate_control_thread_id(clingo_propagate_control_t *control);
1126 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_literal(clingo_propagate_control_t *control, clingo_literal_t *result);
1137 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_watch(clingo_propagate_control_t *control, clingo_literal_t literal);
1144 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_has_watch(clingo_propagate_control_t *control, clingo_literal_t literal);
1151 CLINGO_VISIBILITY_DEFAULT void clingo_propagate_control_remove_watch(clingo_propagate_control_t *control, clingo_literal_t literal);
1165 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_clause(clingo_propagate_control_t *control, clingo_literal_t const *clause, size_t size, clingo_clause_type_t type, bool *result);
1176 CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_propagate(clingo_propagate_control_t *control, bool *result);
1177 
1179 
1182 
1184 typedef bool (*clingo_propagator_propagate_callback_t) (clingo_propagate_control_t *, clingo_literal_t const *, size_t, void *);
1185 
1187 typedef bool (*clingo_propagator_undo_callback_t) (clingo_propagate_control_t *, clingo_literal_t const *, size_t, void *);
1188 
1190 typedef bool (*clingo_propagator_check_callback_t) (clingo_propagate_control_t *, void *);
1191 
1196 typedef struct clingo_propagator {
1207  bool (*init) (clingo_propagate_init_t *init, void *data);
1247  bool (*propagate) (clingo_propagate_control_t *control, clingo_literal_t const *changes, size_t size, void *data);
1259  bool (*undo) (clingo_propagate_control_t *control, clingo_literal_t const *changes, size_t size, void *data);
1270  bool (*check) (clingo_propagate_control_t *control, void *data);
1272 
1274 
1275 // {{{1 backend
1276 
1292 
1299 
1302 
1312 };
1316 
1324 };
1328 
1331 typedef struct clingo_weighted_literal {
1332  clingo_literal_t literal;
1333  clingo_weight_t weight;
1335 
1337 typedef struct clingo_backend clingo_backend_t;
1338 
1345 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_begin(clingo_backend_t *backend);
1352 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_end(clingo_backend_t *backend);
1363 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_rule(clingo_backend_t *backend, bool choice, clingo_atom_t const *head, size_t head_size, clingo_literal_t const *body, size_t body_size);
1376 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_weight_rule(clingo_backend_t *backend, bool choice, clingo_atom_t const *head, size_t head_size, clingo_weight_t lower_bound, clingo_weighted_literal_t const *body, size_t body_size);
1385 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_minimize(clingo_backend_t *backend, clingo_weight_t priority, clingo_weighted_literal_t const* literals, size_t size);
1393 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_project(clingo_backend_t *backend, clingo_atom_t const *atoms, size_t size);
1401 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_external(clingo_backend_t *backend, clingo_atom_t atom, clingo_external_type_t type);
1409 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_assume(clingo_backend_t *backend, clingo_literal_t const *literals, size_t size);
1421 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_heuristic(clingo_backend_t *backend, clingo_atom_t atom, clingo_heuristic_type_t type, int bias, unsigned priority, clingo_literal_t const *condition, size_t size);
1431 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_acyc_edge(clingo_backend_t *backend, int node_u, int node_v, clingo_literal_t const *condition, size_t size);
1438 CLINGO_VISIBILITY_DEFAULT bool clingo_backend_add_atom(clingo_backend_t *backend, clingo_symbol_t *symbol, clingo_atom_t *atom);
1439 
1441 
1442 // {{{1 configuration
1443 
1460 
1470 
1473 
1479 };
1482 
1484 typedef struct clingo_configuration clingo_configuration_t;
1485 
1491 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_root(clingo_configuration_t *configuration, clingo_id_t *key);
1500 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_type(clingo_configuration_t *configuration, clingo_id_t key, clingo_configuration_type_bitset_t *type);
1507 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_description(clingo_configuration_t *configuration, clingo_id_t key, char const **description);
1508 
1511 
1519 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_array_size(clingo_configuration_t *configuration, clingo_id_t key, size_t *size);
1529 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_array_at(clingo_configuration_t *configuration, clingo_id_t key, size_t offset, clingo_id_t *subkey);
1531 
1534 
1542 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_size(clingo_configuration_t *configuration, clingo_id_t key, size_t* size);
1552 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_has_subkey(clingo_configuration_t *configuration, clingo_id_t key, char const *name, bool *result);
1561 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_subkey_name(clingo_configuration_t *configuration, clingo_id_t key, size_t offset, char const **name);
1571 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_at(clingo_configuration_t *configuration, clingo_id_t key, char const *name, clingo_id_t* subkey);
1573 
1576 
1584 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_is_assigned(clingo_configuration_t *configuration, clingo_id_t key, bool *assigned);
1592 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_get_size(clingo_configuration_t *configuration, clingo_id_t key, size_t *size);
1602 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_get(clingo_configuration_t *configuration, clingo_id_t key, char *value, size_t size);
1610 CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_set(clingo_configuration_t *configuration, clingo_id_t key, char const *value);
1612 
1614 
1615 // {{{1 statistics
1616 
1647 
1653 
1656 
1663 };
1666 
1668 typedef struct clingo_statistic clingo_statistics_t;
1669 
1675 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_root(clingo_statistics_t const *statistics, uint64_t *key);
1682 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_type(clingo_statistics_t const *statistics, uint64_t key, clingo_statistics_type_t *type);
1683 
1686 
1694 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_size(clingo_statistics_t const *statistics, uint64_t key, size_t *size);
1703 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_at(clingo_statistics_t const *statistics, uint64_t key, size_t offset, uint64_t *subkey);
1712 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_push(clingo_statistics_t *statistics, uint64_t key, clingo_statistics_type_t type, uint64_t *subkey);
1714 
1717 
1725 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_size(clingo_statistics_t const *statistics, uint64_t key, size_t *size);
1734 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_has_subkey(clingo_statistics_t const *statistics, uint64_t key, char const *name, bool* result);
1743 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_subkey_name(clingo_statistics_t const *statistics, uint64_t key, size_t offset, char const **name);
1753 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_at(clingo_statistics_t const *statistics, uint64_t key, char const *name, uint64_t *subkey);
1763 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_add_subkey(clingo_statistics_t *statistics, uint64_t key, char const *name, clingo_statistics_type_t type, uint64_t *subkey);
1765 
1768 
1776 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_value_get(clingo_statistics_t const *statistics, uint64_t key, double *value);
1784 CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_value_set(clingo_statistics_t *statistics, uint64_t key, double value);
1786 
1788 
1789 // {{{1 model and solve control
1790 
1811 
1817 
1820 
1822 typedef struct clingo_solve_control clingo_solve_control_t;
1823 
1825 typedef struct clingo_model clingo_model_t;
1826 
1832 };
1835 
1844 };
1846 typedef unsigned clingo_show_type_bitset_t;
1847 
1850 
1856 CLINGO_VISIBILITY_DEFAULT bool clingo_model_type(clingo_model_t const *model, clingo_model_type_t *type);
1862 CLINGO_VISIBILITY_DEFAULT bool clingo_model_number(clingo_model_t const *model, uint64_t *number);
1870 CLINGO_VISIBILITY_DEFAULT bool clingo_model_symbols_size(clingo_model_t const *model, clingo_show_type_bitset_t show, size_t *size);
1886 CLINGO_VISIBILITY_DEFAULT bool clingo_model_symbols(clingo_model_t const *model, clingo_show_type_bitset_t show, clingo_symbol_t *symbols, size_t size);
1893 CLINGO_VISIBILITY_DEFAULT bool clingo_model_contains(clingo_model_t const *model, clingo_symbol_t atom, bool *contained);
1900 CLINGO_VISIBILITY_DEFAULT bool clingo_model_is_true(clingo_model_t const *model, clingo_literal_t literal, bool *result);
1906 CLINGO_VISIBILITY_DEFAULT bool clingo_model_cost_size(clingo_model_t const *model, size_t *size);
1918 CLINGO_VISIBILITY_DEFAULT bool clingo_model_cost(clingo_model_t const *model, int64_t *costs, size_t size);
1926 CLINGO_VISIBILITY_DEFAULT bool clingo_model_optimality_proven(clingo_model_t const *model, bool *proven);
1932 CLINGO_VISIBILITY_DEFAULT bool clingo_model_thread_id(clingo_model_t const *model, clingo_id_t *id);
1943 CLINGO_VISIBILITY_DEFAULT bool clingo_model_extend(clingo_model_t *model, clingo_symbol_t const *symbols, size_t size);
1945 
1948 
1955 CLINGO_VISIBILITY_DEFAULT bool clingo_model_context(clingo_model_t const *model, clingo_solve_control_t **control);
1961 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_control_symbolic_atoms(clingo_solve_control_t *control, clingo_symbolic_atoms_t **atoms);
1974 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_control_add_clause(clingo_solve_control_t *control, clingo_literal_t const *clause, size_t size);
1976 
1978 
1979 // {{{1 solve result
1980 
1981 // NOTE: documented in Control Module
1987 };
1989 
1990 // {{{1 solve handle
1991 
2012 
2021 
2024 
2029 };
2032 
2038 };
2040 typedef unsigned clingo_solve_event_type_t;
2041 
2056 typedef bool (*clingo_solve_event_callback_t) (clingo_solve_event_type_t type, void *event, void *data, bool *goon);
2057 
2061 typedef struct clingo_solve_handle clingo_solve_handle_t;
2062 
2074 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_get(clingo_solve_handle_t *handle, clingo_solve_result_bitset_t *result);
2083 CLINGO_VISIBILITY_DEFAULT void clingo_solve_handle_wait(clingo_solve_handle_t *handle, double timeout, bool *result);
2091 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_model(clingo_solve_handle_t *handle, clingo_model_t const **model);
2102 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_resume(clingo_solve_handle_t *handle);
2109 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_cancel(clingo_solve_handle_t *handle);
2118 CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_close(clingo_solve_handle_t *handle);
2119 
2121 
2122 // {{{1 ast
2123 
2141 
2152 
2155 
2156 enum clingo_ast_comparison_operator {
2157  clingo_ast_comparison_operator_greater_than = 0,
2158  clingo_ast_comparison_operator_less_than = 1,
2159  clingo_ast_comparison_operator_less_equal = 2,
2160  clingo_ast_comparison_operator_greater_equal = 3,
2161  clingo_ast_comparison_operator_not_equal = 4,
2162  clingo_ast_comparison_operator_equal = 5
2163 };
2164 typedef int clingo_ast_comparison_operator_t;
2165 
2166 enum clingo_ast_sign {
2167  clingo_ast_sign_none = 0,
2168  clingo_ast_sign_negation = 1,
2169  clingo_ast_sign_double_negation = 2
2170 };
2171 typedef int clingo_ast_sign_t;
2172 
2173 // {{{2 terms
2174 
2175 enum clingo_ast_term_type {
2176  clingo_ast_term_type_symbol = 0,
2177  clingo_ast_term_type_variable = 1,
2178  clingo_ast_term_type_unary_operation = 2,
2179  clingo_ast_term_type_binary_operation = 3,
2180  clingo_ast_term_type_interval = 4,
2181  clingo_ast_term_type_function = 5,
2182  clingo_ast_term_type_external_function = 6,
2183  clingo_ast_term_type_pool = 7
2184 };
2185 typedef int clingo_ast_term_type_t;
2186 
2191 typedef struct clingo_ast_pool clingo_ast_pool_t;
2192 typedef struct clingo_ast_term {
2193  clingo_location_t location;
2194  clingo_ast_term_type_t type;
2195  union {
2196  clingo_symbol_t symbol;
2197  char const *variable;
2198  clingo_ast_unary_operation_t const *unary_operation;
2199  clingo_ast_binary_operation_t const *binary_operation;
2200  clingo_ast_interval_t const *interval;
2201  clingo_ast_function_t const *function;
2202  clingo_ast_function_t const *external_function;
2203  clingo_ast_pool_t const *pool;
2204  };
2206 
2207 // unary operation
2208 
2209 enum clingo_ast_unary_operator {
2210  clingo_ast_unary_operator_minus = 0,
2211  clingo_ast_unary_operator_negation = 1,
2212  clingo_ast_unary_operator_absolute = 2
2213 };
2214 typedef int clingo_ast_unary_operator_t;
2215 
2217  clingo_ast_unary_operator_t unary_operator;
2218  clingo_ast_term_t argument;
2219 };
2220 
2221 // binary operation
2222 
2223 enum clingo_ast_binary_operator {
2224  clingo_ast_binary_operator_xor = 0,
2225  clingo_ast_binary_operator_or = 1,
2226  clingo_ast_binary_operator_and = 2,
2227  clingo_ast_binary_operator_plus = 3,
2228  clingo_ast_binary_operator_minus = 4,
2229  clingo_ast_binary_operator_multiplication = 5,
2230  clingo_ast_binary_operator_division = 6,
2231  clingo_ast_binary_operator_modulo = 7,
2232  clingo_ast_binary_operator_power = 8
2233 
2234 };
2235 typedef int clingo_ast_binary_operator_t;
2236 
2238  clingo_ast_binary_operator_t binary_operator;
2239  clingo_ast_term_t left;
2240  clingo_ast_term_t right;
2241 };
2242 
2243 // interval
2244 
2246  clingo_ast_term_t left;
2247  clingo_ast_term_t right;
2248 };
2249 
2250 // function
2251 
2253  char const *name;
2254  clingo_ast_term_t *arguments;
2255  size_t size;
2256 };
2257 
2258 // pool
2259 
2261  clingo_ast_term_t *arguments;
2262  size_t size;
2263 };
2264 
2265 // {{{2 csp
2266 
2268  clingo_location_t location;
2269  clingo_ast_term_t coefficient;
2270  clingo_ast_term_t const *variable;
2272 
2273 typedef struct clingo_ast_csp_sum_term {
2274  clingo_location_t location;
2276  size_t size;
2278 
2279 typedef struct clingo_ast_csp_guard {
2280  clingo_ast_comparison_operator_t comparison;
2283 
2284 typedef struct clingo_ast_csp_literal {
2286  clingo_ast_csp_guard_t const *guards;
2287  // NOTE: size must be at least one
2288  size_t size;
2290 
2291 // {{{2 ids
2292 
2293 typedef struct clingo_ast_id {
2294  clingo_location_t location;
2295  char const *id;
2296 } clingo_ast_id_t;
2297 
2298 // {{{2 literals
2299 
2300 typedef struct clingo_ast_comparison {
2301  clingo_ast_comparison_operator_t comparison;
2302  clingo_ast_term_t left;
2303  clingo_ast_term_t right;
2305 
2306 enum clingo_ast_literal_type {
2307  clingo_ast_literal_type_boolean = 0,
2308  clingo_ast_literal_type_symbolic = 1,
2309  clingo_ast_literal_type_comparison = 2,
2310  clingo_ast_literal_type_csp = 3
2311 };
2312 typedef int clingo_ast_literal_type_t;
2313 
2314 typedef struct clingo_ast_literal {
2315  clingo_location_t location;
2316  clingo_ast_sign_t sign;
2317  clingo_ast_literal_type_t type;
2318  union {
2319  bool boolean;
2320  clingo_ast_term_t const *symbol;
2321  clingo_ast_comparison_t const *comparison;
2322  clingo_ast_csp_literal_t const *csp_literal;
2323  };
2325 
2326 // {{{2 aggregates
2327 
2328 enum clingo_ast_aggregate_function {
2329  clingo_ast_aggregate_function_count = 0,
2330  clingo_ast_aggregate_function_sum = 1,
2331  clingo_ast_aggregate_function_sump = 2,
2332  clingo_ast_aggregate_function_min = 3,
2333  clingo_ast_aggregate_function_max = 4
2334 };
2335 typedef int clingo_ast_aggregate_function_t;
2336 
2338  clingo_ast_comparison_operator_t comparison;
2339  clingo_ast_term_t term;
2341 
2343  clingo_ast_literal_t literal;
2344  clingo_ast_literal_t const *condition;
2345  size_t size;
2347 
2348 // lparse-style aggregate
2349 
2350 typedef struct clingo_ast_aggregate {
2351  clingo_ast_conditional_literal_t const *elements;
2352  size_t size;
2353  clingo_ast_aggregate_guard_t const *left_guard;
2354  clingo_ast_aggregate_guard_t const *right_guard;
2356 
2357 // body aggregate
2358 
2360  clingo_ast_term_t *tuple;
2361  size_t tuple_size;
2362  clingo_ast_literal_t const *condition;
2363  size_t condition_size;
2365 
2367  clingo_ast_aggregate_function_t function;
2368  clingo_ast_body_aggregate_element_t const *elements;
2369  size_t size;
2370  clingo_ast_aggregate_guard_t const *left_guard;
2371  clingo_ast_aggregate_guard_t const *right_guard;
2373 
2374 // head aggregate
2375 
2377  clingo_ast_term_t const *tuple;
2378  size_t tuple_size;
2379  clingo_ast_conditional_literal_t conditional_literal;
2381 
2383  clingo_ast_aggregate_function_t function;
2384  clingo_ast_head_aggregate_element_t const *elements;
2385  size_t size;
2386  clingo_ast_aggregate_guard_t const *left_guard;
2387  clingo_ast_aggregate_guard_t const *right_guard;
2389 
2390 // disjunction
2391 
2392 typedef struct clingo_ast_disjunction {
2393  clingo_ast_conditional_literal_t const *elements;
2394  size_t size;
2396 
2397 // disjoint
2398 
2400  clingo_location_t location;
2401  clingo_ast_term_t const *tuple;
2402  size_t tuple_size;
2404  clingo_ast_literal_t const *condition;
2405  size_t condition_size;
2407 
2408 typedef struct clingo_ast_disjoint {
2409  clingo_ast_disjoint_element_t const *elements;
2410  size_t size;
2412 
2413 // {{{2 theory atom
2414 
2415 enum clingo_ast_theory_term_type {
2416  clingo_ast_theory_term_type_symbol = 0,
2417  clingo_ast_theory_term_type_variable = 1,
2418  clingo_ast_theory_term_type_tuple = 2,
2419  clingo_ast_theory_term_type_list = 3,
2420  clingo_ast_theory_term_type_set = 4,
2421  clingo_ast_theory_term_type_function = 5,
2422  clingo_ast_theory_term_type_unparsed_term = 6
2423 };
2424 typedef int clingo_ast_theory_term_type_t;
2425 
2426 typedef struct clingo_ast_theory_function clingo_ast_theory_function_t;
2427 typedef struct clingo_ast_theory_term_array clingo_ast_theory_term_array_t;
2428 typedef struct clingo_ast_theory_unparsed_term clingo_ast_theory_unparsed_term_t;
2429 
2430 typedef struct clingo_ast_theory_term {
2431  clingo_location_t location;
2432  clingo_ast_theory_term_type_t type;
2433  union {
2434  clingo_symbol_t symbol;
2435  char const *variable;
2436  clingo_ast_theory_term_array_t const *tuple;
2437  clingo_ast_theory_term_array_t const *list;
2438  clingo_ast_theory_term_array_t const *set;
2439  clingo_ast_theory_function_t const *function;
2440  clingo_ast_theory_unparsed_term_t const *unparsed_term;
2441  };
2443 
2445  clingo_ast_theory_term_t const *terms;
2446  size_t size;
2447 };
2448 
2450  char const *name;
2451  clingo_ast_theory_term_t const *arguments;
2452  size_t size;
2453 };
2454 
2456  char const *const *operators;
2457  size_t size;
2460 
2463  size_t size;
2464 };
2465 
2467  clingo_ast_theory_term_t const *tuple;
2468  size_t tuple_size;
2469  clingo_ast_literal_t const *condition;
2470  size_t condition_size;
2472 
2473 typedef struct clingo_ast_theory_guard {
2474  char const *operator_name;
2477 
2478 typedef struct clingo_ast_theory_atom {
2479  clingo_ast_term_t term;
2480  clingo_ast_theory_atom_element_t const *elements;
2481  size_t size;
2482  clingo_ast_theory_guard_t const *guard;
2484 
2485 // {{{2 head literals
2486 
2487 enum clingo_ast_head_literal_type {
2488  clingo_ast_head_literal_type_literal = 0,
2489  clingo_ast_head_literal_type_disjunction = 1,
2490  clingo_ast_head_literal_type_aggregate = 2,
2491  clingo_ast_head_literal_type_head_aggregate = 3,
2492  clingo_ast_head_literal_type_theory_atom = 4
2493 };
2494 typedef int clingo_ast_head_literal_type_t;
2495 
2496 typedef struct clingo_ast_head_literal {
2497  clingo_location_t location;
2498  clingo_ast_head_literal_type_t type;
2499  union {
2500  clingo_ast_literal_t const *literal;
2501  clingo_ast_disjunction_t const *disjunction;
2502  clingo_ast_aggregate_t const *aggregate;
2503  clingo_ast_head_aggregate_t const *head_aggregate;
2504  clingo_ast_theory_atom_t const *theory_atom;
2505  };
2507 
2508 // {{{2 body literals
2509 
2510 enum clingo_ast_body_literal_type {
2511  clingo_ast_body_literal_type_literal = 0,
2512  clingo_ast_body_literal_type_conditional = 1,
2513  clingo_ast_body_literal_type_aggregate = 2,
2514  clingo_ast_body_literal_type_body_aggregate = 3,
2515  clingo_ast_body_literal_type_theory_atom = 4,
2516  clingo_ast_body_literal_type_disjoint = 5
2517 };
2518 typedef int clingo_ast_body_literal_type_t;
2519 
2520 typedef struct clingo_ast_body_literal {
2521  clingo_location_t location;
2522  clingo_ast_sign_t sign;
2523  clingo_ast_body_literal_type_t type;
2524  union {
2525  clingo_ast_literal_t const *literal;
2526  // Note: conditional literals must not have signs!!!
2527  clingo_ast_conditional_literal_t const *conditional;
2528  clingo_ast_aggregate_t const *aggregate;
2529  clingo_ast_body_aggregate_t const *body_aggregate;
2530  clingo_ast_theory_atom_t const *theory_atom;
2531  clingo_ast_disjoint_t const *disjoint;
2532  };
2534 
2535 // {{{2 theory definitions
2536 
2537 enum clingo_ast_theory_operator_type {
2538  clingo_ast_theory_operator_type_unary = 0,
2539  clingo_ast_theory_operator_type_binary_left = 1,
2540  clingo_ast_theory_operator_type_binary_right = 2
2541 };
2542 typedef int clingo_ast_theory_operator_type_t;
2543 
2545  clingo_location_t location;
2546  char const *name;
2547  unsigned priority;
2548  clingo_ast_theory_operator_type_t type;
2550 
2552  clingo_location_t location;
2553  char const *name;
2554  clingo_ast_theory_operator_definition_t const *operators;
2555  size_t size;
2557 
2559  char const *term;
2560  char const *const *operators;
2561  size_t size;
2563 
2564 enum clingo_ast_theory_atom_definition_type {
2565  clingo_ast_theory_atom_definition_type_head = 0,
2566  clingo_ast_theory_atom_definition_type_body = 1,
2567  clingo_ast_theory_atom_definition_type_any = 2,
2568  clingo_ast_theory_atom_definition_type_directive = 3,
2569 };
2570 typedef int clingo_ast_theory_atom_definition_type_t;
2571 
2573  clingo_location_t location;
2574  clingo_ast_theory_atom_definition_type_t type;
2575  char const *name;
2576  unsigned arity;
2577  char const *elements;
2580 
2582  char const *name;
2584  size_t terms_size;
2586  size_t atoms_size;
2588 
2589 // {{{2 statements
2590 
2591 // rule
2592 
2593 typedef struct clingo_ast_rule {
2595  clingo_ast_body_literal_t const *body;
2596  size_t size;
2598 
2599 // definition
2600 
2601 typedef struct clingo_ast_definition {
2602  char const *name;
2603  clingo_ast_term_t value;
2604  bool is_default;
2606 
2607 // show
2608 
2610  clingo_signature_t signature;
2611  bool csp;
2613 
2614 typedef struct clingo_ast_show_term {
2615  clingo_ast_term_t term;
2616  clingo_ast_body_literal_t const *body;
2617  size_t size;
2618  bool csp;
2620 
2621 // show
2622 
2623 typedef struct clingo_ast_defined {
2624  clingo_signature_t signature;
2626 
2627 // minimize
2628 
2629 typedef struct clingo_ast_minimize {
2630  clingo_ast_term_t weight;
2631  clingo_ast_term_t priority;
2632  clingo_ast_term_t const *tuple;
2633  size_t tuple_size;
2634  clingo_ast_body_literal_t const *body;
2635  size_t body_size;
2637 
2638 // script
2639 
2640 enum clingo_ast_script_type {
2641  clingo_ast_script_type_lua = 0,
2642  clingo_ast_script_type_python = 1
2643 };
2644 typedef int clingo_ast_script_type_t;
2645 
2646 typedef struct clingo_ast_script {
2647  clingo_ast_script_type_t type;
2648  char const *code;
2650 
2651 // program
2652 
2653 typedef struct clingo_ast_program {
2654  char const *name;
2655  clingo_ast_id_t const *parameters;
2656  size_t size;
2658 
2659 // external
2660 
2661 typedef struct clingo_ast_external {
2662  clingo_ast_term_t atom;
2663  clingo_ast_body_literal_t const *body;
2664  size_t size;
2666 
2667 // edge
2668 
2669 typedef struct clingo_ast_edge {
2672  clingo_ast_body_literal_t const *body;
2673  size_t size;
2675 
2676 // heuristic
2677 
2678 typedef struct clingo_ast_heuristic {
2679  clingo_ast_term_t atom;
2680  clingo_ast_body_literal_t const *body;
2681  size_t size;
2682  clingo_ast_term_t bias;
2683  clingo_ast_term_t priority;
2684  clingo_ast_term_t modifier;
2686 
2687 // project
2688 
2689 typedef struct clingo_ast_project {
2690  clingo_ast_term_t atom;
2691  clingo_ast_body_literal_t const *body;
2692  size_t size;
2694 
2695 // statement
2696 
2697 enum clingo_ast_statement_type {
2698  clingo_ast_statement_type_rule = 0,
2699  clingo_ast_statement_type_const = 1,
2700  clingo_ast_statement_type_show_signature = 2,
2701  clingo_ast_statement_type_show_term = 3,
2702  clingo_ast_statement_type_minimize = 4,
2703  clingo_ast_statement_type_script = 5,
2704  clingo_ast_statement_type_program = 6,
2705  clingo_ast_statement_type_external = 7,
2706  clingo_ast_statement_type_edge = 8,
2707  clingo_ast_statement_type_heuristic = 9,
2708  clingo_ast_statement_type_project_atom = 10,
2709  clingo_ast_statement_type_project_atom_signature = 11,
2710  clingo_ast_statement_type_theory_definition = 12,
2711  clingo_ast_statement_type_defined = 13
2712 };
2713 typedef int clingo_ast_statement_type_t;
2714 
2715 typedef struct clingo_ast_statement {
2716  clingo_location_t location;
2717  clingo_ast_statement_type_t type;
2718  union {
2719  clingo_ast_rule_t const *rule;
2720  clingo_ast_definition_t const *definition;
2721  clingo_ast_show_signature_t const *show_signature;
2722  clingo_ast_show_term_t const *show_term;
2723  clingo_ast_minimize_t const *minimize;
2724  clingo_ast_script_t const *script;
2725  clingo_ast_program_t const *program;
2726  clingo_ast_external_t const *external;
2727  clingo_ast_edge_t const *edge;
2728  clingo_ast_heuristic_t const *heuristic;
2729  clingo_ast_project_t const *project_atom;
2730  clingo_signature_t project_signature;
2731  clingo_ast_theory_definition_t const *theory_definition;
2732  clingo_ast_defined_t const *defined;
2733  };
2735 
2736 // }}}2
2737 
2738 typedef bool (*clingo_ast_callback_t) (clingo_ast_statement_t const *, void *);
2750 CLINGO_VISIBILITY_DEFAULT bool clingo_parse_program(char const *program, clingo_ast_callback_t callback, void *callback_data, clingo_logger_t logger, void *logger_data, unsigned message_limit);
2751 
2753 
2754 // {{{1 program builder
2755 
2758 
2760 typedef struct clingo_program_builder clingo_program_builder_t;
2761 
2766 CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_begin(clingo_program_builder_t *builder);
2775 CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_add(clingo_program_builder_t *builder, clingo_ast_statement_t const *statement);
2780 CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_end(clingo_program_builder_t *builder);
2781 
2783 
2784 // {{{1 ground program observer
2785 
2789 
2792 
2812  bool (*init_program)(bool incremental, void *data);
2819  bool (*begin_step)(void *data);
2828  bool (*end_step)(void *data);
2829 
2839  bool (*rule)(bool choice, clingo_atom_t const *head, size_t head_size, clingo_literal_t const *body, size_t body_size, void *data);
2850  bool (*weight_rule)(bool choice, clingo_atom_t const *head, size_t head_size, clingo_weight_t lower_bound, clingo_weighted_literal_t const *body, size_t body_size, void *data);
2858  bool (*minimize)(clingo_weight_t priority, clingo_weighted_literal_t const* literals, size_t size, void *data);
2865  bool (*project)(clingo_atom_t const *atoms, size_t size, void *data);
2874  bool (*output_atom)(clingo_symbol_t symbol, clingo_atom_t atom, void *data);
2882  bool (*output_term)(clingo_symbol_t symbol, clingo_literal_t const *condition, size_t size, void *data);
2891  bool (*output_csp)(clingo_symbol_t symbol, int value, clingo_literal_t const *condition, size_t size, void *data);
2898  bool (*external)(clingo_atom_t atom, clingo_external_type_t type, void *data);
2905  bool (*assume)(clingo_literal_t const *literals, size_t size, void *data);
2916  bool (*heuristic)(clingo_atom_t atom, clingo_heuristic_type_t type, int bias, unsigned priority, clingo_literal_t const *condition, size_t size, void *data);
2925  bool (*acyc_edge)(int node_u, int node_v, clingo_literal_t const *condition, size_t size, void *data);
2926 
2933  bool (*theory_term_number)(clingo_id_t term_id, int number, void *data);
2940  bool (*theory_term_string)(clingo_id_t term_id, char const *name, void *data);
2955  bool (*theory_term_compound)(clingo_id_t term_id, int name_id_or_type, clingo_id_t const *arguments, size_t size, void *data);
2965  bool (*theory_element)(clingo_id_t element_id, clingo_id_t const *terms, size_t terms_size, clingo_literal_t const *condition, size_t condition_size, void *data);
2974  bool (*theory_atom)(clingo_id_t atom_id_or_zero, clingo_id_t term_id, clingo_id_t const *elements, size_t size, void *data);
2985  bool (*theory_atom_with_guard)(clingo_id_t atom_id_or_zero, clingo_id_t term_id, clingo_id_t const *elements, size_t size, clingo_id_t operator_id, clingo_id_t right_hand_side_id, void *data);
2987 
2988 // @}
2989 
2990 // {{{1 control
2991 
3005 
3010 
3013 
3031 
3034 
3046 typedef struct clingo_part {
3047  char const *name;
3048  clingo_symbol_t const *params;
3049  size_t size;
3050 } clingo_part_t;
3051 
3091 typedef bool (*clingo_ground_callback_t) (clingo_location_t const *location, char const *name, clingo_symbol_t const *arguments, size_t arguments_size, void *data, clingo_symbol_callback_t symbol_callback, void *symbol_callback_data);
3092 
3094 typedef struct clingo_control clingo_control_t;
3095 
3116 CLINGO_VISIBILITY_DEFAULT bool clingo_control_new(char const *const * arguments, size_t arguments_size, clingo_logger_t logger, void *logger_data, unsigned message_limit, clingo_control_t **control);
3117 
3120 CLINGO_VISIBILITY_DEFAULT void clingo_control_free(clingo_control_t *control);
3121 
3124 
3132 CLINGO_VISIBILITY_DEFAULT bool clingo_control_load(clingo_control_t *control, char const *file);
3133 
3148 CLINGO_VISIBILITY_DEFAULT bool clingo_control_add(clingo_control_t *control, char const *name, char const * const * parameters, size_t parameters_size, char const *program);
3149 
3168 CLINGO_VISIBILITY_DEFAULT bool clingo_control_ground(clingo_control_t *control, clingo_part_t const *parts, size_t parts_size, clingo_ground_callback_t ground_callback, void *ground_callback_data);
3169 
3171 
3174 
3189 CLINGO_VISIBILITY_DEFAULT bool clingo_control_solve(clingo_control_t *control, clingo_solve_mode_bitset_t mode, clingo_literal_t const *assumptions, size_t assumptions_size, clingo_solve_event_callback_t notify, void *data, clingo_solve_handle_t **handle);
3201 CLINGO_VISIBILITY_DEFAULT bool clingo_control_cleanup(clingo_control_t *control);
3214 CLINGO_VISIBILITY_DEFAULT bool clingo_control_assign_external(clingo_control_t *control, clingo_literal_t literal, clingo_truth_value_t value);
3227 CLINGO_VISIBILITY_DEFAULT bool clingo_control_release_external(clingo_control_t *control, clingo_literal_t literal);
3241 CLINGO_VISIBILITY_DEFAULT bool clingo_control_register_propagator(clingo_control_t *control, clingo_propagator_t const *propagator, void *data, bool sequential);
3252 CLINGO_VISIBILITY_DEFAULT bool clingo_control_is_conflicting(clingo_control_t *control);
3270 CLINGO_VISIBILITY_DEFAULT bool clingo_control_statistics(clingo_control_t *control, clingo_statistics_t const **statistics);
3274 CLINGO_VISIBILITY_DEFAULT void clingo_control_interrupt(clingo_control_t *control);
3286 CLINGO_VISIBILITY_DEFAULT bool clingo_control_clasp_facade(clingo_control_t *control, void **clasp);
3287 
3289 
3292 
3300 CLINGO_VISIBILITY_DEFAULT bool clingo_control_configuration(clingo_control_t *control, clingo_configuration_t **configuration);
3316 CLINGO_VISIBILITY_DEFAULT bool clingo_control_use_enumeration_assumption(clingo_control_t *control, bool enable);
3318 
3321 
3328 CLINGO_VISIBILITY_DEFAULT bool clingo_control_get_const(clingo_control_t *control, char const *name, clingo_symbol_t *symbol);
3338 CLINGO_VISIBILITY_DEFAULT bool clingo_control_has_const(clingo_control_t *control, char const *name, bool *exists);
3347 CLINGO_VISIBILITY_DEFAULT bool clingo_control_symbolic_atoms(clingo_control_t *control, clingo_symbolic_atoms_t **atoms);
3355 CLINGO_VISIBILITY_DEFAULT bool clingo_control_theory_atoms(clingo_control_t *control, clingo_theory_atoms_t **atoms);
3363 CLINGO_VISIBILITY_DEFAULT bool clingo_control_register_observer(clingo_control_t *control, clingo_ground_program_observer_t const *observer, bool replace, void *data);
3365 
3368 
3377 CLINGO_VISIBILITY_DEFAULT bool clingo_control_backend(clingo_control_t *control, clingo_backend_t **backend);
3385 CLINGO_VISIBILITY_DEFAULT bool clingo_control_program_builder(clingo_control_t *control, clingo_program_builder_t **builder);
3387 
3389 
3390 // {{{1 extending clingo
3391 
3419 
3427 
3430 
3432 typedef struct clingo_options clingo_options_t;
3433 
3442 typedef bool (*clingo_main_function_t) (clingo_control_t *control, char const *const * files, size_t size, void *data);
3443 
3449 typedef bool (*clingo_default_model_printer_t) (void *data);
3450 
3459 typedef bool (*clingo_model_printer_t) (clingo_model_t const *model, clingo_default_model_printer_t printer, void *printer_data, void *data);
3460 
3462 typedef struct clingo_application {
3463  char const *(*program_name) (void *data);
3464  char const *(*version) (void *data);
3465  unsigned (*message_limit) (void *data);
3469  bool (*register_options)(clingo_options_t *options, void *data);
3470  bool (*validate_options)(void *data);
3472 
3492 CLINGO_VISIBILITY_DEFAULT bool clingo_options_add(clingo_options_t *options, char const *group, char const *option, char const *description, bool (*parse) (char const *value, void *data), void *data, bool multi, char const *argument);
3504 CLINGO_VISIBILITY_DEFAULT bool clingo_options_add_flag(clingo_options_t *options, char const *group, char const *option, char const *description, bool *target);
3505 
3513 CLINGO_VISIBILITY_DEFAULT int clingo_main(clingo_application_t *application, char const *const * arguments, size_t size, void *data);
3514 
3516 
3517 // }}}1
3518 
3519 #ifdef __cplusplus
3520 }
3521 #endif
3522 
3523 #endif
CSP variable with unbounded domain.
Definition: clingo.h:165
int clingo_external_type_t
Corresponding type to clingo_external_type.
Definition: clingo.h:1327
Definition: clingo.h:2444
configure which sign to chose for an atom
Definition: clingo.h:1307
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_condition_id(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_literal_t *condition)
Get the id of the condition of the given theory element.
bool(* clingo_propagator_check_callback_t)(clingo_propagate_control_t *, void *)
Typedef for clingo_propagator::check().
Definition: clingo.h:1190
CLINGO_VISIBILITY_DEFAULT bool clingo_control_add(clingo_control_t *control, char const *name, char const *const *parameters, size_t parameters_size, char const *program)
Extend the logic program with the given non-ground logic program in string form.
clingo_solve_result
Enumeration of bit masks for solve call results.
Definition: clingo.h:1982
the entry is a (string) value
Definition: clingo.h:1476
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_add_watch(clingo_propagate_init_t *init, clingo_literal_t solver_literal)
Add a watch for the solver literal in the given phase.
struct clingo_ground_program_observer clingo_ground_program_observer_t
An instance of this struct has to be registered with a solver to observe ground directives as they ar...
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_level(clingo_assignment_t *assignment, clingo_literal_t literal, uint32_t *level)
Determine the decision level of a given literal.
allow an external to be assigned freely
Definition: clingo.h:1320
set the level of an atom and choose a negative sign
Definition: clingo.h:1311
no longer treat an atom as external
Definition: clingo.h:1323
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_symbol(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_symbol_t *symbol)
Get the symbolic representation of an atom.
Definition: clingo.h:2314
Definition: clingo.h:2461
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_fact(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *fact)
Check whether an atom is a fact.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_theory_atoms(clingo_control_t *control, clingo_theory_atoms_t **atoms)
Get an object to inspect theory atoms that occur in the grounding.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_equal_to(clingo_symbol_t a, clingo_symbol_t b)
Check if two symbols are equal.
Yield models in calls to clingo_solve_handle_model.
Definition: clingo.h:2028
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_push(clingo_statistics_t *statistics, uint64_t key, clingo_statistics_type_t type, uint64_t *subkey)
Create the subkey at the end of an array entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_equal_to(clingo_signature_t a, clingo_signature_t b)
Check if two signatures are equal.
struct clingo_model clingo_model_t
Object representing a model.
Definition: clingo.h:1825
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_at(clingo_statistics_t const *statistics, uint64_t key, char const *name, uint64_t *subkey)
Lookup a subkey under the given name.
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_fixed(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_fixed)
Check if a literal has a fixed truth value.
errors unrelated to clingo
Definition: clingo.h:140
struct clingo_statistic clingo_statistics_t
Handle for the solver statistics.
Definition: clingo.h:1668
CLINGO_VISIBILITY_DEFAULT bool clingo_control_statistics(clingo_control_t *control, clingo_statistics_t const **statistics)
Get a statistics object to inspect solver statistics.
The last solve call completely exhausted the search space.
Definition: clingo.h:1985
Issued if a model is found.
Definition: clingo.h:2035
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_true(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_true)
Check if a literal is true.
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_model(clingo_solve_handle_t *handle, clingo_model_t const **model)
Get the next model (or zero if there are no more models).
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_size(clingo_statistics_t const *statistics, uint64_t key, size_t *size)
Get the number of subkeys of a map entry.
Definition: clingo.h:2593
bool(* clingo_symbol_callback_t)(clingo_symbol_t const *symbols, size_t symbols_size, void *data)
Callback function to inject symbols.
Definition: clingo.h:655
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_symbolic_atoms(clingo_propagate_init_t *init, clingo_symbolic_atoms_t **atoms)
Get an object to inspect the symbolic atoms.
Definition: clingo.h:2449
Definition: clingo.h:2544
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_has_literal(clingo_assignment_t *assignment, clingo_literal_t literal)
Check if the given literal is part of a (partial) assignment.
Definition: clingo.h:2273
Definition: clingo.h:2572
a tuple term, e.g., (1,2,3)
Definition: clingo.h:700
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_control_add_clause(clingo_solve_control_t *control, clingo_literal_t const *clause, size_t size)
Add a clause that applies to the current solving step during model enumeration.
set the level of an atom and choose a positive sign
Definition: clingo.h:1310
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_clause(clingo_propagate_control_t *control, clingo_literal_t const *clause, size_t size, clingo_clause_type_t type, bool *result)
Add the given clause to the solver.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_negative(clingo_symbol_t symbol, bool *negative)
Check if a function is negative (has a sign).
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_acyc_edge(clingo_backend_t *backend, int node_u, int node_v, clingo_literal_t const *condition, size_t size)
Add an edge directive.
size_t begin_column
the column where the location begins
Definition: clingo.h:209
int32_t clingo_literal_t
Signed integer type used for aspif and solver literals.
Definition: clingo.h:121
Issued if the search has completed.
Definition: clingo.h:2037
CLINGO_VISIBILITY_DEFAULT size_t clingo_assignment_size(clingo_assignment_t *assignment)
The number of assigned literals in the assignment.
struct clingo_backend clingo_backend_t
Handle to the backend to add directives in aspif format.
Definition: clingo.h:1337
struct clingo_control clingo_control_t
Control object holding grounding and solving state.
Definition: clingo.h:3094
a list term, e.g., [1,2,3]
Definition: clingo.h:701
clingo_symbol_type
Enumeration of available symbol types.
Definition: clingo.h:306
CLINGO_VISIBILITY_DEFAULT bool clingo_control_configuration(clingo_control_t *control, clingo_configuration_t **configuration)
Get a configuration object to change the solver configuration.
Definition: clingo.h:2623
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_add_subkey(clingo_statistics_t *statistics, uint64_t key, char const *name, clingo_statistics_type_t type, uint64_t *subkey)
Add a subkey with the given name.
The last solve call was interrupted.
Definition: clingo.h:1986
Definition: clingo.h:2382
This struct contains a set of functions to customize the clingo application.
Definition: clingo.h:3462
clingo_show_type
Enumeration of bit flags to select symbols in models.
Definition: clingo.h:1837
struct clingo_solve_handle clingo_solve_handle_t
Search handle to a solve call.
Definition: clingo.h:2061
a string symbol, e.g., "a"
Definition: clingo.h:309
a symbol term, e.g., c
Definition: clingo.h:705
int clingo_clause_type_t
Corresponding type to clingo_clause_type.
Definition: clingo.h:1096
Definition: clingo.h:2473
CLINGO_VISIBILITY_DEFAULT bool clingo_signature_create(char const *name, uint32_t arity, bool positive, clingo_signature_t *signature)
Create a new signature.
CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_infimum(clingo_symbol_t *symbol)
Construct a symbol representing #inf.
CLINGO_VISIBILITY_DEFAULT clingo_assignment_t * clingo_propagate_control_assignment(clingo_propagate_control_t *control)
Get the assignment associated with the underlying solver.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_find(clingo_symbolic_atoms_t *atoms, clingo_symbol_t symbol, clingo_symbolic_atom_iterator_t *iterator)
Find a symbolic atom given its symbolic representation.
a set term, e.g., {1,2,3}
Definition: clingo.h:702
modify the initial VSIDS score of an atom
Definition: clingo.h:1309
Definition: clingo.h:2520
the entry is a map
Definition: clingo.h:1478
clingo_logger_t logger
callback to override default logger
Definition: clingo.h:3467
Struct used to specify the program parts that have to be grounded.
Definition: clingo.h:3046
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_literal(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_literal_t *literal)
Get the aspif literal associated with the given theory atom.
other kinds of warnings
Definition: clingo.h:167
do not call clingo_propagator::check() at all
Definition: clingo.h:1006
Definition: clingo.h:2279
bool(* init)(clingo_propagate_init_t *init, void *data)
This function is called once before each solving step.
Definition: clingo.h:1207
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_at(clingo_configuration_t *configuration, clingo_id_t key, char const *name, clingo_id_t *subkey)
Lookup a subkey under the given name.
uint64_t clingo_symbolic_atom_iterator_t
Object to iterate over symbolic atoms.
Definition: clingo.h:537
Definition: clingo.h:2366
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_false(clingo_assignment_t *assignment, clingo_literal_t literal, bool *is_false)
Check if a literal has a fixed truth value.
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_close(clingo_solve_handle_t *handle)
Stops the running search and releases the handle.
clingo_symbol_t const * params
array of parameters
Definition: clingo.h:3048
CLINGO_VISIBILITY_DEFAULT void clingo_propagate_init_set_check_mode(clingo_propagate_init_t *init, clingo_propagator_check_mode_t mode)
Configure when to call the check method of the propagator.
CLINGO_VISIBILITY_DEFAULT void clingo_solve_handle_wait(clingo_solve_handle_t *handle, double timeout, bool *result)
Wait for the specified amount of time to check if the next result is ready.
struct clingo_propagate_control clingo_propagate_control_t
This object can be used to add clauses and propagate literals while solving.
Definition: clingo.h:1099
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_elements(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_id_t const **elements, size_t *size)
Get the theory elements associated with the theory atom.
Definition: clingo.h:2237
CLINGO_VISIBILITY_DEFAULT bool clingo_model_symbols_size(clingo_model_t const *model, clingo_show_type_bitset_t show, size_t *size)
Get the number of symbols of the selected types in the model.
CLINGO_VISIBILITY_DEFAULT bool clingo_options_add_flag(clingo_options_t *options, char const *group, char const *option, char const *description, bool *target)
Add an option that is a simple flag.
char const * begin_file
the file where the location begins
Definition: clingo.h:205
uint32_t clingo_atom_t
Unsigned integer type used for aspif atoms.
Definition: clingo.h:123
struct clingo_location clingo_location_t
Represents a source code location marking its beginnig and end.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_less_than(clingo_symbol_t a, clingo_symbol_t b)
Check if a symbol is less than another symbol.
modify VSIDS factor of an atom
Definition: clingo.h:1308
Definition: clingo.h:2300
int clingo_propagator_check_mode_t
Corresponding type to clingo_propagator_check_mode.
Definition: clingo.h:1011
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_valid(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *valid)
Check whether the given iterator points to some element with the sequence of symbolic atoms or to the...
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_propagate(clingo_propagate_control_t *control, bool *result)
Propagate implied literals (resulting from added clauses).
undefined arithmetic operation or weight of aggregate
Definition: clingo.h:161
int clingo_symbol_type_t
Corresponding type to clingo_symbol_type.
Definition: clingo.h:314
Definition: clingo.h:2430
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_to_string(clingo_theory_atoms_t *atoms, clingo_id_t atom, char *string, size_t size)
Get the string representation of the given theory atom.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_next(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_symbolic_atom_iterator_t *next)
Get an iterator to the next element in the sequence of symbolic atoms.
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_root(clingo_statistics_t const *statistics, uint64_t *key)
Get the root key of the statistics.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_use_enumeration_assumption(clingo_control_t *control, bool enable)
Configure how learnt constraints are handled during enumeration.
CLINGO_VISIBILITY_DEFAULT bool clingo_model_number(clingo_model_t const *model, uint64_t *number)
Get the running number of the model.
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_cancel(clingo_solve_handle_t *handle)
Stop the running search and block until done.
Definition: clingo.h:2342
Definition: clingo.h:2392
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_add_atom(clingo_backend_t *backend, clingo_symbol_t *symbol, clingo_atom_t *atom)
Get a fresh atom to be used in aspif directives.
Enable non-blocking search.
Definition: clingo.h:2027
struct clingo_propagate_init clingo_propagate_init_t
Object to initialize a user-defined propagator before each solving step.
Definition: clingo.h:1022
Issued when the statistics can be updated.
Definition: clingo.h:2036
CLINGO_VISIBILITY_DEFAULT size_t clingo_symbol_hash(clingo_symbol_t symbol)
Calculate a hash code of a symbol.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_number(clingo_theory_atoms_t *atoms, clingo_id_t term, int *number)
Get the number of the given numeric theory term.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_assign_external(clingo_control_t *control, clingo_literal_t literal, clingo_truth_value_t value)
Assign a truth value to an external atom.
Select all terms.
Definition: clingo.h:1841
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_literal(clingo_propagate_control_t *control, clingo_literal_t *result)
Adds a new volatile literal to the underlying solver thread.
clingo_model_type
Enumeration for the different model types.
Definition: clingo.h:1828
Definition: clingo.h:2466
Definition: clingo.h:2267
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t element, size_t *size)
Get the size of the string representation of the given theory element (including the terminating 0)...
size_t end_line
the line where the location ends
Definition: clingo.h:208
char const * end_file
the file where the location ends
Definition: clingo.h:206
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_to_string_size(clingo_symbol_t symbol, size_t *size)
Get the size of the string representation of a symbol (including the terminating 0).
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_iterator_is_equal_to(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t a, clingo_symbolic_atom_iterator_t b, bool *equal)
Check if two iterators point to the same element (or end of the sequence).
Definition: clingo.h:2646
struct clingo_assignment clingo_assignment_t
Represents a (partial) assignment of a particular solver.
Definition: clingo.h:921
CLINGO_VISIBILITY_DEFAULT bool clingo_model_cost_size(clingo_model_t const *model, size_t *size)
Get the number of cost values of a model.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_solve(clingo_control_t *control, clingo_solve_mode_bitset_t mode, clingo_literal_t const *assumptions, size_t assumptions_size, clingo_solve_event_callback_t notify, void *data, clingo_solve_handle_t **handle)
Solve the currently grounded logic program enumerating its models.
Definition: clingo.h:2558
bool(* clingo_ground_callback_t)(clingo_location_t const *location, char const *name, clingo_symbol_t const *arguments, size_t arguments_size, void *data, clingo_symbol_callback_t symbol_callback, void *symbol_callback_data)
Callback function to implement external functions.
Definition: clingo.h:3091
global variable in tuple of aggregate element
Definition: clingo.h:166
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_string(clingo_symbol_t symbol, char const **string)
Get the string of a symbol.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_has_guard(clingo_theory_atoms_t *atoms, clingo_id_t atom, bool *has_guard)
Whether the theory atom has a guard.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_signatures(clingo_symbolic_atoms_t *atoms, clingo_signature_t *signatures, size_t size)
Get the predicate signatures occurring in a logic program.
assign an external to false
Definition: clingo.h:1322
CLINGO_VISIBILITY_DEFAULT bool clingo_parse_program(char const *program, clingo_ast_callback_t callback, void *callback_data, clingo_logger_t logger, void *logger_data, unsigned message_limit)
Parse the given program and return an abstract syntax tree for each statement via a callback...
unsigned clingo_configuration_type_bitset_t
Bitset for values of type clingo_configuration_type.
Definition: clingo.h:1481
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_project(clingo_backend_t *backend, clingo_atom_t const *atoms, size_t size)
Add a projection directive.
Definition: clingo.h:2614
CLINGO_VISIBILITY_DEFAULT bool clingo_model_extend(clingo_model_t *model, clingo_symbol_t const *symbols, size_t size)
Add symbols to the model.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_new(char const *const *arguments, size_t arguments_size, clingo_logger_t logger, void *logger_data, unsigned message_limit, clingo_control_t **control)
Create a new control object.
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_subkey_name(clingo_configuration_t *configuration, clingo_id_t key, size_t offset, char const **name)
Get the name associated with the offset-th subkey.
int clingo_statistics_type_t
Corresponding type to clingo_statistics_type.
Definition: clingo.h:1665
bool(* clingo_propagator_undo_callback_t)(clingo_propagate_control_t *, clingo_literal_t const *, size_t, void *)
Typedef for clingo_propagator::undo().
Definition: clingo.h:1187
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_has_subkey(clingo_configuration_t *configuration, clingo_id_t key, char const *name, bool *result)
Query whether the map has a key.
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_heuristic(clingo_backend_t *backend, clingo_atom_t atom, clingo_heuristic_type_t type, int bias, unsigned priority, clingo_literal_t const *condition, size_t size)
Add an heuristic directive.
clause is not subject to the solvers deletion policy
Definition: clingo.h:1091
Definition: clingo.h:2478
clingo_truth_value
Represents three-valued truth values.
Definition: clingo.h:192
CLINGO_VISIBILITY_DEFAULT clingo_assignment_t * clingo_propagate_init_assignment(clingo_propagate_init_t *init)
Get the top level assignment solver.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_number(clingo_symbol_t symbol, int *number)
Get the number of a symbol.
CLINGO_VISIBILITY_DEFAULT clingo_error_t clingo_error_code()
Get the last error code set by a clingo API call.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_size(clingo_symbolic_atoms_t *atoms, size_t *size)
Get the number of different atoms occurring in a logic program.
size_t end_column
the column where the location ends
Definition: clingo.h:210
Definition: clingo.h:2629
CLINGO_VISIBILITY_DEFAULT bool clingo_parse_term(char const *string, clingo_logger_t logger, void *logger_data, unsigned message_limit, clingo_symbol_t *symbol)
Parse a term in string form.
CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_number(int number, clingo_symbol_t *symbol)
Construct a symbol representing a number.
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_is_total(clingo_assignment_t *assignment)
Check if the assignmen is total, i.e.
wrong usage of the clingo API
Definition: clingo.h:138
struct clingo_application clingo_application_t
This struct contains a set of functions to customize the clingo application.
clingo_solve_event_type
Enumeration of solve events.
Definition: clingo.h:2034
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_truth_value(clingo_assignment_t *assignment, clingo_literal_t literal, clingo_truth_value_t *value)
Determine the truth value of a given literal.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_ground(clingo_control_t *control, clingo_part_t const *parts, size_t parts_size, clingo_ground_callback_t ground_callback, void *ground_callback_data)
Ground the selected parts of the current (non-ground) logic program.
struct clingo_theory_atoms clingo_theory_atoms_t
Container that stores theory atoms, elements, and terms (see clingo_control_theory_atoms()).
Definition: clingo.h:711
CLINGO_VISIBILITY_DEFAULT void clingo_version(int *major, int *minor, int *revision)
Obtain the clingo version.
int clingo_error_t
Corresponding type to clingo_error.
Definition: clingo.h:143
CLINGO_VISIBILITY_DEFAULT bool clingo_control_load(clingo_control_t *control, char const *file)
Extend the logic program with a program in a file.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_literal(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, clingo_literal_t *literal)
Returns the (numeric) aspif literal corresponding to the given symbolic atom.
Definition: clingo.h:2284
CLINGO_VISIBILITY_DEFAULT clingo_id_t clingo_propagate_control_thread_id(clingo_propagate_control_t *control)
Get the id of the underlying solver thread.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_cleanup(clingo_control_t *control)
Clean up the domains of clingo&#39;s grounding component using the solving component&#39;s top level assignme...
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_name(clingo_theory_atoms_t *atoms, clingo_id_t term, char const **name)
Get the name of the given constant or function theory term.
Definition: clingo.h:2581
int clingo_truth_value_t
Corresponding type to clingo_truth_value.
Definition: clingo.h:198
Select everything.
Definition: clingo.h:1842
CLINGO_VISIBILITY_DEFAULT clingo_propagator_check_mode_t clingo_propagate_init_get_check_mode(clingo_propagate_init_t *init)
Get the current check mode of the propagator.
uint64_t clingo_signature_t
Represents a predicate signature.
Definition: clingo.h:248
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_external(clingo_backend_t *backend, clingo_atom_t atom, clingo_external_type_t type)
Add an external statement.
Definition: clingo.h:2260
CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_begin(clingo_program_builder_t *builder)
Begin building a program.
Definition: clingo.h:2337
Definition: clingo.h:2399
CLINGO_VISIBILITY_DEFAULT bool clingo_model_contains(clingo_model_t const *model, clingo_symbol_t atom, bool *contained)
Constant time lookup to test whether an atom is in a model.
CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_add(clingo_program_builder_t *builder, clingo_ast_statement_t const *statement)
Adds a statement to the program.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_program_builder(clingo_control_t *control, clingo_program_builder_t **builder)
Get an object to add non-ground directives to the program.
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_get(clingo_solve_handle_t *handle, clingo_solve_result_bitset_t *result)
Get the next solve result.
size_t size
number of parameters
Definition: clingo.h:3049
like clingo_clause_type_learnt but the clause is deleted after a solving step
Definition: clingo.h:1092
clingo_theory_term_type
Enumeration of theory term types.
Definition: clingo.h:699
CLINGO_VISIBILITY_DEFAULT void clingo_symbol_create_supremum(clingo_symbol_t *symbol)
Construct a symbol representing #sup.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_arguments(clingo_theory_atoms_t *atoms, clingo_id_t term, clingo_id_t const **arguments, size_t *size)
Get the arguments of the given function theory term.
CLINGO_VISIBILITY_DEFAULT bool clingo_model_context(clingo_model_t const *model, clingo_solve_control_t **control)
Get the associated solve control object of a model.
CLINGO_VISIBILITY_DEFAULT char const * clingo_error_string(clingo_error_t code)
Convert error code into string.
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_has_subkey(clingo_statistics_t const *statistics, uint64_t key, char const *name, bool *result)
Test if the given map contains a specific subkey.
Definition: clingo.h:2192
Definition: clingo.h:2715
clingo_model_printer_t printer
callback to override default model printing
Definition: clingo.h:3468
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_begin(clingo_symbolic_atoms_t *atoms, clingo_signature_t const *signature, clingo_symbolic_atom_iterator_t *iterator)
Get a forward iterator to the beginning of the sequence of all symbolic atoms optionally restricted t...
clingo_main_function_t main
callback to override clingo&#39;s main function
Definition: clingo.h:3466
The model represents a set of cautious consequences.
Definition: clingo.h:1831
char const * name
name of the program part
Definition: clingo.h:3047
The model represents a stable model.
Definition: clingo.h:1829
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_map_subkey_name(clingo_statistics_t const *statistics, uint64_t key, size_t offset, char const **name)
Get the name associated with the offset-th subkey.
bool(* clingo_propagator_init_callback_t)(clingo_propagate_init_t *, void *)
Typedef for clingo_propagator::init().
Definition: clingo.h:1181
clingo_external_type
Enumeration of different external statements.
Definition: clingo.h:1319
CLINGO_VISIBILITY_DEFAULT void clingo_set_error(clingo_error_t code, char const *message)
Set a custom error code and message in the active thread.
clingo_error
Enumeration of error codes.
Definition: clingo.h:135
Definition: clingo.h:2689
the entry is a (double) value
Definition: clingo.h:1660
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_handle_resume(clingo_solve_handle_t *handle)
Discards the last model and starts the search for the next one.
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_assume(clingo_backend_t *backend, clingo_literal_t const *literals, size_t size)
Add an assumption directive.
CLINGO_VISIBILITY_DEFAULT size_t clingo_assignment_max_size(clingo_assignment_t *assignment)
The maximum size of the assignment (if all literals are assigned).
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_description(clingo_configuration_t *configuration, clingo_id_t key, char const **description)
Get the description of an entry.
CLINGO_VISIBILITY_DEFAULT uint32_t clingo_assignment_decision_level(clingo_assignment_t *assignment)
Get the current decision level.
assign an external to true
Definition: clingo.h:1321
Represents a source code location marking its beginnig and end.
Definition: clingo.h:204
clingo_statistics_type
Enumeration for entries of the statistics.
Definition: clingo.h:1658
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_name(clingo_symbol_t symbol, char const **name)
Get the name of a symbol.
Definition: clingo.h:2293
a function term, e.g., f(1,2,3)
Definition: clingo.h:703
struct clingo_symbolic_atoms clingo_symbolic_atoms_t
Object to inspect symbolic atoms in a program—the relevant Herbrand base gringo uses to instantiate ...
Definition: clingo.h:527
the #sup symbol
Definition: clingo.h:311
clingo_solve_mode
Enumeration of solve modes.
Definition: clingo.h:2026
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_theory_atoms(clingo_propagate_init_t *init, clingo_theory_atoms_t **atoms)
Get an object to inspect the theory atoms.
clingo_heuristic_type
Enumeration of different heuristic modifiers.
Definition: clingo.h:1305
CLINGO_VISIBILITY_DEFAULT size_t clingo_signature_hash(clingo_signature_t signature)
Calculate a hash code of a signature.
the entry is an array
Definition: clingo.h:1661
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_minimize(clingo_backend_t *backend, clingo_weight_t priority, clingo_weighted_literal_t const *literals, size_t size)
Add a minimize constraint (or weak constraint) to the program.
CLINGO_VISIBILITY_DEFAULT void clingo_control_free(clingo_control_t *control)
Free a control object created with clingo_control_new().
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_rule(clingo_backend_t *backend, bool choice, clingo_atom_t const *head, size_t head_size, clingo_literal_t const *body, size_t body_size)
Add a rule to the program.
struct clingo_part clingo_part_t
Struct used to specify the program parts that have to be grounded.
CLINGO_VISIBILITY_DEFAULT int clingo_main(clingo_application_t *application, char const *const *arguments, size_t size, void *data)
Run clingo with a customized main function (similar to python and lua embedding). ...
clingo_configuration_type
Enumeration for entries of the configuration.
Definition: clingo.h:1475
CLINGO_VISIBILITY_DEFAULT bool clingo_model_thread_id(clingo_model_t const *model, clingo_id_t *id)
Get the id of the solver thread that found the model.
Definition: clingo.h:2609
int clingo_heuristic_type_t
Corresponding type to clingo_heuristic_type.
Definition: clingo.h:1315
int clingo_theory_term_type_t
Corresponding type to clingo_theory_term_type.
Definition: clingo.h:708
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_arguments(clingo_symbol_t symbol, clingo_symbol_t const **arguments, size_t *arguments_size)
Get the arguments of a symbol.
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_map_size(clingo_configuration_t *configuration, clingo_id_t key, size_t *size)
Get the number of subkeys of a map entry.
unsigned clingo_solve_mode_bitset_t
Corresponding type to clingo_solve_mode.
Definition: clingo.h:2031
bool(* clingo_default_model_printer_t)(void *data)
Callback to print a model in default format.
Definition: clingo.h:3449
false
Definition: clingo.h:195
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_to_string(clingo_theory_atoms_t *atoms, clingo_id_t element, char *string, size_t size)
Get the string representation of the given theory element.
Select shown atoms and terms.
Definition: clingo.h:1839
CLINGO_VISIBILITY_DEFAULT bool clingo_control_register_observer(clingo_control_t *control, clingo_ground_program_observer_t const *observer, bool replace, void *data)
Register a program observer with the control object.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_symbolic_atoms(clingo_control_t *control, clingo_symbolic_atoms_t **atoms)
Get an object to inspect symbolic atoms (the relevant Herbrand base) used for grounding.
call clingo_propagator::check() on propagation fixpoints
Definition: clingo.h:1008
struct clingo_options clingo_options_t
Object to add command-line options.
Definition: clingo.h:3432
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_condition(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_literal_t const **condition, size_t *size)
Get the condition (array of aspif literals) of the given theory element.
The last solve call did not find a solution.
Definition: clingo.h:1984
int32_t clingo_weight_t
Signed integer type for weights in sum aggregates and minimize constraints.
Definition: clingo.h:127
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_array_size(clingo_configuration_t *configuration, clingo_id_t key, size_t *size)
Get the size of an array entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_function(char const *name, clingo_symbol_t const *arguments, size_t arguments_size, bool positive, clingo_symbol_t *symbol)
Construct a symbol representing a function or tuple.
the entry is a map
Definition: clingo.h:1662
CLINGO_VISIBILITY_DEFAULT bool clingo_solve_control_symbolic_atoms(clingo_solve_control_t *control, clingo_symbolic_atoms_t **atoms)
Get an object to inspect the symbolic atoms.
struct clingo_propagator clingo_propagator_t
An instance of this struct has to be registered with a solver to implement a custom propagator...
unsigned clingo_solve_result_bitset_t
Corresponding type to clingo_solve_result.
Definition: clingo.h:1988
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_is_positive(clingo_symbol_t symbol, bool *positive)
Check if a function is positive (does not have a sign).
uint32_t clingo_id_t
Unsigned integer type used in various places.
Definition: clingo.h:125
Definition: clingo.h:2252
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_to_string(clingo_theory_atoms_t *atoms, clingo_id_t term, char *string, size_t size)
Get the string representation of the given theory term.
bool(* clingo_main_function_t)(clingo_control_t *control, char const *const *files, size_t size, void *data)
Callback to customize clingo main function.
Definition: clingo.h:3442
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_id(char const *name, bool positive, clingo_symbol_t *symbol)
Construct a symbol representing an id.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_register_propagator(clingo_control_t *control, clingo_propagator_t const *propagator, void *data, bool sequential)
Register a custom propagator with the control object.
CLINGO_VISIBILITY_DEFAULT bool clingo_model_optimality_proven(clingo_model_t const *model, bool *proven)
Whether the optimality of a model has been proven.
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_has_conflict(clingo_assignment_t *assignment)
Check if the given assignment is conflicting.
Definition: clingo.h:2376
An instance of this struct has to be registered with a solver to observe ground directives as they ar...
Definition: clingo.h:2804
Definition: clingo.h:2601
clause is subject to the solvers deletion policy
Definition: clingo.h:1090
CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_negative(clingo_signature_t signature)
Whether the signature is negative (is classically negated).
clingo_propagator_check_mode
Supported check modes for propagators.
Definition: clingo.h:1005
CLINGO_VISIBILITY_DEFAULT void clingo_control_interrupt(clingo_control_t *control)
Interrupt the active solve call (or the following solve call right at the beginning).
CLINGO_VISIBILITY_DEFAULT bool clingo_assignment_decision(clingo_assignment_t *assignment, uint32_t level, clingo_literal_t *literal)
Determine the decision literal given a decision level.
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_add_watch_to_thread(clingo_propagate_init_t *init, clingo_literal_t solver_literal, uint32_t thread_id)
Add a watch for the solver literal in the given phase to the given solver thread. ...
the entry is invalid (has neither of the types below)
Definition: clingo.h:1659
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_value_set(clingo_statistics_t *statistics, uint64_t key, double value)
Set the value of the given entry.
call clingo_propagator::check() on total assignment
Definition: clingo.h:1007
Definition: clingo.h:2496
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_get_size(clingo_configuration_t *configuration, clingo_id_t key, size_t *size)
Get the size of the string value of the given entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_element_tuple(clingo_theory_atoms_t *atoms, clingo_id_t element, clingo_id_t const **tuple, size_t *size)
Get the tuple (array of theory terms) of the given theory element.
memory could not be allocated
Definition: clingo.h:139
Definition: clingo.h:2350
void(* clingo_logger_t)(clingo_warning_t code, char const *message, void *data)
Callback to intercept warning messages.
Definition: clingo.h:182
CLINGO_VISIBILITY_DEFAULT bool clingo_options_add(clingo_options_t *options, char const *group, char const *option, char const *description, bool(*parse)(char const *value, void *data), void *data, bool multi, char const *argument)
Add an option that is processed with a custom parser.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_size(clingo_theory_atoms_t *atoms, size_t *size)
Get the total number of theory atoms.
CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_positive(clingo_signature_t signature)
Whether the signature is positive (is not classically negated).
CLINGO_VISIBILITY_DEFAULT int clingo_propagate_init_number_of_threads(clingo_propagate_init_t *init)
Get the number of threads used in subsequent solving.
Definition: clingo.h:2669
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t atom, size_t *size)
Get the size of the string representation of the given theory atom (including the terminating 0)...
CLINGO_VISIBILITY_DEFAULT bool clingo_add_string(char const *string, char const **result)
Internalize a string.
bool(* clingo_propagator_propagate_callback_t)(clingo_propagate_control_t *, clingo_literal_t const *, size_t, void *)
Typedef for clingo_propagator::propagate().
Definition: clingo.h:1184
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_get(clingo_configuration_t *configuration, clingo_id_t key, char *value, size_t size)
Get the string value of the given entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_has_const(clingo_control_t *control, char const *name, bool *exists)
Check if there is a constant definition for the given constant.
CLINGO_VISIBILITY_DEFAULT bool clingo_model_cost(clingo_model_t const *model, int64_t *costs, size_t size)
Get the cost vector of a model.
Select CSP assignments.
Definition: clingo.h:1838
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_array_at(clingo_configuration_t *configuration, clingo_id_t key, size_t offset, clingo_id_t *subkey)
Get the subkey at the given offset of an array entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_type(clingo_theory_atoms_t *atoms, clingo_id_t term, clingo_theory_term_type_t *type)
Get the type of the given theory term.
A Literal with an associated weight.
Definition: clingo.h:1331
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_at(clingo_statistics_t const *statistics, uint64_t key, size_t offset, uint64_t *subkey)
Get the subkey at the given offset of an array entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_set(clingo_configuration_t *configuration, clingo_id_t key, char const *value)
Set the value of an entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_is_conflicting(clingo_control_t *control)
Check if the solver has determined that the internal program representation is conflicting.
Select false instead of true atoms (clingo_show_type_atoms) or terms (clingo_show_type_terms).
Definition: clingo.h:1843
like clingo_clause_type_static but the clause is deleted after a solving step
Definition: clingo.h:1093
An instance of this struct has to be registered with a solver to implement a custom propagator...
Definition: clingo.h:1196
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_term(clingo_theory_atoms_t *atoms, clingo_id_t atom, clingo_id_t *term)
Get the theory term associated with the theory atom.
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_atom_guard(clingo_theory_atoms_t *atoms, clingo_id_t atom, char const **connective, clingo_id_t *term)
Get the guard consisting of a theory operator and a theory term of the given theory atom...
same file included multiple times
Definition: clingo.h:164
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_init_solver_literal(clingo_propagate_init_t *init, clingo_literal_t aspif_literal, clingo_literal_t *solver_literal)
Map the given program literal or condition id to its solver literal.
a numeric symbol, e.g., 1
Definition: clingo.h:308
CLINGO_VISIBILITY_DEFAULT bool clingo_control_get_const(clingo_control_t *control, char const *name, clingo_symbol_t *symbol)
Return the symbol for a constant definition of form: #const name = symbol.
CLINGO_VISIBILITY_DEFAULT char const * clingo_warning_string(clingo_warning_t code)
Convert warning code into string.
Definition: clingo.h:2245
Definition: clingo.h:2653
int clingo_model_type_t
Corresponding type to clingo_model_type.
Definition: clingo.h:1834
struct clingo_solve_control clingo_solve_control_t
Object to add clauses during search.
Definition: clingo.h:1822
CLINGO_VISIBILITY_DEFAULT bool clingo_model_symbols(clingo_model_t const *model, clingo_show_type_bitset_t show, clingo_symbol_t *symbols, size_t size)
Get the symbols of the selected types in the model.
clingo_warning
Enumeration of warning codes.
Definition: clingo.h:160
to report multiple errors; a corresponding runtime error is raised later
Definition: clingo.h:162
bool(* clingo_solve_event_callback_t)(clingo_solve_event_type_t type, void *event, void *data, bool *goon)
Callback function called during search to notify when the search is finished or a model is ready...
Definition: clingo.h:2056
unsigned clingo_show_type_bitset_t
Corresponding type to clingo_show_type.
Definition: clingo.h:1846
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_has_watch(clingo_propagate_control_t *control, clingo_literal_t literal)
Check whether a literal is watched in the current solver thread.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_end(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t *iterator)
Iterator pointing to the end of the sequence of symbolic atoms.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_backend(clingo_control_t *control, clingo_backend_t **backend)
Get an object to add ground directives to the program.
The model represents a set of brave consequences.
Definition: clingo.h:1830
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_end(clingo_backend_t *backend)
Finalize the backend after using it.
struct clingo_program_builder clingo_program_builder_t
Object to build non-ground programs.
Definition: clingo.h:2760
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_root(clingo_configuration_t *configuration, clingo_id_t *key)
Get the root key of the configuration.
The last solve call found a solution.
Definition: clingo.h:1983
CLINGO_VISIBILITY_DEFAULT uint32_t clingo_signature_arity(clingo_signature_t signature)
Get the arity of a signature.
the entry is an array
Definition: clingo.h:1477
CLINGO_VISIBILITY_DEFAULT void clingo_propagate_control_remove_watch(clingo_propagate_control_t *control, clingo_literal_t literal)
Removes the watch (if any) for the given solver literal.
int clingo_warning_t
Corresponding type to clingo_warning.
Definition: clingo.h:170
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_is_external(clingo_symbolic_atoms_t *atoms, clingo_symbolic_atom_iterator_t iterator, bool *external)
Check whether an atom is external.
CLINGO_VISIBILITY_DEFAULT bool clingo_model_is_true(clingo_model_t const *model, clingo_literal_t literal, bool *result)
Check if a program literal is true in a model.
no truth value
Definition: clingo.h:193
Definition: clingo.h:2551
set the level of an atom
Definition: clingo.h:1306
Definition: clingo.h:2359
CLINGO_VISIBILITY_DEFAULT bool clingo_control_clasp_facade(clingo_control_t *control, void **clasp)
Get low-level access to clasp.
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_value_get(clingo_statistics_t const *statistics, uint64_t key, double *value)
Get the value of the given entry.
a numeric symbol, e.g., c, (1, "a"), or f(1,"a")
Definition: clingo.h:310
clingo_clause_type
Enumeration of clause types determining the lifetime of a clause.
Definition: clingo.h:1089
CLINGO_VISIBILITY_DEFAULT bool clingo_signature_is_less_than(clingo_signature_t a, clingo_signature_t b)
Check if a signature is less than another signature.
CLINGO_VISIBILITY_DEFAULT char const * clingo_error_message()
Get the last error message set if an API call fails.
struct clingo_weighted_literal clingo_weighted_literal_t
A Literal with an associated weight.
a number term, e.g., 42
Definition: clingo.h:704
undefined atom in program
Definition: clingo.h:163
successful API calls
Definition: clingo.h:136
Definition: clingo.h:2661
CLINGO_VISIBILITY_DEFAULT char const * clingo_signature_name(clingo_signature_t signature)
Get the name of a signature.
Definition: clingo.h:2408
CLINGO_VISIBILITY_DEFAULT bool clingo_statistics_array_size(clingo_statistics_t const *statistics, uint64_t key, size_t *size)
Get the size of an array entry.
CLINGO_VISIBILITY_DEFAULT bool clingo_control_release_external(clingo_control_t *control, clingo_literal_t literal)
Release an external atom.
unsigned clingo_solve_event_type_t
Corresponding type to clingo_solve_event_type.
Definition: clingo.h:2040
errors only detectable at runtime like invalid input
Definition: clingo.h:137
the #inf symbol
Definition: clingo.h:307
struct clingo_configuration clingo_configuration_t
Handle for to the solver configuration.
Definition: clingo.h:1484
Definition: clingo.h:2678
CLINGO_VISIBILITY_DEFAULT bool clingo_theory_atoms_term_to_string_size(clingo_theory_atoms_t *atoms, clingo_id_t term, size_t *size)
Get the size of the string representation of the given theory term (including the terminating 0)...
CLINGO_VISIBILITY_DEFAULT bool clingo_configuration_value_is_assigned(clingo_configuration_t *configuration, clingo_id_t key, bool *assigned)
Check whether a entry has a value.
size_t begin_line
the line where the location begins
Definition: clingo.h:207
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_create_string(char const *string, clingo_symbol_t *symbol)
Construct a symbol representing a string.
Select all atoms.
Definition: clingo.h:1840
CLINGO_VISIBILITY_DEFAULT bool clingo_propagate_control_add_watch(clingo_propagate_control_t *control, clingo_literal_t literal)
Add a watch for the solver literal in the given phase.
Definition: clingo.h:2216
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_weight_rule(clingo_backend_t *backend, bool choice, clingo_atom_t const *head, size_t head_size, clingo_weight_t lower_bound, clingo_weighted_literal_t const *body, size_t body_size)
Add a weight rule to the program.
bool(* clingo_model_printer_t)(clingo_model_t const *model, clingo_default_model_printer_t printer, void *printer_data, void *data)
Callback to customize model printing.
Definition: clingo.h:3459
true
Definition: clingo.h:194
CLINGO_VISIBILITY_DEFAULT bool clingo_symbolic_atoms_signatures_size(clingo_symbolic_atoms_t *atoms, size_t *size)
Get the number of different predicate signatures used in the program.
CLINGO_VISIBILITY_DEFAULT bool clingo_program_builder_end(clingo_program_builder_t *builder)
End building a program.
CLINGO_VISIBILITY_DEFAULT bool clingo_symbol_to_string(clingo_symbol_t symbol, char *string, size_t size)
Get the string representation of a symbol.
uint64_t clingo_symbol_t
Represents a symbol.
Definition: clingo.h:320
CLINGO_VISIBILITY_DEFAULT bool clingo_backend_begin(clingo_backend_t *backend)
Prepare the backend for usage.