Product Configuration¶
Documentation generated automatically, showcasing the use of mkdoclingo for a large project
where the documentation of predicates is in a separate file.
Tip
Use the icon in the top right to see the source code for this page.
Predicate Summary ¶
| Name | Definition | Type |
|---|---|---|
include/1 |
Whether a variable is included in the configuration |
|
value/2 |
The value of an attribute variable |
|
allow/3 |
Defines an entry of a table constraint (for allowed combinations) |
|
binary/4 |
Defines a binary operation |
|
column/4 |
Defines a column of a table constraint |
|
constant/1 |
Auxiliary predicate which defines a constant (string) |
|
constraint/2 |
Instantiates a constraint |
|
discrete/1 |
Declares the part of a discrete attribute |
|
domain/2 |
Declares a domain element of a discrete attribute |
|
function/3 |
Defines a calculation involving a function |
|
hit/3 |
Whether an entry of a table constraint is satisfied (only for fclingo encoding) |
|
index/2 |
The index of a variable in a cardinality set, for example, "root.frame[1]" has index 1 |
|
integer/1 |
Declares the part of an integer attribute |
|
number/2 |
Auxiliary predicate which defines a constant number |
|
parent/2 |
The parent of a variable |
|
part/1 |
Declares the type of a part |
|
range/3 |
Declares the range of an integer attribute |
|
set/2 |
Defines the members of a set (for cardinalities and aggregate functions) |
|
type/2 |
The type of a variable |
|
unary/3 |
Defines a unary operation |
|
undefined/1 |
Whether a variable or (sub)formula is undefined |
|
user_include/1 |
An include statement from user input |
|
user_value/2 |
An attribute variable value set by user input |
|
violated/1 |
Whether a constraint is violated (Boolean, table or lower bound) |
|
consistent/1 |
Whether a user input variable is consistent with the configuration model |
|
consistent/2 |
Whether a user input value is consistent with the configuration model |
|
defined/1 |
Whether a variable or (sub)formula is defined |
|
defined/2 |
Whether a table constraint is defined |
|
not_hit/3 |
Whether a row of a table constraint is not satisfied |
|
satisfied/1 |
Whether a variable or (sub)formula is satisfied |
|
satisfied/2 |
Whether a table constraint is satisfied |
|
undefined/2 |
Whether a table constraint is undefined |
|
Glossary ¶
include(X)
¶
Whether a variable is included in the configuration
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) |
value(X,V)
¶
The value of an attribute variable
| Parameter | Description |
|---|---|
X |
The attribute variable |
V |
The value of the variable |
allow(Idx,(Col,Row),V)
¶
Defines an entry of a table constraint (for allowed combinations)
| Parameter | Description |
|---|---|
Idx |
The index of the table constraint (part of the constraint identifier) |
Col |
The column number |
Row |
The row number |
V |
The value of the table entry |
binary(F,L,Op,R)
¶
Defines a binary operation
| Parameter | Description |
|---|---|
F |
The identifier of the complete formula |
L |
The identifier of the left operand |
Op |
The operator |
R |
The identifier of the right operand |
column(C,ID,Col,X)
¶
Defines a column of a table constraint
| Parameter | Description |
|---|---|
C |
The identifier of the constraint |
ID |
The identifier of the cross product of the table header variables |
Col |
The column number |
X |
The header variable of the column |
constant(C)
¶
Auxiliary predicate which defines a constant (string)
| Parameter | Description |
|---|---|
C |
The constant as a string |
constraint(C,T)
¶
Instantiates a constraint
| Parameter | Description |
|---|---|
C |
The constraint identifier |
T |
The type of the constraint (boolean, table, lowerbound) |
discrete(T)
¶
Declares the part of a discrete attribute
| Parameter | Description |
|---|---|
T |
The type of the attribute |
domain(T,V)
¶
Declares a domain element of a discrete attribute
| Parameter | Description |
|---|---|
T |
The type of the attribute |
V |
The domain element |
function(F,Fun,Arg)
¶
Defines a calculation involving a function
| Parameter | Description |
|---|---|
F |
The identifier of the complete formula |
Fun |
The function type |
Arg |
The argument of the function |
hit(C,ID,(Col,Row))
¶
Whether an entry of a table constraint is satisfied (only for fclingo encoding)
| Parameter | Description |
|---|---|
C |
The table constraint identifier |
ID |
The identifier of the cross product of the column header variables |
Col |
The column number |
Row |
The row number |
index(X,I)
¶
The index of a variable in a cardinality set, for example, "root.frame[1]" has index 1
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) |
I |
The index of the variable |
integer(T)
¶
Declares the part of an integer attribute
| Parameter | Description |
|---|---|
T |
The type of the attribute |
number(C,N)
¶
Auxiliary predicate which defines a constant number
| Parameter | Description |
|---|---|
C |
The number as a string |
N |
The number as an integer |
parent(X,P)
¶
The parent of a variable
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) |
P |
The parent of the variable |
part(T)
¶
Declares the type of a part
| Parameter | Description |
|---|---|
T |
The type of the part |
range(T,Min,Max)
¶
Declares the range of an integer attribute
| Parameter | Description |
|---|---|
T |
The type of the attribute |
Min |
The minimum value of the range |
Max |
The maximum value of the range |
set(S,X)
¶
Defines the members of a set (for cardinalities and aggregate functions)
| Parameter | Description |
|---|---|
S |
The identifier of the set |
X |
The variable (either a part or an attribute) which is a member of the set |
type(X,T)
¶
The type of a variable
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) |
T |
The type of the variable |
unary(F,Op,F')
¶
Defines a unary operation
| Parameter | Description |
|---|---|
F |
The identifier of the complete formula |
Op |
The operator |
F' |
The identifier of the operand |
undefined(X)
¶
Whether a variable or (sub)formula is undefined
| Parameter | Description |
|---|---|
X |
The variable or (sub)formula |
user_include(X)
¶
An include statement from user input
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) to be included |
user_value(X,V)
¶
An attribute variable value set by user input
| Parameter | Description |
|---|---|
X |
The attribute variable for which the value is set |
V |
The value of the attribute variable |
violated(C)
¶
Whether a constraint is violated (Boolean, table or lower bound)
| Parameter | Description |
|---|---|
C |
The constraint identifier (tuple that differs for each constraint type) |
consistent(X)
¶
Whether a user input variable is consistent with the configuration model
| Parameter | Description |
|---|---|
X |
The variable (either a part or an attribute) to be included |
consistent(X,V)
¶
Whether a user input value is consistent with the configuration model
| Parameter | Description |
|---|---|
X |
The attribute variable for which the value is set |
V |
The value of the attribute variable |
defined(X)
¶
Whether a variable or (sub)formula is defined
| Parameter | Description |
|---|---|
X |
The variable or (sub)formula |
defined(C,ID)
¶
Whether a table constraint is defined
| Parameter | Description |
|---|---|
C |
The table constraint identifier |
ID |
The identifier of the cross product of the column header variables |
not_hit(C,ID,Row)
¶
Whether a row of a table constraint is not satisfied
| Parameter | Description |
|---|---|
C |
The table constraint identifier |
ID |
The identifier of the cross product of the column header variables |
Row |
The row number |
satisfied(X)
¶
Whether a variable or (sub)formula is satisfied
| Parameter | Description |
|---|---|
X |
The variable or (sub)formula |
satisfied(C,ID)
¶
Whether a table constraint is satisfied
| Parameter | Description |
|---|---|
C |
The table constraint identifier |
ID |
The identifier of the cross product of the column header variables |
undefined(C,ID)
¶
Whether a table constraint is undefined
| Parameter | Description |
|---|---|
C |
The table constraint identifier |
ID |
The identifier of the cross product of the column header variables |