Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Ongoing

- add `variable_declared(X)` output for user-facing variables with an active
declaration.
- add `variable_defined(X)` output for user-facing variables with a non-`bad`
value, including empty collections.
- - rename `find`, `find2`, `maxEntries`, and `minEntries` to `multima_find`,
`multimap_find2`, `multimap_maxEntries`, and `multimap_minEntries`.
- - update `preference_holds` and `preference_variableValue` to take an
Expand Down
2 changes: 2 additions & 0 deletions docs/developer/fact-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,8 @@ This page describes the EBNF grammar for the fact format used by the constraint

<atom> ::=
| "value" "(" <variable> "," <val> ")"
| "variable_declared" "(" <variable> ")"
| "variable_defined" "(" <variable> ")"
| "evaluated" "(" <operator> "," <expression-list> "," <val> ")"
| "set_value" "(" <variable> "," <val> ")"
| "multimap_value" "(" <variable> "," <val> "," <val> ")"
Expand Down
2 changes: 2 additions & 0 deletions docs/fact-format/fact-format.tex
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,8 @@ \subsection{Result fact format}

<atom> ::=
~\alt `value' `(' <variable> `,' <val> `)'
\alt `variable_declared' `(' <variable> `)'
\alt `variable_defined' `(' <variable> `)'
\alt `evaluated' `(' <operator> `,' <expression-list> `,' <val> `)'
\alt `set_value' `(' <variable> `,' <val> `)'
\alt `multimap_value' `(' <variable> `,' <val> `,' <val> `)'
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/core_syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,15 @@ Variables represent references to values that can be reused throughout the progr

**[Result]**{.badge .result }

`variable_declared(Name)` is added to the model when at least one declaration
of the user-facing variable `Name` has a condition that evaluates to true.
This includes declarations introduced by `variable_define` and collection
declarations. The marker is present even when the variable evaluates to `bad`
or is an empty collection.

`variable_defined(Name)` is added to the model when the user-facing variable
`Name` has a value other than `bad`. This includes empty collections.

When a variable is assigned a value, an atom of the `value/2` predicate is added to the model.
The same predicate is also used by some higher-level features, such as labeled optimization declarations, to expose aggregated results in the final model.

Expand Down
3 changes: 3 additions & 0 deletions src/constraint_handler/data/6_solve/propagator/propagator.lp
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,8 @@ propagator_multimap_declare(X,LBL) :- _passed(propagator,LBL,variable_declare(X,

propagator_share_value(E,LBL) :- _passed(propagator,LBL,share_value(E)).

%{ _propagator_variable_defined(X) } :- _passed(propagator,LBL,variable_declare(X,D,C)), ch_post(variable_interface(X),LBL2), _bool_evaluated(C,val(bool,true)).
_variable_defined(X) :- _propagator_variable_defined(X).

propagator_warning_forbid(KIND,LBL) :- _warning_forbid(KIND,LBL).
propagator_warning_ignore(KIND,LBL) :- _warning_ignore(KIND,LBL).
5 changes: 5 additions & 0 deletions src/constraint_handler/data/7_output/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
### Input predicates

_bool_evaluated/2.
_expression(compile,variable/1).
_passed(ENG,LBL,share_value/1).
_se_value/2.
_set_contains/2.
ch_post(variable_interface/1,LBL).
ch_post(evaluate/2,LBL).
_warning/3.
ch_core(variable_declare/3,LBL).
ch_core(warning_forbid/1,LBL).
ch_core(warning_ignore/1,LBL).

Expand All @@ -15,6 +17,7 @@ ch_core(warning_ignore/1,LBL).
_se_value1/1.
_shared_value/2.
_type_variableD/2.
_variable_declared/1.
_warning_forbid/2.
_warning_ignore/2.
_warning_raised/2.
Expand All @@ -25,5 +28,7 @@ warning_raised/0.
set_value/2.
type_variableD/2.
value/2.
variable_declared/1.
variable_defined/1.
warning/3.
evaluated/2.
5 changes: 5 additions & 0 deletions src/constraint_handler/data/7_output/value.lp
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
_variable_declared(X) :- ch_core(variable_declare(X,D,C),LBL), _bool_evaluated(C,val(bool,true)).
variable_declared(X) :- _variable_declared(X), ch_post(variable_interface(X),LBL).
_variable_defined(X) :- _se_value(variable(X),V), V != bad.
variable_defined(X) :- _variable_defined(X), ch_post(variable_interface(X),LBL).

set_value(X,V) :- _se_value(variable(X),set), _set_contains(variable(X),V), ch_post(variable_interface(X),LBL). %%% for compile2
set_value(X,V) :- _se_value(variable(X),ref(set,E)), _set_contains(E,V), ch_post(variable_interface(X),LBL).
value(X,V) :- _se_value(variable(X),V), V != set, V != bad, ch_post(variable_interface(X),LBL).
Expand Down
1 change: 1 addition & 0 deletions src/constraint_handler/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ None.
warning/3.
set_value/2.
value/2.
variable_declared/1.
multimap_value/3.
bool_evaluated/2.
evaluated/2.
Expand Down
4 changes: 4 additions & 0 deletions src/constraint_handler/schemas/internal.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ class _shared_value(NamedTuple):
val: expression.ReducedExpr


class _variable_declared(NamedTuple):
name: expression.constant


class _optimize_component(NamedTuple):
expr: expression.Expr
original: expression.Expr
Expand Down
10 changes: 9 additions & 1 deletion src/constraint_handler/schemas/result.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,17 @@ def __repr__(self):
return f"Value({str(self.name)},{str(self.val)})"


class Variable_declared(NamedTuple):
name: expression.constant


class Variable_defined(NamedTuple):
name: expression.constant


class Evaluated(NamedTuple):
expr: expression.Expr
value: expression.ReducedExpr


type ResultAtom = Bool_evaluated | Evaluated | Set_value | Multimap_value | OptimizeResult | Preference_score | Value | warning.Warning | warning.Warning_raised
type ResultAtom = Bool_evaluated | Evaluated | Set_value | Multimap_value | OptimizeResult | Preference_score | Value | Variable_declared | Variable_defined | warning.Warning | warning.Warning_raised
13 changes: 13 additions & 0 deletions src/flat_ch/api/ch/api.lp
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,14 @@ _fch_selected_var_def(NAME, DEFAULT_ID) :- _fch_default_apply(NAME, DEFAULT_ID,
% CH-facing output compatibility.
%

variable_declared(NAME) :- _fch_var_active(NAME).

variable_defined(NAME) :-
_fch_dynamic_var_def(NAME, EXPR_ID),
_fch_dynamic_expr_val(EXPR_ID, TYPE, _),
TYPE != _fch_type_fail_id.
variable_defined(NAME) :- _fch_var_active(NAME, set).

set_size(NAME, SIZE) :- _fch_set_handle(NAME), _fch_set_size(NAME, SIZE).
set_size(VAR_NAME, SIZE) :- _fch_var_def(VAR_NAME, TARGET_ID), _fch_set_handle(TARGET_ID), _fch_set_size(TARGET_ID, SIZE).

Expand Down Expand Up @@ -289,6 +297,11 @@ value(NAME, bad) :-

value(NAME, bad) :- _fch_empty_var_domain(NAME).

value(NAME, bad) :-
variable_declared(NAME),
_fch_var_active(NAME, definition),
not _fch_dynamic_var_def(NAME, _).

_fch_execution_input_declared(EXEC, VAR) :- _fch_flat(var_decl((EXEC, VAR, in))).
_fch_execution_input_defined(EXEC, VAR) :- _fch_flat(var_def((EXEC, VAR, in), _)).
_fch_execution_input_has_domain(EXEC, VAR) :-
Expand Down
6 changes: 6 additions & 0 deletions tests/correctness/core/variable/declared.expected.all
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
variable_declared(active)
variable_declared(conditional)
variable_declared(empty_set)
variable_declared(enabled)
variable_declared(multiple)
value(active,bad)
3 changes: 3 additions & 0 deletions tests/correctness/core/variable/declared.expected.none
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
variable_declared(bad_condition)
variable_declared(inactive)
variable_declared(undeclared)
8 changes: 8 additions & 0 deletions tests/correctness/core/variable/declared.lp
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
variable_define(enabled,val(bool,true)).
variable_declare(active,definition,val(bool,true)).
variable_declare(inactive,definition,val(bool,false)).
variable_declare(bad_condition,definition,bad).
variable_declare(conditional,definition,variable(enabled)).
variable_declare(multiple,definition,val(bool,false)).
variable_declare(multiple,definition,val(bool,true)).
variable_declare(empty_set,set).
6 changes: 6 additions & 0 deletions tests/correctness/core/variable/defined.expected.all
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
variable_defined(boolean)
variable_defined(defined)
variable_defined(defined_set)
variable_defined(empty_set)
variable_defined(integer)
not_defined(inactive)
2 changes: 2 additions & 0 deletions tests/correctness/core/variable/defined.expected.any
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
variable_defined(conditional)
not_defined(conditional)
7 changes: 7 additions & 0 deletions tests/correctness/core/variable/defined.expected.none
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
variable_defined(failed)
variable_defined(inactive)
not_defined(boolean)
not_defined(defined)
not_defined(defined_set)
not_defined(empty_set)
not_defined(integer)
19 changes: 19 additions & 0 deletions tests/correctness/core/variable/defined.lp
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
variable_declare(integer,fromFacts).
variable_domain(integer,val(int,42)).
variable_domain(integer,val(int,43)).
variable_declare(boolean,boolDomain).
variable_declare(forced_condition,boolDomain).
ensure(variable(forced_condition)).
variable_declare(defined,definition,variable(forced_condition)).
variable_define(defined,val(int,7)).
variable_declare(conditional,definition,variable(boolean)).
variable_define(conditional,val(int,8)).
variable_declare(failed,definition).
variable_define(failed,bad).
variable_declare(empty_set,set).
variable_declare(defined_set,set).
set_assign(defined_set,val(int,1)).
variable_declare(inactive,definition,val(bool,false)).
variable_define(inactive,val(int,7)).
not_defined(X) :- variable_declare(X,D), not variable_defined(X).
not_defined(X) :- variable_declare(X,D,C), not variable_defined(X).
5 changes: 5 additions & 0 deletions tests/test_encoding.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ def run_test(name: str, selected_engine: engine.Engine):
# "core/unbound_variable_expressions",
"core/unprojected_optional_equality",
"core/set_to_variable",
"core/variable/declared",
"core/variable/defined",
]

datatype_tests = [
Expand Down Expand Up @@ -659,6 +661,7 @@ def run_test(name: str, selected_engine: engine.Engine):
"core/conditional_declare_definition",
"core/conditional_declare_set_multiple",
"core/reasoning_modes_with_show",
"core/variable/defined",
"datatype/bool/conj_disj_mixed",
"datatype/float/mult/recovery",
"default/basic_true",
Expand Down Expand Up @@ -703,6 +706,7 @@ def run_test(name: str, selected_engine: engine.Engine):
"core/reasoning_modes_with_show",
"core/conditional_domain",
"core/unbound_variable_expressions",
"core/variable/defined",
"execution/conditional_input_domain",
"execution/conditional_input_domain_dynamic",
"execution/python_integrity_should_be_ignored",
Expand Down Expand Up @@ -793,6 +797,7 @@ def test_engine(name: str, selected_engine: engine.Engine):
"core/set_interface_value_marker",
"core/shared_optional_output_domains",
"core/unprojected_optional_equality",
"core/variable/defined",
"datatype/bool/conj_disj/none",
"datatype/bool/conj_disj/variable",
"datatype/bool/leqv_lxor/none",
Expand Down
Loading