Predicate table

Generates a summary of the predicates used in all the included encodings.

The definition is taken from the predicate documentation , and the type indicates the following:

Title	Icon
Input (Not defined by any rule)
Shown Explicitly (using `predicate/arity`)
Shown Partially (using a conditional statement)
Hidden

Example

Output Usage

Name	Definition	Type
`sudoku/3`	Describes a sudoku board. The value of cell (X,Y) is V.
`initial/3`	Initial values of the sudoku board. The value of cell (X,Y) is V.
`pos/2`	The cell (X,Y) is in the sudoku board.
`subgrid/3`
`val/1`	The value V is a possible value for a cell.

::: examples/sudoku/encoding.lp
    handler: asp
    options:
        predicate_table: true
        start_level: 3

Configuration options¶

The option predicate_table can be further customized with the following options:

include_undocumented Boolean indicating if predicates that have no docstring should be included. Defaults to True.
include_hidden Boolean indicating if predicates that are not shown nor input should be included. Defaults to True.

Example

Output Usage

Name	Definition	Type
`sudoku/3`	Describes a sudoku board. The value of cell (X,Y) is V.
`initial/3`	Initial values of the sudoku board. The value of cell (X,Y) is V.

::: examples/sudoku/encoding.lp
    handler: asp
    options:
        predicate_table:
            include_hidden: false
        start_level: 3