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

Predicate Summary ¶

Name	Definition	Type
`initial/3`	Describes initial values of the sudoku board
`sudoku/3`	Describes a sudoku board
`pos/2`	Describes a cell (X,Y) in the sudoku board
`subgrid/3`
`val/1`	Describes a possible value V 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_title Boolean indicating if the section should be preceded by a header title which will be included in the table of contents. Defaults to True.

Predicate inclusion/exclusion (e.g. hidden or undocumented predicates) is configured globally via predicate_info.

Example

Output Usage

Predicate Summary ¶

Name	Definition	Type
`initial/3`	Describes initial values of the sudoku board
`sudoku/3`	Describes a sudoku board

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