- Documentation
- Reference manual
- The SWI-Prolog library
- library(aggregate): Aggregation operators on backtrackable predicates
- library(ansi_term): Print decorated text to ANSI consoles
- library(apply): Apply predicates on a list
- library(assoc): Association lists
- library(broadcast): Broadcast and receive event notifications
- library(charsio): I/O on Lists of Character Codes
- library(check): Consistency checking
- library(clpb): CLP(B): Constraint Logic Programming over Boolean Variables
- library(clpfd): CLP(FD): Constraint Logic Programming over Finite Domains
- library(clpqr): Constraint Logic Programming over Rationals and Reals
- library(csv): Process CSV (Comma-Separated Values) data
- library(dcg/basics): Various general DCG utilities
- library(dcg/high_order): High order grammar operations
- library(debug): Print debug messages and test assertions
- library(dicts): Dict utilities
- library(error): Error generating support
- library(fastrw): Fast reading and writing of terms
- library(gensym): Generate unique symbols
- library(heaps): heaps/priority queues
- library(increval): Incremental dynamic predicate modification
- library(intercept): Intercept and signal interface
- library(iostream): Utilities to deal with streams
- library(listing): List programs and pretty print clauses
- library(lists): List Manipulation
- library(macros): Macro expansion
- library(main): Provide entry point for scripts
- library(nb_set): Non-backtrackable set
- library(www_browser): Open a URL in the users browser
- library(occurs): Finding and counting sub-terms
- library(option): Option list processing
- library(optparse): command line parsing
- library(ordsets): Ordered set manipulation
- library(pairs): Operations on key-value lists
- library(persistency): Provide persistent dynamic predicates
- library(pio): Pure I/O
- library(portray_text): Portray text
- library(predicate_options): Declare option-processing of predicates
- library(prolog_coverage): Coverage analysis tool
- library(prolog_debug): User level debugging tools
- library(prolog_jiti): Just In Time Indexing (JITI) utilities
- library(prolog_trace): Print access to predicates
- library(prolog_versions): Demand specific (Prolog) versions
- library(prolog_xref): Prolog cross-referencer data collection
- library(quasi_quotations): Define Quasi Quotation syntax
- library(random): Random numbers
- library(rbtrees): Red black trees
- library(readutil): Read utilities
- library(record): Access named fields in a term
- library(registry): Manipulating the Windows registry
- library(rwlocks): Read/write locks
- library(settings): Setting management
- library(statistics): Get information about resource usage
- library(strings): String utilities
- library(simplex): Solve linear programming problems
- library(solution_sequences): Modify solution sequences
- library(tables): XSB interface to tables
- library(terms): Term manipulation
- library(thread): High level thread primitives
- library(thread_pool): Resource bounded thread management
- library(ugraphs): Graph manipulation library
- library(url): Analysing and constructing URL
- library(varnumbers): Utilities for numbered terms
- library(yall): Lambda expressions

- The SWI-Prolog library
- Packages

- Reference manual

## A.1 library(aggregate): Aggregation operators on backtrackable predicates

- Compatibility
- Quintus, SICStus 4. The forall/2
is a SWI-Prolog built-in and
term_variables/3
is a SWI-Prolog built-in with
**different semantics**. - To be done
- - Analysing the aggregation template and compiling a predicate for the
list aggregation can be done at compile time.

- aggregate_all/3 can be rewritten to run in constant space using non-backtrackable assignment on a term.

This library provides aggregating operators over the solutions of a predicate. The operations are a generalisation of the bagof/3, setof/3 and findall/3 built-in predicates. Aggregations that can be computed incrementally avoid findall/3 and run in constant memory. The defined aggregation operations are counting, computing the sum, minimum, maximum, a bag of solutions and a set of solutions. We first give a simple example, computing the country with the smallest area:

smallest_country(Name, Area) :- aggregate(min(A, N), country(N, A), min(Area, Name)).

There are four aggregation predicates (aggregate/3, aggregate/4, aggregate_all/3 and aggregate/4), distinguished on two properties.

**aggregate vs. aggregate_all**- The aggregate predicates use setof/3
(aggregate/4) or bagof/3
(aggregate/3),
dealing with existential qualified variables (
`Var^Goal`

) and providing multiple solutions for the remaining free variables in`Goal`. The aggregate_all/3 predicate uses findall/3, implicitly qualifying all free variables and providing exactly one solution, while aggregate_all/4 uses sort/2 over solutions that Discriminator (see below) generated using findall/3. **The Discriminator argument**- The versions with 4 arguments deduplicate redundant solutions of Goal.
Solutions for which both the template variables and Discriminator are
identical will be treated as one solution. For example, if we wish to
compute the total population of all countries, and for some reason
`country(belgium, 11000000)`

may succeed twice, we can use the following to avoid counting the population of Belgium twice:aggregate(sum(P), Name, country(Name, P), Total)

All aggregation predicates support the following operators below in
Template. In addition, they allow for an arbitrary named compound term,
where each of the arguments is a term from the list below. For example,
the term `r(min(X), max(X))`

computes both the minimum and
maximum binding for X.

**count**- Count number of solutions. Same as
`sum(1)`

. **sum**(`Expr`)- Sum of
`Expr`for all solutions. **min**(`Expr`)- Minimum of
`Expr`for all solutions. **min**(`Expr, Witness`)- A term
`min(Min, Witness)`

, where Min is the minimal version of`Expr`over all solutions, and`Witness`is any other template applied to solutions that produced Min. If multiple solutions provide the same minimum,`Witness`corresponds to the first solution. **max**(`Expr`)- Maximum of
`Expr`for all solutions. **max**(`Expr, Witness`)- As
`min(Expr, Witness)`

, but producing the maximum result. **set**(`X`)- An ordered set with all solutions for
`X`. **bag**(`X`)- A list of all solutions for
`X`.

**Acknowledgements**

*The development of this library was sponsored by SecuritEase, http://www.securitease.com*

- [nondet]
**aggregate**(`+Template, :Goal, -Result`) - Aggregate bindings in
`Goal`according to`Template`. The aggregate/3 version performs bagof/3 on`Goal`. - [nondet]
**aggregate**(`+Template, +Discriminator, :Goal, -Result`) - Aggregate bindings in
`Goal`according to`Template`. The aggregate/4 version performs setof/3 on`Goal`. - [semidet]
**aggregate_all**(`+Template, :Goal, -Result`) - Aggregate bindings in
`Goal`according to`Template`. The aggregate_all/3 version performs findall/3 on`Goal`. Note that this predicate fails if`Template`contains one or more of`min(X)`

,`max(X)`

,`min(X,Witness)`

or`max(X,Witness)`

and`Goal`has no solutions, i.e., the minimum and maximum of an empty set is undefined.The

`Template`values`count`

,`sum(X)`

,`max(X)`

,`min(X)`

,`max(X,W)`

and`min(X,W)`

are processed incrementally rather than using findall/3 and run in constant memory. - [semidet]
**aggregate_all**(`+Template, +Discriminator, :Goal, -Result`) - Aggregate bindings in
`Goal`according to`Template`. The aggregate_all/4 version performs findall/3 followed by sort/2 on`Goal`. See aggregate_all/3 to understand why this predicate can fail. **foreach**(`:Generator, :Goal`)- True when the conjunction of
*instances*of`Goal`created from solutions for`Generator`is true. Except for term copying, this could be implemented as below.foreach(Generator, Goal) :- findall(Goal, Generator, Goals), maplist(call, Goals).

The actual implementation uses findall/3 on a template created from the variables

*shared*between`Generator`and`Goal`. Subsequently, it uses every instance of this template to instantiate`Goal`, call`Goal`and undo*only*the instantiation of the template and*not*other instantiations created by running`Goal`. Here is an example:?- foreach(between(1,4,X), dif(X,Y)), Y = 5. Y = 5. ?- foreach(between(1,4,X), dif(X,Y)), Y = 3. false.

The predicate foreach/2 is mostly used if

`Goal`performs backtrackable destructive assignment on terms. Attributed variables (underlying constraints) are an example. Another example of a backtrackable data structure is in`library(hashtable)`

. If we care only about the side effects (I/O, dynamic database, etc.) or the truth value of`Goal`, forall/2 is a faster and simpler alternative. If`Goal`instantiates its arguments it is will often fail as the argument cannot be instantiated to multiple values. It is possible to incrementally*grow*an argument:?- foreach(between(1,4,X), member(X, L)). L = [1,2,3,4|_].

Note that SWI-Prolog up to version 8.3.4 created copies of

`Goal`using copy_term/2 for each iteration, this makes the current implementation unable to properly handle compound terms (in`Goal`’s arguments) that share variables with the`Generator`. As a workaround you can define a goal that does not use compound terms, like in this example:mem(E,L) :- % mem/2 hides the compound argument from foreach/2 member(r(E),L). ?- foreach( between(1,5,N), mem(N,L)).

- [det]
**free_variables**(`:Generator, +Template, +VarList0, -VarList`) - Find free variables in bagof/setof template. In order to handle
variables properly, we have to find all the universally quantified
variables in the
`Generator`. All variables as yet unbound are universally quantified, unless`free_variables(Generator, Template, OldList, NewList)`

finds this set using OldList as an accumulator.- author
- - Richard O'Keefe

- Jan Wielemaker (made some SWI-Prolog enhancements) - license
- Public domain (from DEC10 library).
- To be done
- - Distinguish between control-structures and data terms.

- Exploit our built-in term_variables/2 at some places?

- [semidet,multifile]sandbox:
**safe_meta**(`+Goal, -Called`) - Declare the aggregate meta-calls safe. This cannot be proven due to the
manipulations of the argument
`Goal`.