Glossary

Generates a glossary with detailed information of all predicates using their predicate documentation. See the predicate documentation section for more details.

Each predicate generates a section in the TOC.

Each predicate section includes the references for each file where the predicate was used.

Example

Output Usage

---

Glossary

initial(X, Y, V)

Describes initial values of the sudoku board. The value of cell (X,Y) is V.

Parameter	Description
X	the row of the cell
Y	the column of the cell
V	the value of the cell

References

encoding.lp

sudoku(X,Y,V) :- initial(X,Y,V).

sudoku(X, Y, V)

Describes a sudoku board. The value of cell (X,Y) is V.

Parameter	Description
X	the row of the cell
Y	the column of the cell
V	the value of the cell

References

encoding.lp

1 { sudoku(X,Y,V) : val(V) } 1 :- pos(X,Y).

:- sudoku(X,Y,V), sudoku(X',Y,V), X != X'.

:- sudoku(X,Y,V), sudoku(X,Y',V), Y != Y'.

:- sudoku(X,Y,V), sudoku(X',Y',V), subgrid(X,Y,S), subgrid(X',Y',S), (X,Y)!=(X',Y').

sudoku(X,Y,V) :- initial(X,Y,V).

pos(X, Y)

Describes a cell (X,Y) in the sudoku board.

Parameter	Description
X	the row of the cell
Y	the column of the cell

References

encoding.lp

pos(X,Y) :- val(X), val(Y).

subgrid(X,Y,(((X-1)/dim)*dim+((Y-1)/dim))) :- pos(X,Y).

1 { sudoku(X,Y,V) : val(V) } 1 :- pos(X,Y).

subgrid(A, B, C)

References

encoding.lp

subgrid(X,Y,(((X-1)/dim)*dim+((Y-1)/dim))) :- pos(X,Y).

:- sudoku(X,Y,V), sudoku(X',Y',V), subgrid(X,Y,S), subgrid(X',Y',S), (X,Y)!=(X',Y').

val(V)

Describes a possible value V for a cell.

Parameter	Description
V	the value

References

encoding.lp

val(1..dim*dim).

pos(X,Y) :- val(X), val(Y).

1 { sudoku(X,Y,V) : val(V) } 1 :- pos(X,Y).

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

Configuration options

The option glossary 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.
• include_references Boolean indicating if each predicate documentations should include a section with the references. Defaults to True.
• include_navigation Boolean indicating if each predicate should generate a navigation entry displayed in the menu. Defaults to True.

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

Example

Output Usage

---

Glossary

initial(X, Y, V)

Describes initial values of the sudoku board. The value of cell (X,Y) is V.

Parameter	Description
X	the row of the cell
Y	the column of the cell
V	the value of the cell

sudoku(X, Y, V)

Describes a sudoku board. The value of cell (X,Y) is V.

Parameter	Description
X	the row of the cell
Y	the column of the cell
V	the value of the cell

pos(X, Y)

Describes a cell (X,Y) in the sudoku board.

Parameter	Description
X	the row of the cell
Y	the column of the cell

val(V)

Describes a possible value V for a cell.

Parameter	Description
V	the value

::: examples/sudoku/encoding.lp
    handler: asp
    options:
        glossary:
            include_references: false
        predicate_info:
            include_undocumented: false
        start_level: 3